playsound

https://pypi.org/project/playsound/
Admin
playsound is a pure Python, cross-platform module with no dependencies for playing sounds in various...
Tokens:1,015
Snippets:15
Trust Score:10
Update:6 months ago
Show doc for...
Tokens:
Raw
### Installation

Source: https://pypi.org/project/playsound/1.3.0

Instructions on how to install the playsound module using pip.

```APIDOC
## Installation

### Description
Install the playsound module using pip for easy integration into your Python projects.

### Method
pip install

### Endpoint
N/A

### Parameters
N/A

### Request Example
```bash
pip install playsound
```

### Response
N/A
```

--------------------------------

### Install playsound via pip

Source: https://pypi.org/project/playsound

Use this command to install the playsound package in your environment.

```bash
$ pip install playsound
```

--------------------------------

### Quick Start: Play a Sound File

Source: https://pypi.org/project/playsound/1.3.0

Import the playsound function and call it with the path to your sound file to play audio. This is the most basic usage.

```python
from playsound import playsound
playsound('/path/to/a/sound/file/you/want/to/play.mp3')
```

--------------------------------

### Install playsound via pip

Source: https://pypi.org/project/playsound/1.3.0

Use this command to install the playsound library. It's recommended to specify the version for consistent behavior.

```bash
pip install playsound==1.3.0
```

--------------------------------

### Play a sound file

Source: https://pypi.org/project/playsound

Import the playsound function and provide the path to an audio file to play it.

```python
>>> from playsound import playsound
>>> playsound('/path/to/a/sound/file/you/want/to/play.mp3')
```

--------------------------------

### Playsound Functionality

Source: https://pypi.org/project/playsound/1.3.0

The playsound module's core function, playsound, takes the path to a sound file as its primary argument. An optional 'block' argument controls whether playback is synchronous (True, default) or asynchronous (False).

```python
playsound('/path/to/sound.wav', block=False)
```

--------------------------------

### Playsound Module - Single Function API

Source: https://pypi.org/project/playsound/1.3.0

The playsound module provides a single function, `playsound`, for playing audio files. It supports local files and URLs, with an option to control blocking behavior.

```APIDOC
## playsound Function API

### Description
Plays a sound file from a given path or URL. Supports blocking and non-blocking playback.

### Method
N/A (Python function)

### Endpoint
N/A (Python function)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Function Signature
`playsound(sound: str, block: bool = True)`

### Parameters
- **sound** (str) - Required - The path to the sound file (local or URL).
- **block** (bool) - Optional - If True (default), the function blocks until the sound finishes playing. If False, it plays asynchronously.

### Request Example
```python
from playsound import playsound

# Play a sound file and wait for it to finish
playsound('/path/to/your/sound.mp3')

# Play a sound file asynchronously
playsound('/path/to/your/sound.wav', block=False)
```

### Response
#### Success Response (None)
This function does not return a value upon successful execution. Errors are raised as exceptions.

#### Response Example
N/A
```
Tokens:
Raw