com.amazon.speech.speechlet.interfaces.audioplayer

Class CurrentPlaybackState

java.lang.Object

com.amazon.speech.speechlet.interfaces.audioplayer.CurrentPlaybackState

public class CurrentPlaybackState
extends Object

Represents the current playback state of the device in a PlaybackFailedRequest, which may involve a different AudioItem than the one that generated the failure.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CurrentPlaybackState.Builder Builder used to construct a new CurrentPlaybackState.

Method Summary

Modifier and Type	Method and Description
static CurrentPlaybackState.Builder	builder() Returns a new builder instance used to construct a new CurrentPlaybackState.
Long	getOffsetInMilliseconds() Returns the offset in milliseconds of the AudioItem from the start of its stream, or null if there is either no item or the item belongs to a different skill.
PlayerActivity	getPlayerActivity() Returns the player activity
String	getToken() Returns the token that was passed down with the Play directive for the current AudioItem, or null if there is either no item or if the item belongs to a different skill.

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static CurrentPlaybackState.Builder builder()

Returns a new builder instance used to construct a new CurrentPlaybackState.

Returns:

the builder

getOffsetInMilliseconds

public Long getOffsetInMilliseconds()

Returns the offset in milliseconds of the AudioItem from the start of its stream, or null if there is either no item or the item belongs to a different skill.

Returns:

the offset in milliseconds of the current audio, if available, or null if not

getPlayerActivity

public PlayerActivity getPlayerActivity()

Returns the player activity

Returns:

the player activity

getToken

public String getToken()

Returns the token that was passed down with the Play directive for the current AudioItem, or null if there is either no item or if the item belongs to a different skill. The token is an arbitrary value set by the skill that can be used for identification.

Returns:

the token, if available, or null if not