Declared in STMediaParams_doc.h

Overview

This struct describes the parameters for control audio playback of a prompt that may be executing during audio recording.

A STRecordPlayPromptParams object can be created as follows:

let stRecordPlayPromptParams = STRecordPlayPromptParams()

Tasks

  •   playAudioIsActive

    This parameter specifies that audio playback of an audio segment is active during audio recording. Default: false.

           property
  •   stopPlayAudioWhenSpeechDetected

    This parameter instructs audio recording to send a request that stops audio playback when Voice Activity Detection running during audio recording detects speech in recorded audio. Default: false.

           property
  •   stopPlayAudioWhenValidSRHypothesis

    This parameter instructs audio recording to send a request that stops audio playback when speech recognizer executing during audio recording generates a valid hypothesis. Default: false.

           property
  •   enableStopPlaySRHypothesisPartial

    This parameter instructs audio recording to enable or disable sending a request that stops audio playback when speech recognizer executing during audio recording generates a partial hypothesis. Default: false.

           property
  •   stopPlaySRHypothesisList

    This parameter provides audio recording an SR hyppthesis list. When speech recognizer executing during audio recording generates an SR hypothesis that matches one in the SR hypothesis list, audio recording will send a request that stops audio playback. Default: nil.

           property

Properties

enableStopPlaySRHypothesisPartial

var enableStopPlaySRHypothesisPartial: Bool = false

Discussion

This parameter instructs audio recording to enable or disable sending a request that stops audio playback when speech recognizer executing during audio recording generates a partial hypothesis. Default: false.

Declared In

STMediaParams_doc.h

playAudioIsActive

var playAudioIsActive: Bool = false

Discussion

This parameter specifies that audio playback of an audio segment is active during audio recording. Default: false.

Declared In

STMediaParams_doc.h

stopPlayAudioWhenSpeechDetected

var stopPlayAudioWhenSpeechDetected: Bool = false

Discussion

This parameter instructs audio recording to send a request that stops audio playback when Voice Activity Detection running during audio recording detects speech in recorded audio. Default: false.

Declared In

STMediaParams_doc.h

stopPlayAudioWhenValidSRHypothesis

var stopPlayAudioWhenValidSRHypothesis: Bool = false

Discussion

This parameter instructs audio recording to send a request that stops audio playback when speech recognizer executing during audio recording generates a valid hypothesis. Default: false.

Declared In

STMediaParams_doc.h

stopPlaySRHypothesisList

var stopPlaySRHypothesisList: [String]?

Discussion

This parameter provides audio recording an SR hyppthesis list. When speech recognizer executing during audio recording generates an SR hypothesis that matches one in the SR hypothesis list, audio recording will send a request that stops audio playback. Default: nil.

Declared In

STMediaParams_doc.h