![]() | |
![]() | ![]() |
Entire Class Index | Main Class Index | Cross Index | Global Index |
CL_SoundBuffer_Session provides control over a playing soundeffect.
Contained in: global
Derived from:
none
Derived by:
none
Group: Sound (Audio Mixing)
#include <ClanLib/sound.h>
public function member index: |
||
Construction: |
||
CL_SoundBuffer_Session | (); | |
CL_SoundBuffer_Session | (void* handle, CL_SoundCard* _card); | |
CL_SoundBuffer_Session | (const CL_SoundBuffer_Session& copy); | |
~CL_SoundBuffer_Session | (); | |
Operators: |
||
CL_SoundBuffer_Session& | operator = | (const CL_SoundBuffer_Session& session); |
Attributes: |
||
void* | get_handle | () const; |
CL_SoundCard* | get_card | () const; |
int | get_position | () const; |
float | get_position_relative | () const; |
bool | set_position | (int new_pos); |
bool | set_position_relative | (float new_pos); |
int | get_length | () const; |
int | get_frequency | () const; |
bool | set_frequency | (int new_freq); |
float | get_volume | () const; |
float | get_pan | () const; |
Operations: |
||
bool | set_volume | (float new_volume); |
bool | set_pan | (float new_pan); |
void | play | (); |
void | stop | (); |
bool | is_playing | (); |
void | set_looping | (bool loop); |
void | add_filter | (class CL_SoundFilter* filter, bool delete_filter = false); |
void | remove_filter | (class CL_SoundFilter* filter); |
filter - Sound filter to pass sound through.
delete_filter - If true, the filter will be deleted when the session is destroyed.
Returns - Pointer to soundcard
Returns - Frequency of soundeffect played.
Returns - Length of the soundeffect.
Returns - Current pan of the soundeffect played.
Returns - Current position of soundeffect.
Returns - Relative position of the soundeffect.
Returns - Volume of soundeffect played.
New frequency of soundeffect.
Returns - Returns true, if the operation completed succesfully.
loop - true if session should loop, false otherwise
new_pan - New pan of the soundeffect played.
Returns - Returns true if the operation completed sucecsfully.
The new position of the soundeffect.
Returns - Returns true if operation completed succesfully.
New relative position
Returns - Returns true if operation completed succesfully.
new_volume - New volume of soundeffect
Returns - Returns true if the operation completed succesfully.