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
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
JavaSE Documentation
TTSChunk

Class TTSChunk

Hierarchy

java.lang.Object
     com.smartdevicelink.proxy.RPCStruct

Package
com.smartdevicelink.proxy.rpc

Overview

Specifies what is to be spoken. This can be simply a text phrase, which SDL will speak according to its own rules. It can also be phonemes from either the Microsoft SAPI phoneme set, or from the LHPLUS phoneme set. It can also be a pre-recorded sound in WAV format (either developer-defined, or provided by the SDL platform).

In SDL, words, and therefore sentences, can be built up from phonemes and are used to explicitly provide the proper pronunciation to the TTS engine. For example, to have SDL pronounce the word "read" as "red", rather than as when it is pronounced like "reed", the developer would use phonemes to express this desired pronunciation.

For more information about phonemes, see http://en.wikipedia.org/wiki/Phoneme

.

Parameter List

Name Type Description SmartDeviceLink Ver. Available
text String Text to be spoken, or a phoneme specification, or the name of a pre-recorded sound. The contents of this field are indicated by the "type" field. SmartDeviceLink 1.0
type SpeechCapabilities Indicates the type of information in the "text" field (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound). SmartDeviceLink 1.0

Fields

KEY_TEXT

public static final java.lang.String KEY_TEXT
Constant Value
"text"

KEY_TYPE

public static final java.lang.String KEY_TYPE
Constant Value
"type"

Inherited Fields

From Class Fields
com.smartdevicelink.proxy.RPCStruct KEY_BULK_DATA, KEY_PROTECTED, store

Constructors

TTSChunk()

Constructs a newly allocated TTSChunk object

public TTSChunk()

TTSChunk( java.util.Hashtable<java.lang.String, java.lang.Object> hash )

Constructs a newly allocated TTSChunk object indicated by the Hashtable parameter

public TTSChunk(java.util.Hashtable<java.lang.String, java.lang.Object> hash)

Constructor Parameters

hash
The Hashtable to use

TTSChunk( String text, SpeechCapabilities type )

Constructs a newly allocated TTSChunk object

public TTSChunk(String text,SpeechCapabilities type)

Constructor Parameters

text
Text to be spoken, or a phoneme specification, or the name of a pre-recorded sound. The contents of this field are indicated by the "type" field.
type
Indicates the type of information in the "text" field (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound).

Methods

getText()

Get text to be spoken, or a phoneme specification, or the name of a pre-recorded sound. The contents of this field are indicated by the "type" field.

public java.lang.String getText()

setText( String text )

Set the text to be spoken, or a phoneme specification, or the name of a pre-recorded sound. The contents of this field are indicated by the "type" field.

public com.smartdevicelink.proxy.rpc.TTSChunk setText(String text)

Method Parameters

text
to be spoken, or a phoneme specification, or the name of a pre-recorded sound.

getType()

Get the type of information in the "text" field (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound).

public com.smartdevicelink.proxy.rpc.enums.SpeechCapabilities getType()

setType( SpeechCapabilities type )

Set the type of information in the "text" field (e.g. phrase to be spoken, phoneme specification, name of pre-recorded sound).

public com.smartdevicelink.proxy.rpc.TTSChunk setType(SpeechCapabilities type)

Method Parameters

type
the type of information in the "text" field

Inherited Methods

From Class Methods
com.smartdevicelink.proxy.RPCStruct getStoreValue, getStore, deserializeJSON, serializeJSON, serializeJSON, format, getBulkData, setBulkData, setPayloadProtected, isPayloadProtected, getMessageTypeName, hasKey, setValue, getValue, getObject, formatObject, getValueForString, getString, getInteger, getDouble, getFloat, getBoolean, getLong, clone, equals, hashCode
java.lang.Object getClass, hashCode, equals, clone, toString, notify, notifyAll, wait, wait, wait, finalize
View on GitHub.com
Previous Section Next Section