ClanLib  2.3.7
List of all members
CL_SoundOutput Class Reference

SoundOutput interface in ClanLib. More...

#include <soundoutput.h>

Public Member Functions

Construction
 CL_SoundOutput ()
 Constructs a null instance. More...
 
 CL_SoundOutput (int mixing_frequency, int latency=50)
 Constructs a SoundOutput. More...
 
 CL_SoundOutput (const CL_SoundOutput_Description &desc)
 Constructs a SoundOutput. More...
 
virtual ~CL_SoundOutput ()
 
Attributes
bool is_null () const
 Returns true if this object is invalid. More...
 
void throw_if_null () const
 Throw an exception if this object is invalid. More...
 
const CL_String8get_name () const
 Name of the output device. More...
 
int get_mixing_frequency () const
 Returns the mixing frequency for the sound output device. More...
 
int get_mixing_latency () const
 Returns the mixing latency in milliseconds. More...
 
float get_global_volume () const
 Returns the main volume of the sound output. More...
 
float get_global_pan () const
 Returns the main panning position of the sound output. More...
 
Operations
void stop_all ()
 Stops all sample playbacks on the sound output. More...
 
void set_global_volume (float volume)
 Sets the main/mixer volume on the sound output. More...
 
void set_global_pan (float pan)
 Sets the main panning position on the sound output. More...
 
void add_filter (CL_SoundFilter &filter)
 Adds the sound filter to the sound output. More...
 
void remove_filter (CL_SoundFilter &filter)
 Remove the sound filter from the session. More...
 

Implementation

class CL_SoundBuffer
 
class CL_Sound
 
class CL_SoundBuffer_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 null instance.

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
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
filterSound 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.

bool CL_SoundOutput::is_null ( ) const
inline

Returns true if this object is invalid.

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.

void CL_SoundOutput::throw_if_null ( ) const

Throw an exception if this object is invalid.

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: