CL_SoundProvider_Session - ClanLib Game SDK

Home | All Classes | Grouped Classes | Index | Search

# Class CL_SoundProvider_Session

Sound provider playback session. More...

Derived from: none
Derived by: none
Group: Sound (Audio Mixing)

#include <ClanLib/sound.h>

Construction:

CL_SoundProvider_Session |

Attributes:

get_num_samples | Returns the number of samples in the soundbuffer.
get_frequency | Returns the playback frequency of the input data.
get_position | Returns the current position in the playback stream.
get_format | Returns the playback sample format.
get_num_channels | Returns the number of channels filled when get_data is called.

Operations:

set_looping | Enable/disable session looping.
eof | Returns true if no more input data is available.
stop | Stops the current stream.
play | Start/continue playing of the stream.
set_position | Sets the position within the current stream.
get_data | Called when a playback session needs more sample data.

Detailed description:

!group=Sound/Audio Mixing! !header=sound.h!

Interface used by ClanLib during playback of sound providers.

Questions or comments, write to the ClanLib mailing list.