org.daisy.pipeline.tts

Interface TTSService

public interface TTSService

Classes that implements the TTSService interface are meant to be allocated only once, as opposed to TTSEngines. The main role of TTSService is to allocate TTSEngines depending on given parameters.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TTSService.ServiceDisabledException
static class	TTSService.SynthesisException

Method Summary

Modifier and Type	Method and Description
default String	getDisplayName()
String	getName()
TTSEngine	newEngine(Map<String,String> params) Allocate a new TTSEngine

Method Detail

newEngine

TTSEngine newEngine(Map<String,String> params)
             throws TTSService.ServiceDisabledException,
                    Throwable

Allocate a new TTSEngine

Parameters:

params - contains various key-value pairs. Some of them might be options for the TTS processor under consideration, e.g. server IPs, priorities or sound quality. It can also contain options which have nothing to do with the returned TTSEngine. Such options must be ignored. This method is allowed to perform heavy initializations as long as they can be interrupted with the regular Java thread interruption mechanism. In particular, it is not recommended to test a full text-to-speech step in this method.

Throws:

TTSService.ServiceDisabledException - if the service is not available, e.g. because it was disabled by the user, or because required configuration is missing.

Throwable - if an engine could not be allocated for another reason.

getName

String getName()

Returns:

the same name as in the CSS voice-family property. If several TTS services share the same name, then the one with the highest priority will be chosen. Must be thread-safe.

getDisplayName

default String getDisplayName()

Returns:

a nice name for displaying in user interfaces.