IPrompt interface

Package:

botbuilder-calling

Prompt played as part of the PlayPrompt action.

Properties

culture	The Language enum value to use for Text-To-Speech. Only applicable if value is text. The default value is “en-US”. Note, currently en-US is the only supported language.
emphasize	Indicates whether to emphasize when tts'ing out. It's applicable only if value is text. The default value is false.
fileUri	HTTP of played media file. Supported formats are WMA or WAV. The file is limited to 512kb in size and cached by Skype Bot Platform for Calling. Either value or fileUri must be specified.
sayAs	The SayAs enum value indicates whether to customize pronunciation during tts. It's applicable only if value is text.
silenceLengthInMilliseconds	Any silence played out before value is played. If value is null, this field must be a valid > 0 value.
value	Text-To-Speech text to be played to Skype user. Either value or fileUri must be specified.
voice	VoiceGender enum value. The default value is “female”.

Property Details

culture

The Language enum value to use for Text-To-Speech. Only applicable if value is text. The default value is “en-US”. Note, currently en-US is the only supported language.

culture?: string

Property Value

string

emphasize

Indicates whether to emphasize when tts'ing out. It's applicable only if value is text. The default value is false.

emphasize?: boolean

Property Value

boolean

fileUri

HTTP of played media file. Supported formats are WMA or WAV. The file is limited to 512kb in size and cached by Skype Bot Platform for Calling. Either value or fileUri must be specified.

fileUri?: string

Property Value

string

sayAs

The SayAs enum value indicates whether to customize pronunciation during tts. It's applicable only if value is text.

sayAs?: string

Property Value

string

silenceLengthInMilliseconds

Any silence played out before value is played. If value is null, this field must be a valid > 0 value.

silenceLengthInMilliseconds?: number

Property Value

number

value

Text-To-Speech text to be played to Skype user. Either value or fileUri must be specified.

value?: string

Property Value

string

voice

VoiceGender enum value. The default value is “female”.

voice?: string

Property Value

string