Declared in STMediaParams_doc.h

STAudioPlayerState

This enumerator defines the real-time Audio Player State (APS). An application accesses the audio player through the audio playback capability available via STMediaRunner module interface. During audio playback and when the audio player changes state, the audio player posts events asynchronously and in real-time of its new state to the main thread of a registered client or application.

Definition

enum STAudioPlayerState {
   case APS_NOT_VALID,
     APS_IDLE,
     APS_STARTING,
     APS_ACTIVE,
     APS_STOPPING,
     APS_PAUSED
}

Constants

case APS_NOT_VALID

Audio player state is not valid. This is the initial state of the audio player before it’s initialized.

Declared In STMediaParams_doc.h.

case APS_IDLE

Audio player state is idle. Audio player is ready to accept a request to play audio. Also, transitioning to this state implies that audio player has stopped or finished audio playback completely, and is ready to accept another request to play audio. Audio player state must be APS_IDLE before it can accept a new audio playback request.

Declared In STMediaParams_doc.h.

case APS_STARTING

Audio player state is starting. Audio player has accepted a request to read audio from an audio source and audio playback is just about to start.

Declared In STMediaParams_doc.h.

case APS_ACTIVE

Audio player state is active. Audio player is reading/playing audio from an audio source.

Declared In STMediaParams_doc.h.

case APS_STOPPING

Audio player state is stopping. Audio player transitions to this state after receiving a request to stop audio playback. Eventually, Audio player state transitions from APS_STOPPING TO APS_IDLE.

Declared In STMediaParams_doc.h.

case APS_PAUSED

Audio player state is in Pause state. Audio player transitions to this state after receiving a request to pause audio playback. Eventually, Audio player state transitions from APS_PAUSED to APS_IDLE or APS_ACTIVE.

Declared In STMediaParams_doc.h.

Declared In

STMediaParams_doc.h