script_background_music.vendor.playsound

package documentation

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

From __init__.py:

Exception	`PlaysoundException`	Undocumented
Function	`get_play_sound`	Undocumented
Variable	`logger`	Undocumented
Function	`__canonicalize_path`	Support passing in a pathlib.Path-like object by converting to str.
Function	`__playsound_nix`	Play a sound using GStreamer.
Function	`__playsound_osx`	Undocumented
Function	`__playsound_win`	Utilizes windll.winmm. Tested and known to work with MP3 and WAVE on Windows 7 with Python 2.7. Probably works with more file formats. Probably works on Windows XP thru Windows 10. Probably works with all versions of Python.

def get_play_sound(): ¶

Undocumented

logger = ¶

Undocumented

def __canonicalize_path(path): ¶

Support passing in a pathlib.Path-like object by converting to str.

def __playsound_nix(sound, block=True): ¶

Play a sound using GStreamer.

Inspired by this: https://gstreamer.freedesktop.org/documentation/tutorials/playback/playbin-usage.html

def __playsound_osx(sound, block=True): ¶

Undocumented

def __playsound_win(sound, block=True): ¶

Utilizes windll.winmm. Tested and known to work with MP3 and WAVE on Windows 7 with Python 2.7. Probably works with more file formats. Probably works on Windows XP thru Windows 10. Probably works with all versions of Python.

Inspired by (but not copied from) Michael Gundlach <gundlach@gmail.com>'s mp3play: https://github.com/michaelgundlach/mp3play

I never would have tried using windll.winmm without seeing his code.