---

CL_SoundBuffer_Session Class Reference

#include <soundbuffer_session.h>

Collaboration diagram for CL_SoundBuffer_Session:

[legend]List of all members.

Public Methods
	CL_SoundBuffer_Session ()
	CL_SoundBuffer_Session (void *handle, CL_SoundCard *_card)
	CL_SoundBuffer_Session (const CL_SoundBuffer_Session &copy)
	~CL_SoundBuffer_Session ()
CL_SoundBuffer_Session&	operator= (const CL_SoundBuffer_Session &session)
void*	get_handle () const
CL_SoundCard*	get_card () const
int	get_position () const
	retval: Pointer to soundcard.
float	get_position_relative () const
	retval: Current position of soundeffect.
bool	set_position (int new_pos)
	retval: Relative position of the soundeffect.
bool	set_position_relative (float new_pos)
	param: The new position of the soundeffect.retval: Returns true if operation completed succesfully.
int	get_length () const
	param: New relative positionretval: Returns true if operation completed succesfully.
int	get_frequency () const
	retval: Length of the soundeffect.
bool	set_frequency (int new_freq)
	retval: Frequency of soundeffect played.
float	get_volume () const
	param: New frequency of soundeffect.retval: Returns true, if the operation completed succesfully.
bool	set_volume (float new_volume)
	retval: Volume of soundeffect played.
float	get_pan () const
	param: new_volume - New volume of soundeffect retval: Returns true if the operation completed succesfully.
bool	set_pan (float new_pan)
	retval: Current pan of the soundeffect played.
void	play ()
	param: new_pan - New pan of the soundeffect played.retval: Returns true if the operation completed sucecsfully.
void	stop ()
bool	is_playing ()
void	set_looping (bool loop)
void	add_filter (class CL_SoundFilter *filter, bool delete_filter=false)
	param: loop - true if session should loop, false otherwise.
void	remove_filter (class CL_SoundFilter *filter)
	param: filter - Sound filter to pass sound through.param: delete_filter - If true, the filter will be deleted when the session is destroyed.
Private Attributes
void*	handle
CL_SoundCard*	card

---

Constructor & Destructor Documentation

CL_SoundBuffer_Session::CL_SoundBuffer_Session ( ) [inline]

Definition at line 36 of file soundbuffer_session.h.

CL_SoundBuffer_Session::CL_SoundBuffer_Session ( void * handle, CL_SoundCard * _card )

CL_SoundBuffer_Session::CL_SoundBuffer_Session ( const CL_SoundBuffer_Session & copy )

CL_SoundBuffer_Session::~CL_SoundBuffer_Session ( )

---

Member Function Documentation

void CL_SoundBuffer_Session::add_filter ( class CL_SoundFilter * filter, bool delete_filter = false )

param: loop - true if session should loop, false otherwise.

CL_SoundCard * CL_SoundBuffer_Session::get_card ( ) const [inline]

Definition at line 50 of file soundbuffer_session.h.

int CL_SoundBuffer_Session::get_frequency ( ) const

retval: Length of the soundeffect.

void * CL_SoundBuffer_Session::get_handle ( ) const [inline]

Definition at line 48 of file soundbuffer_session.h.

int CL_SoundBuffer_Session::get_length ( ) const

param: New relative positionretval: Returns true if operation completed succesfully.

float CL_SoundBuffer_Session::get_pan ( ) const

param: new_volume - New volume of soundeffect retval: Returns true if the operation completed succesfully.

int CL_SoundBuffer_Session::get_position ( ) const

retval: Pointer to soundcard.

float CL_SoundBuffer_Session::get_position_relative ( ) const

retval: Current position of soundeffect.

float CL_SoundBuffer_Session::get_volume ( ) const

param: New frequency of soundeffect.retval: Returns true, if the operation completed succesfully.

bool CL_SoundBuffer_Session::is_playing ( )

CL_SoundBuffer_Session& CL_SoundBuffer_Session::operator= ( const CL_SoundBuffer_Session & session )

void CL_SoundBuffer_Session::play ( )

param: new_pan - New pan of the soundeffect played.retval: Returns true if the operation completed sucecsfully.

void CL_SoundBuffer_Session::remove_filter ( class CL_SoundFilter * filter )

param: filter - Sound filter to pass sound through.param: delete_filter - If true, the filter will be deleted when the session is destroyed.

bool CL_SoundBuffer_Session::set_frequency ( int new_freq )

retval: Frequency of soundeffect played.

void CL_SoundBuffer_Session::set_looping ( bool loop )

bool CL_SoundBuffer_Session::set_pan ( float new_pan )

retval: Current pan of the soundeffect played.

bool CL_SoundBuffer_Session::set_position ( int new_pos )

retval: Relative position of the soundeffect.

bool CL_SoundBuffer_Session::set_position_relative ( float new_pos )

param: The new position of the soundeffect.retval: Returns true if operation completed succesfully.

bool CL_SoundBuffer_Session::set_volume ( float new_volume )

retval: Volume of soundeffect played.

void CL_SoundBuffer_Session::stop ( )

---

Member Data Documentation

CL_SoundCard* CL_SoundBuffer_Session::card [private]

Definition at line 145 of file soundbuffer_session.h.

void* CL_SoundBuffer_Session::handle [private]

Definition at line 144 of file soundbuffer_session.h.

---

The documentation for this class was generated from the following file:

• soundbuffer_session.h

---