Package org.openhab.core.voice.tts

Class AbstractCachedTTSService

java.lang.Object

org.openhab.core.voice.tts.AbstractCachedTTSService

All Implemented Interfaces:

CachedTTSService, TTSService

@NonNullByDefault
public abstract class AbstractCachedTTSService
extends Object
implements CachedTTSService

Implements cache functionality for the TTS service extending this class.

Author:

Gwendal Roulleau - Initial contribution

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractCachedTTSService(TTSCache ttsCache)

Method Summary

Modifier and Type	Method	Description
String	getCacheKey(String text, Voice voice, AudioFormat requestedFormat)	Construct a uniquely identifying string for the request.
AudioStream	synthesize(String text, Voice voice, AudioFormat requestedFormat)	Returns an AudioStream containing the TTS results.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.openhab.core.voice.tts.CachedTTSService

synthesizeForCache

Methods inherited from interface org.openhab.core.voice.tts.TTSService

getAvailableVoices, getId, getLabel, getSupportedFormats

Constructor Details

AbstractCachedTTSService

protected AbstractCachedTTSService(TTSCache ttsCache)

Method Details

synthesize

public AudioStream synthesize(String text,
 Voice voice,
 AudioFormat requestedFormat)
                       throws TTSException

Description copied from interface: TTSService

Returns an AudioStream containing the TTS results.

Upon requesting an unsupported Voice or AudioFormat, a TTSException is thrown.

Specified by:

synthesize in interface TTSService

Parameters:

text - The text to convert to speech

voice - The voice to use for speech

requestedFormat - The audio format to return the results in

Returns:

AudioStream containing the TTS results

Throws:

TTSException - If voice and/or requestedFormat are not supported or another error occurs while creating an AudioStream.

getCacheKey

public String getCacheKey(String text,
 Voice voice,
 AudioFormat requestedFormat)

Description copied from interface: CachedTTSService

Construct a uniquely identifying string for the request. Could be overridden by the TTS service if it uses some unique external parameter and wants to identify variability in the cache.

Specified by:

getCacheKey in interface CachedTTSService

Parameters:

text - The text to convert to speech

voice - The voice to use for speech

requestedFormat - The audio format to return the results in

Returns:

A likely unique key identifying the combination of parameters and/or internal state, as a string suitable to be part of a filename. This will be used in the cache system to store the result.