CL_SoundOutput Class Reference
[clanSound Audio Mixing]

SoundOutput interface in ClanLib. More...

#include <soundoutput.h>

List of all members.

Implementation
class	CL_SoundBuffer
class	CL_Sound
class	CL_SoundBuffer_Session
Public Member Functions
Construction
	CL_SoundOutput ()
	Constructs a sound output object.
	CL_SoundOutput (int mixing_frequency, int latency=50)
	Constructs a SoundOutput.
	CL_SoundOutput (const CL_SoundOutput_Description &desc)
	Constructs a SoundOutput.
	CL_SoundOutput (const CL_SoundOutput &copy)
	Constructs a SoundOutput.
virtual	~CL_SoundOutput ()
Attributes
const CL_String8 &	get_name () const
	Name of the output device.
int	get_mixing_frequency () const
	Returns the mixing frequency for the sound output device.
int	get_mixing_latency () const
	Returns the mixing latency in milliseconds.
float	get_global_volume () const
	Returns the main volume of the sound output.
float	get_global_pan () const
	Returns the main panning position of the sound output.
Operations
void	stop_all ()
	Stops all sample playbacks on the sound output.
void	set_global_volume (float volume)
	Sets the main/mixer volume on the sound output.
void	set_global_pan (float pan)
	Sets the main panning position on the sound output.
void	add_filter (CL_SoundFilter &filter)
	Adds the sound filter to the sound output.
void	remove_filter (CL_SoundFilter &filter)
	Remove the sound filter from the session.

---

Detailed Description

SoundOutput interface in ClanLib.

CL_SoundOutput is the interface to a sound output device. It is used to control the main mixer volume and other global settings.

---

Constructor & Destructor Documentation

CL_SoundOutput::CL_SoundOutput (   )

Constructs a sound output object.

CL_SoundOutput::CL_SoundOutput (  int  mixing_frequency, int  latency = 50 )

Constructs a SoundOutput. Parameters: mixing_frequency  = value latency  = value

CL_SoundOutput::CL_SoundOutput (  const CL_SoundOutput_Description &  desc  )

Constructs a SoundOutput. Parameters: desc  = Sound Output_ Description

CL_SoundOutput::CL_SoundOutput (  const CL_SoundOutput &  copy  )

Constructs a SoundOutput. Parameters: copy  = Sound Output

virtual CL_SoundOutput::~CL_SoundOutput (   )  [virtual]

---

Member Function Documentation

void CL_SoundOutput::add_filter (  CL_SoundFilter &  filter  )

Adds the sound filter to the sound output. Parameters: filter  Sound filter to pass sound through.

float CL_SoundOutput::get_global_pan (   )  const

Returns the main panning position of the sound output.

float CL_SoundOutput::get_global_volume (   )  const

Returns the main volume of the sound output.

int CL_SoundOutput::get_mixing_frequency (   )  const

Returns the mixing frequency for the sound output device.

int CL_SoundOutput::get_mixing_latency (   )  const

Returns the mixing latency in milliseconds.

const CL_String8& CL_SoundOutput::get_name (   )  const

Name of the output device.

void CL_SoundOutput::remove_filter (  CL_SoundFilter &  filter  )

Remove the sound filter from the session.

void CL_SoundOutput::set_global_pan (  float  pan  )

Sets the main panning position on the sound output.

void CL_SoundOutput::set_global_volume (  float  volume  )

Sets the main/mixer volume on the sound output.

void CL_SoundOutput::stop_all (   )

Stops all sample playbacks on the sound output.

---

Friends And Related Function Documentation

friend class CL_Sound [friend]

friend class CL_SoundBuffer [friend]

friend class CL_SoundBuffer_Session [friend]

---

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

• soundoutput.h

---