Sound provider playback session. More...
#include <soundprovider_session.h>
Public Member Functions | |
Construction | |
CL_SoundProvider_Session () | |
virtual | ~CL_SoundProvider_Session () |
Attributes | |
virtual int | get_num_samples () const =0 |
Returns the number of samples in the soundbuffer. | |
virtual int | get_frequency () const =0 |
Returns the playback frequency of the input data. | |
virtual int | get_position () const =0 |
Returns the current position in the playback stream. | |
virtual int | get_num_channels () const =0 |
Returns the number of channels filled when get_data is called. | |
Operations | |
virtual bool | set_looping (bool loop) |
Enable/disable session looping. | |
virtual bool | eof () const =0 |
Returns true if no more input data is available. | |
virtual void | stop ()=0 |
Stops the current stream. | |
virtual bool | play ()=0 |
Start/continue playing of the stream. | |
virtual bool | set_position (int pos)=0 |
Sets the position within the current stream. | |
virtual bool | set_end_position (int pos)=0 |
Sets the end position within the current stream. | |
virtual int | get_data (float **data_ptr, int data_requested)=0 |
Called when a playback session needs more sample data. |
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.
virtual int CL_SoundProvider_Session::get_data | ( | float ** | data_ptr, | |
int | data_requested | |||
) | [pure virtual] |
Called when a playback session needs more sample data.
data_ptr | = Points to a buffer that should be filled with sample data. | |
data_requested | = Samples of data requested. |
virtual int CL_SoundProvider_Session::get_frequency | ( | ) | const [pure virtual] |
Returns the playback frequency of the input data.
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.
virtual bool CL_SoundProvider_Session::set_end_position | ( | int | pos | ) | [pure virtual] |
Sets the end position within the current stream.
pos | = End position. |
virtual bool CL_SoundProvider_Session::set_looping | ( | bool | loop | ) | [inline, virtual] |
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.
pos | Position to seek to. |
virtual void CL_SoundProvider_Session::stop | ( | ) | [pure virtual] |
Stops the current stream.