SoundStream Class

Default constructor

Handle the destruction of the object

Explicitely dispose the object

Determines whether the specified Object is equal to the current Object.

Dispose the object

Serves as a hash function for a particular type.

Gets the Type of the current instance.

Set the audio stream parameters, you must call it before Play()

Creates a shallow copy of the current Object.

Virtual function called each time new audio data is needed to feed the stream

Virtual function called to seek into the stream

Pause the audio stream. This function pauses the stream if it was playing, otherwise (stream already paused or stopped) it has no effect.

Start or resume playing the audio stream. This function starts the stream if it was stopped, resumes it if it was paused, and restarts it from beginning if it was it already playing. This function uses its own thread so that it doesn't block the rest of the program while the stream is played.

Stop playing the audio stream. This function stops the stream if it was playing or paused, and does nothing if it was already stopped. It also resets the playing position (unlike pause()).

Provide a string describing the object

Attenuation factor of the stream. The attenuation is a multiplicative factor which makes the music more or less loud according to its distance from the listener. An attenuation of 0 will produce a non-attenuated sound, i.e. its volume will always be the same whether it is heard from near or from far. On the other hand, an attenuation value such as 100 will make the sound fade out very quickly as it gets further from the listener. The default value of the attenuation is 1.

Number of channels (1 = mono, 2 = stereo)

Access to the internal pointer of the object. For internal use only

Flag if the music should loop after reaching the end. If set, the music will restart from beginning after reaching the end and so on, until it is stopped or Loop = false is set. The default looping state for music is false.

Minimum distance of the music. The "minimum distance" of a sound is the maximum distance at which it is heard at its maximum volume. Further than the minimum distance, it will start to fade out according to its attenuation factor. A value of 0 ("inside the head of the listener") is an invalid value and is forbidden. The default value of the minimum distance is 1.

Pitch of the stream. The pitch represents the perceived fundamental frequency of a sound; thus you can make a sound more acute or grave by changing its pitch. A side effect of changing the pitch is to modify the playing speed of the sound as well. The default value for the pitch is 1.

Current playing position of the stream. The playing position can be changed when the music is either paused or playing.

3D position of the stream in the audio scene. Only sounds with one channel (mono sounds) can be spatialized. The default position of a sound is (0, 0, 0).

Make the stream's position relative to the listener or absolute. Making a sound relative to the listener will ensure that it will always be played the same way regardless the position of the listener. This can be useful for non-spatialized sounds, sounds that are produced by the listener, or sounds attached to it. The default value is false (position is absolute).

Sample rate of the stream The sample rate is the number of audio samples played per second. The higher, the better the quality.

Current status of the sound stream (see SoundStatus enum)

Volume of the stream. The volume is a value between 0 (mute) and 100 (full volume). The default value for the volume is 100.