io.spokestack.spokestack.tts

Class SpokestackTTSOutput

java.lang.Object

io.spokestack.spokestack.tts.TTSComponent

io.spokestack.spokestack.SpeechOutput

io.spokestack.spokestack.tts.SpokestackTTSOutput

All Implemented Interfaces:

android.media.AudioManager.OnAudioFocusChangeListener, com.google.android.exoplayer2.Player.EventListener, TTSListener, AutoCloseable

public class SpokestackTTSOutput
extends SpeechOutput
implements com.google.android.exoplayer2.Player.EventListener, android.media.AudioManager.OnAudioFocusChangeListener

Audio player component for the TTS subsystem.

The Spokestack audio player uses ExoPlayer to handle automatic playback of TTS responses. Note that it does not provide a UI. It is designed to be used within a TTS subsystem controlled by a TTSManager in an app that wants to delegate all media management to Spokestack; if fine control over playback is desired, consider adding a TTSListener to the TTSManager and managing audio via its methods.

Additionally, this component requires an Android Context to be attached to the manager that has created it. If the manager is meant to persist across different Activitys, the Context used must either be the application context, or it must be re-set on the manager when the Activity context changes.

Constructor Summary

Constructors

Constructor and Description
SpokestackTTSOutput(SpeechConfig config) Creates a new audio output component.

Method Summary

Modifier and Type	Method and Description
void	audioReceived(AudioResponse response) Notifies the component that audio is available for immediate playback or caching at the specified location.
void	close()
com.google.android.exoplayer2.ExoPlayer	getMediaPlayer() Gets the current media player instance.
void	onAudioFocusChange(int focusChange)
void	onIsPlayingChanged(boolean isPlaying)
void	onPlayerError(com.google.android.exoplayer2.ExoPlaybackException error)
void	pauseContent() Pause playback of any current content, storing the player's state internally for later resumption.
void	playContent() Start or resume playback of any TTS responses.
void	prepare() Establish the media player and allocate its internal resources.
void	setAndroidContext(android.content.Context androidContext) Sets the output's Android context.
void	stopPlayback() Stops playback of any currently playing and queued synthesis results and clears the play queue.

Methods inherited from class io.spokestack.spokestack.SpeechOutput

eventReceived

Methods inherited from class io.spokestack.spokestack.tts.TTSComponent

addListener, dispatch, removeListener

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.android.exoplayer2.Player.EventListener

onLoadingChanged, onPlaybackParametersChanged, onPlaybackSuppressionReasonChanged, onPlayerStateChanged, onPositionDiscontinuity, onRepeatModeChanged, onSeekProcessed, onShuffleModeEnabledChanged, onTimelineChanged, onTimelineChanged, onTracksChanged

Constructor Detail

SpokestackTTSOutput

public SpokestackTTSOutput(SpeechConfig config)

Creates a new audio output component.

Parameters:

config - A configuration object. This class does not require any configuration properties, but this constructor is required for participation in the TTS subsystem.

Method Detail

setAndroidContext

public void setAndroidContext(@NonNull
                              android.content.Context androidContext)

Description copied from class: SpeechOutput

Sets the output's Android context.

Specified by:

setAndroidContext in class SpeechOutput

Parameters:

androidContext - The Android context.

getMediaPlayer

@Nullable
public com.google.android.exoplayer2.ExoPlayer getMediaPlayer()

Gets the current media player instance.

Returns:

The media player being used to play TTS audio.

prepare

public void prepare()

Establish the media player and allocate its internal resources.

close

public void close()

Specified by:

close in interface AutoCloseable

audioReceived

public void audioReceived(AudioResponse response)

Description copied from class: SpeechOutput

Notifies the component that audio is available for immediate playback or caching at the specified location.

Specified by:

audioReceived in class SpeechOutput

Parameters:

response - The TTS response containing the URI of the synthesized audio.

stopPlayback

public void stopPlayback()

Description copied from class: SpeechOutput

Stops playback of any currently playing and queued synthesis results and clears the play queue.

Specified by:

stopPlayback in class SpeechOutput

onIsPlayingChanged

public void onIsPlayingChanged(boolean isPlaying)

Specified by:

onIsPlayingChanged in interface com.google.android.exoplayer2.Player.EventListener

onPlayerError

public void onPlayerError(@NotNull
                          com.google.android.exoplayer2.ExoPlaybackException error)

Specified by:

onPlayerError in interface com.google.android.exoplayer2.Player.EventListener

onAudioFocusChange

public void onAudioFocusChange(int focusChange)

Specified by:

onAudioFocusChange in interface android.media.AudioManager.OnAudioFocusChangeListener

playContent

public void playContent()

Start or resume playback of any TTS responses.

pauseContent

public void pauseContent()

Pause playback of any current content, storing the player's state internally for later resumption.