Sound provider playback session.
More...
#include <soundprovider_session.h>
Sound provider playback session.
Interface used by ClanLib during playback of sound providers.
CL_SoundProvider_Session::CL_SoundProvider_Session |
( |
) | |
|
virtual CL_SoundProvider_Session::~CL_SoundProvider_Session |
( |
) | |
|
|
virtual |
virtual bool CL_SoundProvider_Session::eof |
( |
) | |
const |
|
pure virtual |
Returns true if no more input data is available.
- Returns
- True if end of input data. False otherwise.
virtual int CL_SoundProvider_Session::get_data |
( |
float ** |
data_ptr, |
|
|
int |
data_requested |
|
) |
| |
|
pure virtual |
Called when a playback session needs more sample data.
- Parameters
-
data_ptr | = Points to a buffer that should be filled with sample data. |
data_requested | = Samples of data requested. |
- Returns
- Number of samples actually filled with sample data.
virtual int CL_SoundProvider_Session::get_frequency |
( |
) | |
const |
|
pure virtual |
Returns the playback frequency of the input data.
- Returns
- Playback frequency.
virtual int CL_SoundProvider_Session::get_num_channels |
( |
) | |
const |
|
pure virtual |
Returns the number of channels filled when get_data is called.
virtual int CL_SoundProvider_Session::get_num_samples |
( |
) | |
const |
|
pure virtual |
Returns the number of samples in the soundbuffer.
virtual int CL_SoundProvider_Session::get_position |
( |
) | |
const |
|
pure virtual |
Returns the current position in the playback stream.
virtual bool CL_SoundProvider_Session::play |
( |
) | |
|
|
pure virtual |
Start/continue playing of the stream.
- Returns
- True for success. False otherwise.
virtual bool CL_SoundProvider_Session::set_end_position |
( |
int |
pos) | |
|
|
pure virtual |
Sets the end position within the current stream.
- Parameters
-
- Returns
- True for success. False otherwise.
virtual bool CL_SoundProvider_Session::set_looping |
( |
bool |
loop) | |
|
|
inlinevirtual |
Enable/disable session looping.
If this function returns false (default), the clanSound mixer will manually try to simulate looping by setting the position to 0 when eof is encountered.
virtual bool CL_SoundProvider_Session::set_position |
( |
int |
pos) | |
|
|
pure virtual |
Sets the position within the current stream.
- Parameters
-
- Returns
- True for success. False otherwise.
virtual void CL_SoundProvider_Session::stop |
( |
) | |
|
|
pure virtual |
Stops the current stream.
The documentation for this class was generated from the following file: