com.inductiveautomation.ignition.gateway.services.tts

Interface TTSEngineManager

All Superinterfaces:

ModuleService

public interface TTSEngineManager
extends ModuleService

The TTSEngineManager is exposed as a module service in order to permit modules to register new engines, and modules to utilize TTS when available.

Method Summary

Modifier and Type	Method and Description
TTSTalker	getTalkerFor(TTSVoiceDescriptor voice) Returns a TTSTalker, which can be used to render audio, for the specified voice.
java.util.List<TTSVoiceDescriptor>	getVoices() Returns a list of the available voices.
void	registerTTSEngine(TTSEngineDescriptor descriptor) Registers a new TTS engine.
void	unregisterTTSEngine(java.lang.String id) Removes a previously registered engine.

Method Detail

registerTTSEngine

void registerTTSEngine(TTSEngineDescriptor descriptor)

Registers a new TTS engine. The descriptor provides information about the engine, but also holds an instance of it. Note that the engine must already be initialized, the TTSEngineManager won't call initialize().

Parameters:

descriptor -

unregisterTTSEngine

void unregisterTTSEngine(java.lang.String id)

Removes a previously registered engine.

Parameters:

id -

getVoices

java.util.List<TTSVoiceDescriptor> getVoices()

Returns a list of the available voices. Returns an empty list if no tts engines are registered.

Returns:

getTalkerFor

TTSTalker getTalkerFor(TTSVoiceDescriptor voice)

Returns a TTSTalker, which can be used to render audio, for the specified voice. If the specified voice isn't available, it will try to find the best backup. Otherwise, it will return null.

Parameters:

voice -

Returns:

the best match voice, for the specified description. Returns null if no voice is available for the specified language.