com.smartdevicelink.proxy.rpc

Class Speak

java.lang.Object

com.smartdevicelink.proxy.RPCStruct

com.smartdevicelink.proxy.RPCMessage

com.smartdevicelink.proxy.RPCRequest

com.smartdevicelink.proxy.rpc.Speak

All Implemented Interfaces:

Cloneable

public class Speak
extends RPCRequest

Speaks a phrase over the vehicle audio system using SDL's TTS (text-to-speech) engine. The provided text to be spoken can be simply a text phrase, or it can consist of phoneme specifications to direct SDL's TTS engine to speak a "speech-sculpted" phrase

Receipt of the Response indicates the completion of the Speak operation, regardless of how the Speak operation may have completed (i.e. successfully, interrupted, terminated, etc.)

Requesting a new Speak operation while the application has another Speak operation already in progress (i.e. no corresponding Response for that in-progress Speak operation has been received yet) will terminate the in-progress Speak operation (causing its corresponding Response to be sent by SDL) and begin the requested Speak operation

Requesting a new Speak operation while the application has an Alert operation already in progress (i.e. no corresponding Response for that in-progress Alert operation has been received yet) will result in the Speak operation request being rejected (indicated in the Response to the Request)

Requesting a new Alert operation while the application has a Speak operation already in progress (i.e. no corresponding Response for that in-progress Speak operation has been received yet) will terminate the in-progress Speak operation (causing its corresponding Response to be sent by SDL) and begin the requested Alert operation

Requesting a new Speak operation while the application has a PerformInteraction operation already in progress (i.e. no corresponding Response for that in-progress PerformInteraction operation has been received yet) will result in the Speak operation request being rejected (indicated in the Response to the Request)

Requesting a PerformInteraction operation while the application has a Speak operation already in progress (i.e. no corresponding Response for that in-progress Speak operation has been received yet) will terminate the in-progress Speak operation (causing its corresponding Response to be sent by SDL) and begin the requested PerformInteraction operation

HMI Status Requirements:

HMILevel: FULL, Limited

AudioStreamingState: Any

SystemContext: MAIN, MENU, VR

Notes:

• When Alert is issued with MENU in effect, Alert is queued and "played" when MENU interaction is completed (i.e. SystemContext reverts to MAIN). When Alert is issued with VR in effect, Alert is queued and "played" when VR interaction is completed (i.e. SystemContext reverts to MAIN)
• When both Alert and Speak are queued during MENU or VR, they are "played" back in the order in which they were queued, with all existing rules for "collisions" still in effect

Parameter List

Name	Type	Description	Reg.	Notes	Ver. Available
ttsChunks	String	An array of 1-100 TTSChunk structs which, taken together, specify the phrase to be spoken.	Y	The array must have 1-100 elements. The total length of the phrase composed from the ttsChunks provided must be less than 500 characters or the request will be rejected. Each chunk can be no more than 500 characters.	SmartDeviceLink 1.0

Response

This Response notifies the application of the completion, interruption, or failure of a Speak Request.

Non-default Result Codes:

SUCCESS

INVALID_DATA

OUT_OF_MEMORY

APPLICATION_NOT_REGISTERED

TOO_MANY_PENDING_REQUESTS

GENERIC_ERROR

REJECTED

DISALLOWED

ABORTED

Additional Notes:

Total character limit depends on platform. Chunks are limited to 500 characters; however you can have multiple TTS chunks. On Gen 1.1 there is a total character limit of 500 characters across all chunks. This could vary according to the VCA.

Since:

SmartDeviceLink 1.0

See Also:

Alert

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_TTS_CHUNKS

Fields inherited from class com.smartdevicelink.proxy.RPCRequest

onResponseListener

Fields inherited from class com.smartdevicelink.proxy.RPCMessage

function, KEY_CORRELATION_ID, KEY_FUNCTION_NAME, KEY_NOTIFICATION, KEY_PARAMETERS, KEY_REQUEST, KEY_RESPONSE, messageType, parameters

Fields inherited from class com.smartdevicelink.proxy.RPCStruct

KEY_BULK_DATA, KEY_PROTECTED, store

Constructor Summary

Constructors

Constructor and Description
Speak() Constructs a new Speak object
Speak(Hashtable<String,Object> hash) Constructs a new Speak object indicated by the Hashtable parameter
Speak(List<TTSChunk> ttsChunks) Constructs a new Speak object

Method Summary

Modifier and Type	Method and Description
List<TTSChunk>	getTtsChunks() Gets a List representing an array of 1-100 TTSChunk structs which, taken together, specify the phrase to be spoken
Speak	setTtsChunks(List<TTSChunk> ttsChunks) Sets a List representing an array of 1-100 TTSChunk structs which, taken together, specify the phrase to be spoken

Methods inherited from class com.smartdevicelink.proxy.RPCRequest

getCorrelationID, getOnRPCResponseListener, setCorrelationID, setOnRPCResponseListener

Methods inherited from class com.smartdevicelink.proxy.RPCMessage

getBoolean, getDouble, getFloat, getFunctionID, getFunctionName, getInteger, getLong, getMessageType, getObject, getParameters, getString, setFunctionName, setParameters

Methods inherited from class com.smartdevicelink.proxy.RPCStruct

clone, deserializeJSON, equals, format, formatObject, getBulkData, getMessageTypeName, getStore, getStoreValue, getValue, getValueForString, hashCode, hasKey, isPayloadProtected, serializeJSON, serializeJSON, setBulkData, setPayloadProtected, setValue

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEY_TTS_CHUNKS

public static final String KEY_TTS_CHUNKS

See Also:

Constant Field Values

Constructor Detail

Speak

public Speak()

Constructs a new Speak object

Speak

public Speak(Hashtable<String,Object> hash)

Constructs a new Speak object indicated by the Hashtable parameter

Parameters:

hash - The Hashtable to use

Speak

public Speak(@NonNull
             List<TTSChunk> ttsChunks)

Constructs a new Speak object

Parameters:

ttsChunks - An array of 1-100 TTSChunk structs which, taken together, specify the phrase to be spoken.

Method Detail

getTtsChunks

public List<TTSChunk> getTtsChunks()

Gets a List representing an array of 1-100 TTSChunk structs which, taken together, specify the phrase to be spoken

Returns:

List -an Array of 1-100 TTSChunk specify the phrase to be spoken

setTtsChunks

public Speak setTtsChunks(@NonNull
                          List<TTSChunk> ttsChunks)

Sets a List representing an array of 1-100 TTSChunk structs which, taken together, specify the phrase to be spoken

Parameters:

ttsChunks - a List value representing an array of 1-100 TTSChunk structs which specify the phrase to be spoken

• The array must have 1-100 elements
• The total length of the phrase composed from the ttsChunks provided must be less than 500 characters or the request will be rejected
• Each chunk can be no more than 500 characters