diff --git a/doc/python_api/examples/aud.py b/doc/python_api/examples/aud.py new file mode 100644 index 00000000000..a7f0bf9fbab --- /dev/null +++ b/doc/python_api/examples/aud.py @@ -0,0 +1,21 @@ +""" +Basic Sound Playback +++++++++++++++++++++++ +This script shows how to use the classes: :class:`Device`, :class:`Factory` and +:class:`Handle`. +""" +import aud + +device = aud.device() +# load sound file (it can be a video file with audio) +factory = aud.Factory('music.ogg') + +# play the audio, this return a handle to control play/pause +handle = device.play(sound) +# if the audio is not too big and will be used often you can buffer it +factory_buffered = aud.Factory.buffer(sound) +handle_buffered = device.play(buffered) + +# stop the sounds (otherwise they play until their ends) +handle.stop() +handle_buffered.stop()