Declared in STMediaParams_doc.h

STMediaEventData

This enumerator defines the media event data type, expressed as a key string and included as a key/value entry in both mediaEventData parameter of STMedia_EventNotification which is sent by STMediaRunner module, and in mediaEventData parameter STVFC_MediaEvent callback function which is called by STVoiceFlowRunner module. This event data are associated with specific media event function types.

Definition

enum STMediaEventData: String {
   case kST_MED_MediaPosMs = "MediaPosMs",
     kST_MED_AudioDurationMs = "AudioDurationMs",
     kST_MED_RecordDurationMs = "RecordDurationMs",
     kST_MED_StopRecordReason = "StopRecordReason",
     kST_MED_StopRecordDetail = "StopRecordDetail",
     kST_MED_PlayAudioLoopCount = "PlayAudioLoopCount"
}

Constants

case kST_MED_MediaPosMs

The value of this key is a time position in milliseconds. This time position is provided for many media functions an events. Examples: the time position of when audio playback or recording started or stopped, time position when an audio playback is paused/skipped/resumed, and time position when speech or silence is detected.

Declared In STMediaParams_doc.h.

case kST_MED_AudioDurationMs

The value of this key is a time duration in milliseconds. This time duration is provided by the audio recorder to indicate the audio recording length.

Declared In STMediaParams_doc.h.

case kST_MED_RecordDurationMs

The value of this key is a time duration in milliseconds. This time duration is provided by the audio recorder to indicate the audio duration length captured for recording.

Declared In STMediaParams_doc.h.

case kST_MED_StopRecordReason

The value of this key is reason for audio recording stopping. The value is one of the media stop record reasons enumerated in STMediaStopRecordReason.

Declared In STMediaParams_doc.h.

case kST_MED_StopRecordDetail

The value of this key is more detail for the the reason for audio recording stopping. The value is String.

Declared In STMediaParams_doc.h.

case kST_MED_PlayAudioLoopCount

The value of this key is the loop count for audio playback. When audio playback is performed in a loop, this value is provided to a client everytime the audio playback finished and restarts.

Declared In STMediaParams_doc.h.

Declared In

STMediaParams_doc.h