blender-archive/doc/python_api/examples/aud.py

"""
Basic Sound Playback
++++++++++++++++++++

This script shows how to use the classes: :class:`Device`, :class:`Sound` and
:class:`Handle`.
"""
import aud

device = aud.Device()
# load sound file (it can be a video file with audio)
sound = aud.Sound('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
sound_buffered = aud.Sound.cache(sound)
handle_buffered = device.play(sound_buffered)

# stop the sounds (otherwise they play until their ends)
handle.stop()
handle_buffered.stop()
basic sound playback example for audspace module (I'm on windows at the moment so I can't test it. Hopefully it should be fine) 2011-06-27 05:12:03 +00:00			`"""`
			`Basic Sound Playback`
remove some unused flags and correct aud example heading 2011-06-27 07:44:59 +00:00			`++++++++++++++++++++`
Cleanup: API docs 2015-09-08 14:30:05 +10:00
PyAPI Docs: Update aud example Fixes T74641 2020-03-19 16:20:26 -04:00			This script shows how to use the classes: :class:`Device`, :class:`Sound` and
basic sound playback example for audspace module (I'm on windows at the moment so I can't test it. Hopefully it should be fine) 2011-06-27 05:12:03 +00:00			:class:`Handle`.
			`"""`
			`import aud`

PyAPI Docs: Update aud example Fixes T74641 2020-03-19 16:20:26 -04:00			`device = aud.Device()`
basic sound playback example for audspace module (I'm on windows at the moment so I can't test it. Hopefully it should be fine) 2011-06-27 05:12:03 +00:00			`# load sound file (it can be a video file with audio)`
PyAPI Docs: Update aud example Fixes T74641 2020-03-19 16:20:26 -04:00			`sound = aud.Sound('music.ogg')`
basic sound playback example for audspace module (I'm on windows at the moment so I can't test it. Hopefully it should be fine) 2011-06-27 05:12:03 +00:00
			`# play the audio, this return a handle to control play/pause`
PyAPI Docs: Update aud example Fixes T74641 2020-03-19 16:20:26 -04:00			`handle = device.play(sound)`
basic sound playback example for audspace module (I'm on windows at the moment so I can't test it. Hopefully it should be fine) 2011-06-27 05:12:03 +00:00			`# if the audio is not too big and will be used often you can buffer it`
Py API Docs: Fix audio docs example After new AUD API changes from 2.8x what "buffer" function used to do has now become "cache" function (it caches a sound into RAM). Therefore, the basic aud example should call this new "cache" function instead of "buffer" function. Thanks to Michael-Z-Freeman for pointing out. 2021-09-18 19:28:55 +02:00			`sound_buffered = aud.Sound.cache(sound)`
PyAPI Docs: Update aud example Fixes T74641 2020-03-19 16:20:26 -04:00			`handle_buffered = device.play(sound_buffered)`
basic sound playback example for audspace module (I'm on windows at the moment so I can't test it. Hopefully it should be fine) 2011-06-27 05:12:03 +00:00
			`# stop the sounds (otherwise they play until their ends)`
			`handle.stop()`
			`handle_buffered.stop()`