# playsound3
[](https://pypi.org/project/playsound3)
[](https://pypi.org/project/playsound3)
Cross platform library to play sound files in Python.
## Installation
Install via pip:
```
pip install playsound3
```
## Quick Start
Once installed, you can use the playsound function to play sound files:
```python
from playsound3 import playsound
playsound("/path/to/sound/file.mp3")
# or use directly on URLs
playsound("http://url/to/sound/file.mp3")
```
## Documentation
The `playsound3` module contains a single function named `playsound`:
```python
def playsound(sound, block=True, backend=None) -> None:
"""Play a sound file using an audio backend availabile in your system.
Args:
sound: Path or URL to the sound file. Can be a string or pathlib.Path.
block: If True, the function will block execution until the sound finishes playing.
If False, sound will play in a background thread.
backend: Name of the audio backend to use. Use None for automatic selection.
"""
...
```
It requires one argument: `sound` - the path to the file with the sound you'd like to play.
This should be a local file or a URL.
There's an optional second argument: `block` which is set to `True` by default.
Setting it to `False` makes the function run asynchronously.
You can manually specify a backend by passing its name as the third argument.
You can browse available backends by using `playsound3.AVAILABLE_BACKENDS`.
It is recommended to use the default value of `None` to let the library choose the best backend available.
## Supported systems
* **Linux** using one of the below backends, whichever is available:
* GStreamer
* FFmpeg
* aplay for .wav and mpg123 .mp3
* **Windows** using winmm.dll (built-in on Windows)
* **OS X** using afplay utility (built-in on OS X)
## Fork information
This repository was originally forked from [playsound](https://github.com/TaylorSMarks/playsound) library created by Taylor Marks. The original library is unfortunately not maintained anymore and doesn't accept pull requests. This library: `playsound3` is a major rewrite of the original, including its own set of tests hosted using GitHub Actions.
Compared to the original, `playsound3`:
* drops support for Python 2
* adheres to the latest PEP standards
* offers multiple backends with a fallback mechanism if the default backend is not available
* is accepting contributions
Raw data
{
"_id": null,
"home_page": null,
"name": "playsound3",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "Szymon Mikler <sjmikler@gmail.com>",
"keywords": "audio, media, mp3, music, play, playsound, song, sound, wav, wave",
"author": null,
"author_email": "Szymon Mikler <sjmikler@gmail.com>, Taylor Marks <taylor@marksfam.com>",
"download_url": "https://files.pythonhosted.org/packages/5d/76/5821d4223413c99648ab7ab90c6453b24c4cc994a9ea10b4dc2983d8ef17/playsound3-2.2.1.tar.gz",
"platform": null,
"description": "# playsound3\n\n[](https://pypi.org/project/playsound3)\n[](https://pypi.org/project/playsound3)\n\nCross platform library to play sound files in Python.\n\n## Installation\n\nInstall via pip:\n\n```\npip install playsound3\n```\n\n## Quick Start\n\nOnce installed, you can use the playsound function to play sound files:\n\n```python\nfrom playsound3 import playsound\n\nplaysound(\"/path/to/sound/file.mp3\")\n\n# or use directly on URLs\nplaysound(\"http://url/to/sound/file.mp3\")\n```\n\n## Documentation\n\nThe `playsound3` module contains a single function named `playsound`:\n\n```python\ndef playsound(sound, block=True, backend=None) -> None:\n \"\"\"Play a sound file using an audio backend availabile in your system.\n\n Args:\n sound: Path or URL to the sound file. Can be a string or pathlib.Path.\n block: If True, the function will block execution until the sound finishes playing.\n If False, sound will play in a background thread.\n backend: Name of the audio backend to use. Use None for automatic selection.\n \"\"\"\n ...\n```\n\nIt requires one argument: `sound` - the path to the file with the sound you'd like to play.\nThis should be a local file or a URL.\nThere's an optional second argument: `block` which is set to `True` by default.\nSetting it to `False` makes the function run asynchronously.\nYou can manually specify a backend by passing its name as the third argument.\nYou can browse available backends by using `playsound3.AVAILABLE_BACKENDS`.\nIt is recommended to use the default value of `None` to let the library choose the best backend available.\n\n## Supported systems\n\n* **Linux** using one of the below backends, whichever is available:\n * GStreamer\n * FFmpeg\n * aplay for .wav and mpg123 .mp3\n* **Windows** using winmm.dll (built-in on Windows)\n* **OS X** using afplay utility (built-in on OS X)\n\n## Fork information\n\nThis repository was originally forked from [playsound](https://github.com/TaylorSMarks/playsound) library created by Taylor Marks. The original library is unfortunately not maintained anymore and doesn't accept pull requests. This library: `playsound3` is a major rewrite of the original, including its own set of tests hosted using GitHub Actions. \n\nCompared to the original, `playsound3`:\n* drops support for Python 2\n* adheres to the latest PEP standards\n* offers multiple backends with a fallback mechanism if the default backend is not available\n* is accepting contributions\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Cross-platform library to play audio files",
"version": "2.2.1",
"project_urls": {
"Documentation": "https://github.com/sjmikler/playsound3?tab=readme-ov-file#documentation",
"Issues": "https://github.com/sjmikler/playsound3/issues",
"Repository": "https://github.com/sjmikler/playsound3"
},
"split_keywords": [
"audio",
" media",
" mp3",
" music",
" play",
" playsound",
" song",
" sound",
" wav",
" wave"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "57e694849922286857438771955c09d9404f84454f49d687a1b33fc14b84d1f7",
"md5": "726e1bd0bb2c34ff23856e5b2ceebcdb",
"sha256": "73430316e968220c38ca6f9af3f082ac4c4e10123baee11338d4e13bf5018d80"
},
"downloads": -1,
"filename": "playsound3-2.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "726e1bd0bb2c34ff23856e5b2ceebcdb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6579,
"upload_time": "2024-05-08T09:45:46",
"upload_time_iso_8601": "2024-05-08T09:45:46.491941Z",
"url": "https://files.pythonhosted.org/packages/57/e6/94849922286857438771955c09d9404f84454f49d687a1b33fc14b84d1f7/playsound3-2.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5d765821d4223413c99648ab7ab90c6453b24c4cc994a9ea10b4dc2983d8ef17",
"md5": "2237e0a8d26ec54b515078db52c58766",
"sha256": "9b725306fb746cdcfd4daacd9f71e83b81b9159188ac134f2fc6648d9038aef4"
},
"downloads": -1,
"filename": "playsound3-2.2.1.tar.gz",
"has_sig": false,
"md5_digest": "2237e0a8d26ec54b515078db52c58766",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 7303,
"upload_time": "2024-05-08T09:45:47",
"upload_time_iso_8601": "2024-05-08T09:45:47.925337Z",
"url": "https://files.pythonhosted.org/packages/5d/76/5821d4223413c99648ab7ab90c6453b24c4cc994a9ea10b4dc2983d8ef17/playsound3-2.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-08 09:45:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sjmikler",
"github_project": "playsound3?tab=readme-ov-file#documentation",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "playsound3"
}
JSON
