com.amazon.speech.speechlet.interfaces.audioplayer

Interface AudioPlayer

public interface AudioPlayer

The interface for interacting with the Audio Player on Alexa-enabled devices. The Audio Player allows long form audio, such as music and podcasts, to be played.

Method Summary

Modifier and Type	Method and Description
SpeechletResponse	onPlaybackFailed(SpeechletRequestEnvelope<PlaybackFailedRequest> requestEnvelope) Entry point for handling an AudioPlayer failure event.
SpeechletResponse	onPlaybackFinished(SpeechletRequestEnvelope<PlaybackFinishedRequest> requestEnvelope) Entry point for handling an AudioPlayer playback finished event.
SpeechletResponse	onPlaybackNearlyFinished(SpeechletRequestEnvelope<PlaybackNearlyFinishedRequest> requestEnvelope) Entry point for handling an AudioPlayer playback nearly finished event.
SpeechletResponse	onPlaybackStarted(SpeechletRequestEnvelope<PlaybackStartedRequest> requestEnvelope) Entry point for handling an AudioPlayer playback started event.
SpeechletResponse	onPlaybackStopped(SpeechletRequestEnvelope<PlaybackStoppedRequest> requestEnvelope) Entry point for handling an AudioPlayer playback stopped event.

Method Detail

onPlaybackFailed

SpeechletResponse onPlaybackFailed(SpeechletRequestEnvelope<PlaybackFailedRequest> requestEnvelope)

Entry point for handling an AudioPlayer failure event. This occurs when an audio item fails to play on device.

Parameters:

requestEnvelope - the request envelope containing the playback failed request to handle

Returns:

the response to the request. The response can only include AudioPlayer directives.

onPlaybackFinished

SpeechletResponse onPlaybackFinished(SpeechletRequestEnvelope<PlaybackFinishedRequest> requestEnvelope)

Entry point for handling an AudioPlayer playback finished event. This occurs when an audio item has finished playing on device.

Parameters:

requestEnvelope - the request envelope containing the playback finished request to handle

Returns:

the response to the request. The response can only include the following AudioPlayer directives: ClearQueueDirective and StopDirective

onPlaybackNearlyFinished

SpeechletResponse onPlaybackNearlyFinished(SpeechletRequestEnvelope<PlaybackNearlyFinishedRequest> requestEnvelope)

Entry point for handling an AudioPlayer playback nearly finished event. This occurs when an audio item has nearly finished playing on device. This is usually an occasion to enqueue the next audio item.

Parameters:

requestEnvelope - the request envelope containing the playback nearly failed request to handle

Returns:

the response to the request. The response can only include AudioPlayer directives.

onPlaybackStarted

SpeechletResponse onPlaybackStarted(SpeechletRequestEnvelope<PlaybackStartedRequest> requestEnvelope)

Entry point for handling an AudioPlayer playback started event. This occurs when an audio item has begun playing on device.

Parameters:

requestEnvelope - the request envelope containing the playback nearly failed request to handle

Returns:

the response to the request. The response can only include the following AudioPlayer directives: ClearQueueDirective and StopDirective

onPlaybackStopped

SpeechletResponse onPlaybackStopped(SpeechletRequestEnvelope<PlaybackStoppedRequest> requestEnvelope)

Entry point for handling an AudioPlayer playback stopped event. This occurs when the AudioPlayer has gone from a playing state to a stopped state.

Parameters:

requestEnvelope - the request envelope containing the playback nearly failed request to handle

Returns:

the response to the request. The contents of the response is currently ignored, but remains here for forward compatibility reasons.