IRecordPromptOptions interface

Package:

botbuilder-calling

Options passed to a 'record' prompt.

Extends

IPromptOptions

Properties

initialSilenceTimeoutInSeconds	Maximum initial silence allowed before the recording is stopped. The default value is 5 seconds.
maxDurationInSeconds	Maximum duration of recording. The default value is 180 seconds.
maxRetries	(Optional) maximum number of times to reprompt the user. Default value is 2.
maxSilenceTimeoutInSeconds	Maximum silence allowed after the speech is detected. The default value is 5 seconds.
playBeep	Indicates whether to play beep sound before starting a recording action.
recordingFormat	The format expected for the recording. The RecordingFormat enum describes the supported values. The default value is “wma”.
stopTones	Stop digits that user can press on dial pad to stop the recording.

Property Details

initialSilenceTimeoutInSeconds

Maximum initial silence allowed before the recording is stopped. The default value is 5 seconds.

initialSilenceTimeoutInSeconds?: number

Property Value

number

maxDurationInSeconds

Maximum duration of recording. The default value is 180 seconds.

maxDurationInSeconds?: number

Property Value

number

maxRetries

(Optional) maximum number of times to reprompt the user. Default value is 2.

maxRetries?: number

Property Value

number

maxSilenceTimeoutInSeconds

Maximum silence allowed after the speech is detected. The default value is 5 seconds.

maxSilenceTimeoutInSeconds?: number

Property Value

number

playBeep

Indicates whether to play beep sound before starting a recording action.

playBeep?: boolean

Property Value

boolean

recordingFormat

The format expected for the recording. The RecordingFormat enum describes the supported values. The default value is “wma”.

recordingFormat?: string

Property Value

string

stopTones

Stop digits that user can press on dial pad to stop the recording.

stopTones?: string[]

Property Value

string[]