svn merge -r37793:37865 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[blender.git] / doc / python_api / examples / aud.py
1 """
2 Basic Sound Playback
3 ++++++++++++++++++++
4 This script shows how to use the classes: :class:`Device`, :class:`Factory` and
5 :class:`Handle`.
6 """
7 import aud
8
9 device = aud.device()
10 # load sound file (it can be a video file with audio)
11 factory = aud.Factory('music.ogg')
12
13 # play the audio, this return a handle to control play/pause
14 handle = device.play(sound)
15 # if the audio is not too big and will be used often you can buffer it
16 factory_buffered = aud.Factory.buffer(sound)
17 handle_buffered = device.play(buffered)
18
19 # stop the sounds (otherwise they play until their ends)
20 handle.stop()
21 handle_buffered.stop()