com.inductiveautomation.ignition.gateway.services.tts

Interface TTSEngine

public interface TTSEngine

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() Returns an identifier that can be used to reference this particular engine.
java.util.List<TTSVoiceDescriptor>	getSupportedVoices() Returns the various locales that the engine can handle text for.
TTSTalker	getTalker(TTSVoiceDescriptor desc) Returns a TTSTalker for the specified voice that can be used to render text.
void	initialize()
void	shutdown()

Method Detail

getId

java.lang.String getId()

Returns an identifier that can be used to reference this particular engine.

initialize

void initialize()
         throws java.lang.Exception

Throws:

java.lang.Exception

shutdown

void shutdown()

getSupportedVoices

java.util.List<TTSVoiceDescriptor> getSupportedVoices()

Returns the various locales that the engine can handle text for. In other words, which languages it supports.

getTalker

TTSTalker getTalker(TTSVoiceDescriptor desc)

Returns a TTSTalker for the specified voice that can be used to render text. This function must be provided with a qualified VoiceDescriptor that matches one of the values returned from getSupportedVoices(). If you need fuzzy support, call TTSEngineManager.getTalker()

Parameters:

desc - the voice descriptor to use. Must exist, otherwise IllegalArgument will be thrown