All Classes |Grouped Classes |Index

Class CL_SoundOutput

SoundOutput interface in ClanLib. More...

Derived from:

None

Derived by:

None

Group:

Audio Mixing (Sound)

#include <ClanLib/sound.h>

Class Members:

Construction:

CL_SoundOutput

Constructs a null instance.


Attributes:

is_null

Returns true if this object is invalid.

throw_if_null

Throw an exception if this object is invalid.

get_name

Name of the output device.

get_mixing_frequency

Returns the mixing frequency for the sound output device.

get_mixing_latency

Returns the mixing latency in milliseconds.

get_global_volume

Returns the main volume of the sound output.

get_global_pan

Returns the main panning position of the sound output.


Operations:

stop_all

Stops all sample playbacks on the sound output.

set_global_volume

Sets the main/mixer volume on the sound output.

set_global_pan

Sets the main panning position on the sound output.

add_filter

Adds the sound filter to the sound output.

remove_filter

Remove the sound filter from the session.

Detailed description:

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