All Classes |Grouped Classes |Index

Class CL_SoundBuffer

Sample interface in ClanLib. More...

Derived from:

None

Derived by:

None

Group:

Audio Mixing (Sound)

#include <ClanLib/sound.h>

Class Members:

Construction:

CL_SoundBuffer

Construct a null instance.


Attributes:

get_provider

Returns the sound provider to be used for playback.

get_volume

Returns the start/default volume used when the buffer is played.

get_pan

Returns the default panning position when the buffer is played.

is_null

Returns true if this object is invalid.

throw_if_null

Throw an exception if this object is invalid.


Operations:

set_volume

Sets the volume of the sound buffer in a relative measure (0->1)

set_pan

Sets the panning of the sound buffer played in measures from -1 -> 1.

add_filter

Adds the sound filter to the sound buffer.

remove_filter

Remove the sound filter from the sound buffer.

play

Plays the soundbuffer on the specified soundcard.

prepare

Prepares the soundbuffer for playback on the specified soundcard.

Detailed description:

The CL_SoundBuffer class represents a sample in ClanLib. It can either be static or streamed. The soundbuffer gets its sample data from a soundprovider, that is passed during construction.