CL_StreamSoundProvider_Session3
Streamed soundprovider playback session
Overview
Interface used by ClanLib during playback of streamed soundbuffers.
Class members
- virtual
~CL_StreamSoundProvider_Session()
- virtual bool
eof()
- virtual void
stop()
- virtual bool
play()
- virtual bool
set_position( -
int pos)
- virtual int
get_data( -
void *data_ptr, int data_requested)
- virtual int
get_frequency()
- virtual SoundFormat
get_format()
Members with descriptions
- virtual
~CL_StreamSoundProvider_Session() -
Description:
- virtual bool
eof() -
Description:
Returns true if no more input data is available.
Return value:
True if end of input data. False otherwise.
- virtual void
stop() -
Description:
Stops the current stream.
- virtual bool
play() -
Description:
Start/continue playing of the stream.
Return value:
True for success. False otherwise.
- virtual bool
set_position( -
int pos)
Parameters: pos - Position to seek to.
Description:
Sets the position within the current stream.
Return value:
True for success. False otherwise.
- virtual int
get_data( -
void *data_ptr, int data_requested)
Parameters: data_ptr - Points to a buffer that should be filled with sample data. data_requested - Bytes of data requested.
Description:
Called when a playback session needs more sample data.
Return value:
Number of bytes actually filled with sample data.
- virtual int
get_frequency() -
Description:
Returns the playback frequency of the input data.
Return value:
Playback frequency.
- virtual SoundFormat
get_format() -
Description:
Returns the playback sample format.
Return value:
The playback Sample format.