KSD_EXPORT_CLASSclass TMixer

The overall mixer object.

Public Fields

SigC::Signal0<void> MusicFinished

Signal called when the current song finishes

Public Methods

void Init(int sampling_rate, Uint16 format, int output_channels = 2, int chunksize = -1)

Initialize the mixer.

void Init(const Attr& attr)

Initialize the mixer.

void Close()

Close the mixer. Stop all playing samples and music and close the mixer.

int SetChannels( int channels )

Set the number of mixer channels (you should never need to do this).

int GetChannels() const

int GetSamplingRate() const

int GetChunkSize() const

Uint16 GetFormat() const

std::auto_ptr<TSampleInstance> StartSample( TSample& sample, int loops = 1, int volume = 128, int fadein = 0, int playfor = -1 ) throw( EMixerError )

Start playing sample.

void StartMusic( TSong& song, int loops = 1, int fadein = 0 ) throw(EMixerError)

Start playing song.

void PauseMusic()

Pause the music

void ResumeMusic()

Resume playing the music

void RewindMusic()

Rewind the music.

void StopMusic( int fadeout = 0 )

Stop the music after fading for fadeout ms

void SetMusicVolume( int vol )

Set the music volume

int GetMusicVolume() const

Get the music volume.

bool IsMusicPaused() const

bool IsMusicPlaying() const

bool IsMusicStopped() const

Public Members

struct Attr

This structure contains all the parameters nessecary to initialize the mixer.

Documentation

The overall mixer object. It provides all the sample and music playing function.

struct Attr

This structure contains all the parameters nessecary to initialize the mixer.

See Also:

TMixerAttr

void Init(int sampling_rate, Uint16 format, int output_channels = 2, int chunksize = -1)

Initialize the mixer. Mixer parameters are provided as seperate values. No other mixer functions can be used before this is called.

void Init(const Attr& attr)

Initialize the mixer. Mixer parameters are provided as a TMixerAttr object. No other mixer functions can be used before this is called.

void Close()

int SetChannels( int channels )

Set the number of mixer channels (you should never need to do this). This is useful if you know you are going to be using a lot of channels and don't want them to be allocated dynamicly.

Returns:

the number of mixer channels allocated at the end of the operation.

int GetChannels() const

Returns:

The number channels currently allocated.

See Also:

TMixer::SetChannels

int GetSamplingRate() const

Returns:

The sampling rate of the mixer.

int GetChunkSize() const

Returns:

The size of the chunk beginning mixed and sent to the audio device.

Uint16 GetFormat() const

Returns:

The sample format.

std::auto_ptr<TSampleInstance> StartSample( TSample& sample, int loops = 1, int volume = 128, int fadein = 0, int playfor = -1 ) throw( EMixerError )

Start playing sample.

Don't do:
std::auto_ptr<TSampleInstance> inst;
inst = Mixer.StartSample(...);

Do:
std::auto_ptr<TSampleInstance> inst;
inst.reset( Mixer.StartSample(...).release() );

Or:
TSampleInstance* inst;
inst = Mixer.StartSample(...).release();

This is because G++ versions before 3.0 have a broken auto_ptr.

Parameters:

loops - Setting loops to 1 will play the sample one setting it to 2 will play it twice.
volume - The volume at which to start the sample. (In the range of 0-128.)
fadein - The number of ms over which to fade in the sample.
playfor - Automaticly stop the sample after this number of ms. If it is -1 don't stop it.

Returns:

An auto_ptr to a TSampleInstance representing the sample that was started.

void StartMusic( TSong& song, int loops = 1, int fadein = 0 ) throw(EMixerError)

Start playing song. It will be looped loops time and faded in for fadein ms.

The fade in feature doesn't work and I don't know why. (help me!)

void PauseMusic()

Pause the music

void ResumeMusic()

Resume playing the music

void RewindMusic()

Rewind the music. This can cause some problems when used on MP3s.

void StopMusic( int fadeout = 0 )

Stop the music after fading for fadeout ms

void SetMusicVolume( int vol )

Set the music volume

int GetMusicVolume() const

Get the music volume.

Returns:

the current music volume.

bool IsMusicPaused() const

Returns:

true if music is paused and false otherwise.

bool IsMusicPlaying() const

Returns:

true if music is playing and false otherwise.

bool IsMusicStopped() const

Returns:

true if music is stopped (not paused, stopped) and false otherwise.

SigC::Signal0<void> MusicFinished

Signal called when the current song finishes

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java