SoundOutput interface in ClanLib. More...

#include <soundoutput.h>

Public Member Functions

 SoundOutput ()
 Constructs a null instance. More...
 
 SoundOutput (int mixing_frequency, int latency=50)
 Constructs a SoundOutput. More...
 
 SoundOutput (const SoundOutput_Description &desc)
 Constructs a SoundOutput. More...
 
virtual ~SoundOutput ()
 
void add_filter (SoundFilter &filter)
 Adds the sound filter to the sound output. More...
 
float get_global_pan () const
 Returns the main panning position of the sound output. More...
 
float get_global_volume () const
 Returns the main volume of the sound output. 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...
 
const std::stringget_name () const
 Name of the output device. More...
 
bool is_null () const
 Returns true if this object is invalid. More...
 
void remove_filter (SoundFilter &filter)
 Remove the sound filter from the session. More...
 
void set_global_pan (float pan)
 Sets the main panning position on the sound output. More...
 
void set_global_volume (float volume)
 Sets the main/mixer volume on the sound output. More...
 
void stop_all ()
 Stops all sample playbacks on the sound output. More...
 
void throw_if_null () const
 Throw an exception if this object is invalid. More...
 

Friends

class Sound
 
class SoundBuffer
 
class SoundBuffer_Session
 

Detailed Description

SoundOutput interface in ClanLib.

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

clan::SoundOutput::SoundOutput ( )

Constructs a null instance.

clan::SoundOutput::SoundOutput ( int  mixing_frequency,
int  latency = 50 
)

Constructs a SoundOutput.

Parameters
mixing_frequency= value
latency= value
clan::SoundOutput::SoundOutput ( const SoundOutput_Description desc)

Constructs a SoundOutput.

Parameters
desc= Sound Output_ Description
virtual clan::SoundOutput::~SoundOutput ( )
virtual

Member Function Documentation

void clan::SoundOutput::add_filter ( SoundFilter filter)

Adds the sound filter to the sound output.

Parameters
filterSound filter to pass sound through.
float clan::SoundOutput::get_global_pan ( ) const

Returns the main panning position of the sound output.

float clan::SoundOutput::get_global_volume ( ) const

Returns the main volume of the sound output.

int clan::SoundOutput::get_mixing_frequency ( ) const

Returns the mixing frequency for the sound output device.

int clan::SoundOutput::get_mixing_latency ( ) const

Returns the mixing latency in milliseconds.

const std::string& clan::SoundOutput::get_name ( ) const

Name of the output device.

bool clan::SoundOutput::is_null ( ) const
inline

Returns true if this object is invalid.

void clan::SoundOutput::remove_filter ( SoundFilter filter)

Remove the sound filter from the session.

void clan::SoundOutput::set_global_pan ( float  pan)

Sets the main panning position on the sound output.

void clan::SoundOutput::set_global_volume ( float  volume)

Sets the main/mixer volume on the sound output.

void clan::SoundOutput::stop_all ( )

Stops all sample playbacks on the sound output.

void clan::SoundOutput::throw_if_null ( ) const

Throw an exception if this object is invalid.

Friends And Related Function Documentation

friend class Sound
friend
friend class SoundBuffer
friend
friend class SoundBuffer_Session
friend

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