Home | All Classes | Grouped Classes | Index | Search

Class CL_SoundBuffer

Sample interface in ClanLib. More...

Derived from: none
Derived by: none
Group: Sound (Audio Mixing)

#include <ClanLib/sound.h>

Construction:

Construct sound buffer.

Attributes:

get_sound_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_playing	Returns true if an instance of this soundbuffer is playing

Operations:

operator =	Copy assignment operator.
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.
stop	Stops any sessions playing this soundbuffer
play	Plays the soundbuffer on the specified soundcard.
prepare	Prepares the soundbuffer for playback on the specified soundcard.

Detailed description:

!group=Sound/Audio Mixing! !header=sound.h!

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.

Questions or comments, write to the ClanLib mailing list.