startSpeech

Reads the given text to the user based on the language provided.

note

Some languages must be provided by a specific Text-To-Speach (TTS) engine, which must be downloaded separately depending on the user's device and operating system.

Field Configurations

Key	Type	Description	Default Value
"params"	Object	undefined	null

Parameters

Key	Type	Description	Default Value
"async"	Boolean	Specifies whether the action should perform asynchronously.	null
"language"	String	The language as a two letter language code with an optional country code	null
"queueMode"	String	The queue mode	null
"text" (required)	String	The text the read	null

Inherited

From Base Action

Base Action

Field Configurations

Key	Type	Description	Default Value
"dynamicParams"	Object	Dynamic params to retrieve data from a specific context e.g. a userSetting.	null
"leadingDelimiter"	String	The leading mustache delimiter to use.	null
"params"	Object,Array	Object containing the properties of the action.	null
"trailingDelimiter"	String	The trailing mustache delimiter to use.	null
"type"	String	Type name of the action.	null

Examples

Example 1: Start text-to-speech playback

Show ExampleHide Example

The provided text will be read aloud in the specified language using text-to-speech.

{
  "type": "startSpeech",
  "params": {
    "text": "Hello There!",
    "language": "en-US",
    "queueMode": "afterCurrent"
  }
}