io.spokestack.spokestack.tts

Class TTSCallback

java.lang.Object

io.spokestack.spokestack.tts.TTSCallback

All Implemented Interfaces:

okhttp3.Callback

public abstract class TTSCallback
extends Object
implements okhttp3.Callback

An interface used to receive playback URLs asynchronously from the Spokestack TTS service.

Constructor Summary

Constructors

Constructor and Description
TTSCallback()

Method Summary

Modifier and Type	Method and Description
protected AudioResponse	createAudioResponse(SpokestackSynthesisResponse response, String requestId) Use data in the HTTP response to create an AudioResponse.
abstract void	onError(String message) Communicates an error during synthesis.
void	onFailure(okhttp3.Call call, IOException e)
void	onResponse(okhttp3.Call call, okhttp3.Response httpResponse)
abstract void	onSynthesisResponse(AudioResponse response) Delivers an audio response, including the URL where synthesized speech can be streamed.

Methods inherited from class java.lang.Object

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

Constructor Detail

TTSCallback

public TTSCallback()

Method Detail

onFailure

public void onFailure(@NonNull
                      okhttp3.Call call,
                      IOException e)

Specified by:

onFailure in interface okhttp3.Callback

onResponse

public void onResponse(@NonNull
                       okhttp3.Call call,
                       okhttp3.Response httpResponse)
                throws IOException

Specified by:

onResponse in interface okhttp3.Callback

Throws:

IOException

createAudioResponse

protected AudioResponse createAudioResponse(@NonNull
                                            SpokestackSynthesisResponse response,
                                            @Nullable
                                            String requestId)

Use data in the HTTP response to create an AudioResponse.

Parameters:

response - The parsed response object with a valid URL.

requestId - The request ID from the response header. May be null.

Returns:

An AudioResponse containing the URI where synthesized audio is available and any additional metadata.

onError

public abstract void onError(String message)

Communicates an error during synthesis.

Parameters:

message - The error message to be delivered.

onSynthesisResponse

public abstract void onSynthesisResponse(AudioResponse response)

Delivers an audio response, including the URL where synthesized speech can be streamed.

Spokestack audio URLS must be accessed within 30 seconds; after that, the stream will not be playable.

Parameters:

response - An AudioResponse containing the URL from which synthesized audio can be streamed and other relevant metadata, including the request ID if one was supplied.