Methods > Init and info > GetPlaybackStatus method

Remarks

Obtains the current playback status.

This method can be used in alternative to events reporting changes of playback status (SoundPlaybackPlaying, SoundPlaybackPaused, SoundPlaybackStopped and SoundPlaybackDone) when the control has been set to work with sound pre-loading through a call to the EnableSoundPreloadForPlayback method: in order to optimize system resources, when pre-loading is disabled (default situation), the stream to play is only loaded when specifically requested through a call to the PlaySound or PlaySoundRange methods and automatically discarded from memory after a call to the StopSound method or when the end of the song is reached.

Syntax

[Visual Basic]

Public Function GetPlaybackStatus (

) as enumPlaybackStatus

[C#]

public enumPlaybackStatus GetPlaybackStatus (

);

[C++]

public: enumPlaybackStatus GetPlaybackStatus (

);

Return value

Value

Meaning

Negative value

An error occurred (see the LastError property for further error details)

Other values

The current playback status.

Possible values are the following:

Mnemonic Value	Value	Meaning
PLAYBACK_NO_SOUND	0	No sound is loaded for playback.
PLAYBACK_PLAYING	1	Sound is in playback after a call to one between the PlaySound or PlaySoundRange or ResumeSound methods.
PLAYBACK_PAUSED	2	Sound is paused after a call to the PauseSound method.
PLAYBACK_STOPPED	3	Sound is stopped after a call to the StopSound method or after completing playback.