BZAudioPlayerState Constants Reference
| Declared in | BZMediaParams.h |
BZAudioPlayerState
This constant enumerator defines the real-time Audio Player State (APS). An application accesses the audio player through the audio playback capability available via BZMediaController 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
typedef NS_ENUM(NSInteger, BZAudioPlayerState ) {
APS_NOT_VALID = -1,
APS_IDLE = 0,
APS_STARTING = 1,
APS_ACTIVE = 2,
APS_STOPPING = 3,
};
Constants
APS_NOT_VALID-
Audio player state is not valid. This is the initial state of the audio player before it’s initialized.
Declared In
BZMediaParams.h. 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
BZMediaParams.h. APS_STARTING-
Audio player state is starting. Audio player has accepted a request to play audio from an audio source and audio playback is just about to start.
Declared In
BZMediaParams.h. APS_ACTIVE-
Audio player state is active. Audio player is playing audio from an audio source.
Declared In
BZMediaParams.h. APS_STOPPING-
Audio player state is stopping. Audio player transitions to this state after receiving a signal to stop audio playback. Eventually, Audio player state transitions from APS_STOPPING TO APS_IDLE.
Declared In
BZMediaParams.h.
Declared In
BZMediaParams.h