STAudioRecorderState Constants Reference
| Declared in | STMediaParams_doc.h |
STAudioRecorderState
This enumerator defines the real-time Audio Recorder State (ARS). An application accesses the audio recorder through the audio recording capability available via STMediaRunner module interface. During audio recording and when the audio recorder changes state, the audio recorder posts events asynchronously and in real-time of its new state to the main thread of a registered client or application.
Definition
enum STAudioRecorderState {
case ARS_NOT_VALID,
ARS_IDLE,
ARS_STARTING,
ARS_ACTIVE,
ARS_STOPPING
}
Constants
case ARS_NOT_VALID-
Audio recorder state is not valid. This is the initial state of the audio recorder before it’s initialized.
Declared In
STMediaParams_doc.h. case ARS_IDLE-
Audio recorder state is idle. Audio recorder is ready to accept a request to record audio. Also, transitioning to this state implies that audio recorder has stopped or finished audio recording completely, and is ready to accept another request to record audio. Audio recorder state must be ARS_IDLE before it can accept a new audio record request.
Declared In
STMediaParams_doc.h. case ARS_STARTING-
Audio recorder state is starting. Audio recorder has accepted a request to record audio to an audio destination and audio recording is just about to start.
Declared In
STMediaParams_doc.h. case ARS_ACTIVE-
Audio recorder state is active. Audio recorder is recording audio to an audio destination.
Declared In
STMediaParams_doc.h. case ARS_STOPPING-
Audio recorder state is stopping. Audio recorder transitions to this state after receiving a request to stop audio recording. Eventually, Audio recorder state transitions from ARS_STOPPING to ARS_IDLE.
Declared In
STMediaParams_doc.h.
Declared In
STMediaParams_doc.h