com.amazon.speech.speechlet.interfaces.audioplayer

Class Stream

java.lang.Object

com.amazon.speech.speechlet.interfaces.audioplayer.Stream

public class Stream
extends Object

Represents a stream for an AudioItem.

Constructor Summary

Constructors

Constructor and Description
Stream()

Method Summary

Modifier and Type	Method and Description
String	getExpectedPreviousToken() Returns the expected previous token, or null if not present.
long	getOffsetInMilliseconds() Returns the offset in milliseconds from the start of the stream
String	getToken() Returns the token associated with the Stream.
String	getUrl() Returns the URL for the stream.
void	setExpectedPreviousToken(String expectedPreviousToken) This property is required to be set and allowed only when the playBehavior is ENQUEUE.
void	setOffsetInMilliseconds(long offsetInMilliseconds) Set the offset in milliseconds from the start of the stream
void	setToken(String token) Sets the token associated with the Stream.
void	setUrl(String url) Sets the URL of the stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

Stream

public Stream()

Method Detail

getExpectedPreviousToken

public String getExpectedPreviousToken()

Returns the expected previous token, or null if not present. If present, the Play directive will only execute if it matches the token of the active stream on the device.

Returns:

the expected previous token

setExpectedPreviousToken

public void setExpectedPreviousToken(String expectedPreviousToken)

This property is required to be set and allowed only when the playBehavior is ENQUEUE. Setting this property when playBehavior is any other value ( REPLACE_ALL or REPLACE_ENQUEUED) causes an error.

Parameters:

expectedPreviousToken - an opaque token that represents the expected previous stream.

See Also:

getExpectedPreviousToken()

getToken

public String getToken()

Returns the token associated with the Stream. The token is an arbitrary string that may be used for identification purposes.

Returns:

the token associated with the Stream

See Also:

setExpectedPreviousToken(String)

setToken

public void setToken(String token)

Sets the token associated with the Stream.

Parameters:

token - the token to set

See Also:

getToken()

getUrl

public String getUrl()

Returns the URL for the stream.

Returns:

the URL for the stream

setUrl

public void setUrl(String url)

Sets the URL of the stream.

Parameters:

url - the URL of the stream

getOffsetInMilliseconds

public long getOffsetInMilliseconds()

Returns the offset in milliseconds from the start of the stream

Returns:

the offset in milliseconds from the start of the stream

setOffsetInMilliseconds

public void setOffsetInMilliseconds(long offsetInMilliseconds)

Set the offset in milliseconds from the start of the stream

Parameters:

offsetInMilliseconds - the offset in milliseconds from the start of the stream