com.inductiveautomation.ignition.gateway.services.tts

Class TTSVoiceDescriptor

java.lang.Object

com.inductiveautomation.ignition.gateway.services.tts.TTSVoiceDescriptor

All Implemented Interfaces:

java.io.Serializable

public class TTSVoiceDescriptor
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TTSVoiceDescriptor(java.util.Locale locale)
TTSVoiceDescriptor(java.lang.String engine, java.util.Locale locale, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getEngine() Returns the id of the engine that provides this voice.
java.util.Locale	getLocale() Returns the locale, or language, represented by this voice.
java.lang.String	getName() Returns the name of the voice.
int	hashCode()
static TTSVoiceDescriptor	parse(java.lang.String value) The opposite of toString, this parses the voice description from a string in the format of "engineId/locale/name"
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TTSVoiceDescriptor

public TTSVoiceDescriptor(java.util.Locale locale)

TTSVoiceDescriptor

public TTSVoiceDescriptor(java.lang.String engine,
                          java.util.Locale locale,
                          java.lang.String name)

Method Detail

getLocale

public java.util.Locale getLocale()

Returns the locale, or language, represented by this voice.

getName

public java.lang.String getName()

Returns the name of the voice.

getEngine

public java.lang.String getEngine()

Returns the id of the engine that provides this voice.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

parse

public static TTSVoiceDescriptor parse(java.lang.String value)

The opposite of toString, this parses the voice description from a string in the format of "engineId/locale/name"

Parameters:

value -

Returns: