audioplayer is a cross platform Python 3 module for playing sounds (mp3, wav, ...)
audioplayer is a cross platform Python 3 package for playing sounds (mp3, wav, ...). It provides the key features of an audio player, such as opening a media file, playing (loop/block), pausing, resuming, stopping, and setting the playback volume.
I created this package to provide sound functionality to my game library game2dboard, but I decided to publish it separately.
Suported systems (see full list):
- GNU/Linux (PC, Raspberry Pi, ...)
Inspired by (and with a few lines of codes from) the playsound module.
In Linux, you need to install PyGObject and others dependencies.
Ubuntu/Debian/Raspberry Pi OS:
sudo apt-get install python-gst-1.0 \ gir1.2-gstreamer-1.0 \ gstreamer1.0-tools \ gir1.2-gst-plugins-base-1.0 gstreamer1.0-plugins-good \ gstreamer1.0-plugins-ugly
sudo yum install -y python-gstreamer1 \ gstreamer1-plugins-good \ gstreamer1-plugins-ugly
In macOS, you need to install PyObjC bridge.
pip3 install PyObjC --user
The recommended way to install
audioplayer is using the Python pip (or pip3) installer.
pip3 install audioplayer
If you don't have administrator privileges, install in your home folder.
pip3 install audioplayer --user
You can install the latest release by cloning this repository.
git clone https://github.com/mjbrusso/audioplayer.git cd audioplayer python3 setup.py install --user
The API is documented bellow and within the docstrings.
After install, you can use this code to test (replace "path/to/somemusic.mp3"):
from audioplayer import AudioPlayer # Playback stops when the object is destroyed (GC'ed), so save a reference to the object for non-blocking playback. AudioPlayer("path/to/somemusic.mp3").play(block=True)
Creates the player.
filename: str – The file name with extension (.mp3, .wav, ...)
FileNotFoundError(): The file does not exist.
filename: str (readonly)
The file name as provided in the constructor.
fullfilename: str (readonly)
The file name with full path.
Gets or sets the current volume (in %) of the audio (0 — 100)
Starts audio playback.
loop(bool) – Sets whether to repeat the track automatically when finished.
block(bool) – If true, blocks the thread until playback ends.
AudioPlayerError(): Failed to play.
Pauses audio playback.
Resumes audio playback.
Stops audio playback. Can play again.
Closes device, releasing resources. Can't play again.
audioPlayer has been tested on the following platforms:
|GNU/Linux||Mint 19 (Cinnamon)||✓||✓||✓||✕|
|GNU/Linux||Raspberry Pi OS||✓||✓||✓||✓|
|Windows||Windows 10 x64||✓||✓||✕||✓|
|macOS||Catalina (Python 3.8)||✓||✓||✕||✕|
?: Not yet tested
Let me know if you are using on another system/distro/version!
What's in the roadmap?
.seek(position): Moves playback to the specified position.
.state: Current state (playing, stopped, paused, ...)
.speed = value: Gets/sets playback speed.
- Callbacks: when state changed, when position changed by a delta, ...
How to Contribute
Submitting an issue
Use the issue tracker to submit bug reports and features or enhancements requests.
You can contribute by translating this document into other languages (except en and pt_br).
Submitting a pull request
If you can improve anything in this project, feel free to add a pull request.
audioplayer is under MIT license. It can be reused within proprietary software provided that all copies of the licensed software include a copy of the MIT License terms and the copyright notice.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size audioplayer-0.6-py3-none-any.whl (8.3 kB)||File type Wheel||Python version py3||Upload date||Hashes View|
|Filename, size audioplayer-0.6.tar.gz (6.5 kB)||File type Source||Python version None||Upload date||Hashes View|
Hashes for audioplayer-0.6-py3-none-any.whl