Package com.inductiveautomation.ignition.gateway.services.tts

Class TTSVoiceDescriptor

java.lang.Object

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

public class TTSVoiceDescriptor
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TTSVoiceDescriptor.InvalidTTSVoiceDescriptorException

Constructor Summary

Constructors

Constructor	Description
TTSVoiceDescriptor(@Nullable String engine, Locale locale, @Nullable String name)
TTSVoiceDescriptor(Locale locale)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

TTSVoiceDescriptor

public TTSVoiceDescriptor(Locale locale)

TTSVoiceDescriptor

public TTSVoiceDescriptor(@Nullable
 @Nullable String engine,
 Locale locale,
 @Nullable
 @Nullable String name)

Method Details

parse

@NotNull
public static @NotNull TTSVoiceDescriptor parse(@Nullable
 @Nullable String value)
                                         throws TTSVoiceDescriptor.InvalidTTSVoiceDescriptorException

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

Throws:

TTSVoiceDescriptor.InvalidTTSVoiceDescriptorException

getLocale

public Locale getLocale()

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

getName

public String getName()

Returns the name of the voice.

getEngine

public String getEngine()

Returns the id of the engine that provides this voice.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object