KSD_EXPORT_CLASSclass TSampleInstance

The object used to access a currently playing instance of a TSample.

Inheritance:

Public Methods

TSampleInstance()

Make an empty sample instance

bool IsPlaying() const

bool IsPaused() const

bool IsStopped() const

bool Stop( int fadeout = 0 )

Stop the instance after fading it for fadeout ms.

bool StopIn( int ms )

Stop the instance after ms ms.

void Pause()

Pause the instance

void Resume()

Resume playing the instance if it was paused

void SetVolume( int vol )

Set the volume of the instance.

int GetVolume() const

Protected Methods

TSampleInstance(Data* data)

Initialize a TSampleInstance with a data object

Documentation

The object used to access a currently playing instance of a TSample. It provides function to start, stop, pause, resume and fade the instance. It also provides function to query the state of the instance.

TSampleInstance(Data* data)

Initialize a TSampleInstance with a data object

TSampleInstance()

Make an empty sample instance

bool IsPlaying() const

Returns:

true if the instance is playing and false otherwise.

bool IsPaused() const

Returns:

true if the instance is paused and false otherwise.

bool IsStopped() const

Returns:

true if the instance is stoped and false otherwise.

bool Stop( int fadeout = 0 )

Stop the instance after fading it for fadeout ms.

Returns:

true if the channel was playing and is now stoped, false otherwise.

bool StopIn( int ms )

Stop the instance after ms ms. This may not work I think there is a bug in SDL_mixer.

Returns:

True if the channel is playing and will stop in ms ms, false otherwise.

void Pause()

Pause the instance

void Resume()

Resume playing the instance if it was paused

void SetVolume( int vol )

Set the volume of the instance. This does not affect othe instances of the same sample.

int GetVolume() const

Returns:

The volume of the instance.

This class has no child classes.

Friends:

class TMixer

Alphabetic index HTML hierarchy of classes or Java