CL_SoundBuffer_Session provides control over a playing soundeffect. More...
Derived from: | None |
Derived by: | None |
Group: | Audio Mixing (Sound) |
#include <ClanLib/sound.h>
Class Members:
Construction: | |
Creates a null instance. |
| |
Returns true if this object is invalid. | |
Throw an exception if this object is invalid. | |
Returns the current sample position of the playback. | |
Returns the sample position relative to the full length. | |
Returns the total length (in samples) of the sound buffer played. | |
Returns the frequency of the session. | |
Returns the linear relative volume of the soundeffect. | |
Returns the current pan (in a measure from -1 -> 1). | |
Returns whether this session loops. | |
Returns true if the session is playing. |
| |
Sets the session position to 'new_pos'. | |
Sets the relative position of the session. | |
Sets the end position within the current stream. | |
Sets the frequency of the session. | |
Sets the volume of the session in a relative measure (0->1) | |
Sets the panning of the session played in measures from -1 -> 1. | |
Starts playback of the session. | |
Stops playback of the session. | |
Determines whether this session should loop. | |
Adds the sound filter to the session. See CL_SoundFilter for details. | |
Remove the sound filter from the session. See CL_SoundFilter for details. |
Detailed description:
Whenever a soundbuffer is played, it returns a CL_SoundBuffer_Session class, which can be used to control the sound (its volume, pitch, pan, position). It can also be used to retrigger the sound or to stop it.