Added documentation for the sound streaming feature.

This commit is contained in:
Lasse Öörni 2014-03-19 12:28:11 +02:00
parent a06e4238b3
commit e8c550a98f
2 changed files with 7 additions and 1 deletions

View File

@ -1400,6 +1400,12 @@ The frequency is in Hz, and loop start and end are bytes from the start of audio
The Audio subsystem is always instantiated, but in headless mode it is not active. In headless mode the playback of sounds is simulated, taking the sound length and frequency into account. This allows basing logic on whether a specific sound is still playing or not, even in server code.
\section Audio_Stream Sound streaming
In addition to playing existing sound resources, sound can be generated during runtime using the SoundStream class and its subclasses. To start playback of a stream on a SoundSource, call \ref SoundSource::Play(SoundStream* stream) "Play(SoundStream* stream)".
%Sound streaming is used internally to implement on-the-fly Ogg Vorbis decoding. It is only available in C++ code and not scripting due to its low-level nature. See the SoundSynthesis C++ sample for an example of using the BufferedSoundStream subclass, which allows the sound data to be queued for playback from the main thread.
\page Physics Physics

View File

@ -34,7 +34,7 @@ class BufferedSoundStream;
/// Sound synthesis example.
/// This sample demonstrates:
/// - Playing back a sound stream produced in realtime in code
/// - Playing back a sound stream produced on-the-fly by a simple CPU synthesis algorithm
class SoundSynthesis : public Sample
{
OBJECT(SoundSynthesis);