Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
Documentation
Speak

Speak

Type
Function
Sender
SDL
Purpose
Prompt TTS to speak the requested text to the user.

Request

Parameters

Name Type Mandatory Additional
ttsChunks Common.TTSChunk true array: true
minsize: 1
maxsize: 100
appID Integer true
speakType Common.MethodName false
playTone Boolean false

Response

Parameters

This RPC has no additional parameter requirements

Sequence Diagrams

JSON Message Examples

Example Request

{
  "id" : 144,
  "jsonrpc" : "2.0",
  "method" : "TTS.Speak",
  "params" :
  {
    "ttsChunks" :
    [
      {
        "text" : "Please say a command", 
        "type" : "TEXT"
      }
    ],
    "appID": 65368
  }
}

Example Response

{
  "id" : 144,
  "jsonrpc" : "2.0",
  "result" :
  {
    "code" : 0,
    "method" : "TTS.Speak"
  }
}

Example Error

{
  "id" : 144,
  "jsonrpc" : "2.0",
  "error" :
  {
    "code" : 5,
    "message" : "The command was aborted",
    "data" :
    {
      "method" : "TTS.Speak"
    }
  }
}
View on GitHub.com
Previous Section Next Section