org.digitalmediaserver.cast

Class Session

java.lang.Object

org.digitalmediaserver.cast.Session

@ThreadSafe
public class Session
extends Object

This class represents a "session" or "virtual connection" with a "remote application" running on a cast device.

When a connection is established with a cast device, communication is only possible with the "device itself", offering only a very limited interaction. To make the cast device "do anything", an application must be running (which can be launched with a command to the device), and a "connection within the connection" must be made to communicate with the specific remote application. A Session encapsulates this "inner connection".

Author:

Nadahar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Session.SessionClosedListener An interface defining a callback which is invoked when a Session is closed.

Field Summary

Fields

Modifier and Type	Field and Description
protected Channel	channel The Channel used by this Session
protected String	destinationId The destination ID used by this Session
protected String	id The session ID used by this Session
protected Session.SessionClosedListener	listener The listener to invoke if the session is closed
protected Object	listenerLock The synchronization object used to protect listener
protected String	sourceId The source ID used by this Session

Constructor Summary

Constructors

Constructor and Description
Session(String sourceId, String sessionId, String destinationId, Channel channel) Creates a new instance using the specified parameters.

Method Summary

Modifier and Type	Method and Description
boolean	close() Closes this Session.
String	getDestinationId()
String	getId()
MediaStatus	getMediaStatus() Requests an updated MediaStatus from the remote application.
MediaStatus	getMediaStatus(long responseTimeout) Requests an updated MediaStatus from the remote application.
Session.SessionClosedListener	getSessionClosedListener()
String	getSourceId()
boolean	isClosed()
MediaStatus	load(Media.MediaBuilder mediaBuilder, Boolean autoplay, Double currentTime, boolean synchronous) Asks the remote application to load the resulting Media created from the specified Media.MediaBuilder using the specified parameters and Channel.DEFAULT_RESPONSE_TIMEOUT as the timeout value.
MediaStatus	load(Media.MediaBuilder mediaBuilder, Boolean autoplay, Double currentTime, boolean synchronous, long responseTimeout) Asks the remote application to load the resulting Media created from the specified Media.MediaBuilder using the specified parameters.
MediaStatus	load(Media media, Boolean autoplay, Double currentTime, boolean synchronous) Asks the remote application to load the specified Media using the specified parameters and Channel.DEFAULT_RESPONSE_TIMEOUT as the timeout value.
MediaStatus	load(Media media, Boolean autoplay, Double currentTime, boolean synchronous, long responseTimeout) Asks the remote application to load the specified Media using the specified parameters.
MediaStatus	load(Media media, List<Integer> activeTrackIds, Boolean autoplay, Double currentTime, Double playbackRate, boolean synchronous) Asks the remote application to load the specified Media using the specified parameters.
MediaStatus	load(Media media, List<Integer> activeTrackIds, Boolean autoplay, Double currentTime, Double playbackRate, boolean synchronous, long responseTimeout) Asks the remote application to load the specified Media using the specified parameters and Channel.DEFAULT_RESPONSE_TIMEOUT as the timeout value.
MediaStatus	load(Media media, List<Integer> activeTrackIds, Boolean autoplay, String credentials, String credentialsType, Double currentTime, Map<String,Object> customData, LoadOptions loadOptions, Double playbackRate, QueueData queueData, boolean synchronous) Asks the remote application to load the specified Media or QueueDatas using the specified parameters, using Channel.DEFAULT_RESPONSE_TIMEOUT as the timeout value.
MediaStatus	load(Media media, List<Integer> activeTrackIds, Boolean autoplay, String credentials, String credentialsType, Double currentTime, Map<String,Object> customData, LoadOptions loadOptions, Double playbackRate, QueueData queueData, boolean synchronous, long responseTimeout) Asks the remote application to load the specified Media or QueueDatas using the specified parameters.
MediaStatus	load(StandardRequest.Load loadRequest, boolean synchronous) Asks the remote application to execute the specified StandardRequest.Load request, using Channel.DEFAULT_RESPONSE_TIMEOUT as the timeout value.
MediaStatus	load(StandardRequest.Load loadRequest, boolean synchronous, long responseTimeout) Asks the remote application to execute the specified StandardRequest.Load request.
MediaStatus	pause(int mediaSessionId, boolean synchronous) Asks the remote application to pause playback of the media referenced by the specified media session ID, using Channel.DEFAULT_RESPONSE_TIMEOUT as the timeout value.
MediaStatus	pause(int mediaSessionId, boolean synchronous, long responseTimeout) Asks the remote application to pause playback of the media referenced by the specified media session ID.
MediaStatus	play(int mediaSessionId, boolean synchronous) Asks the remote application to start playing the media referenced by the specified media session ID, using Channel.DEFAULT_RESPONSE_TIMEOUT as the timeout value.
MediaStatus	play(int mediaSessionId, boolean synchronous, long responseTimeout) Asks the remote application to start playing the media referenced by the specified media session ID.
MediaStatus	seek(int mediaSessionId, double currentTime, StandardRequest.ResumeState resumeState, boolean synchronous) Asks the remote application to move the playback position of the media referenced by the specified media session ID to the specified position, using Channel.DEFAULT_RESPONSE_TIMEOUT as the timeout value.
MediaStatus	seek(int mediaSessionId, double currentTime, StandardRequest.ResumeState resumeState, boolean synchronous, long responseTimeout) Asks the remote application to move the playback position of the media referenced by the specified media session ID to the specified position.
<T extends Response> T	sendGenericRequest(String namespace, Request request, Class<T> responseClass) Sends the specified Request with the specified namespace using this Session.
void	setSessionClosedListener(Session.SessionClosedListener listener) Sets the listener that is to be invoked if the session is closed.
MediaStatus	setVolume(int mediaSessionId, MediaVolume volume, boolean synchronous) Asks the remote application to change the volume level or mute state of the stream of the specified media session.
MediaStatus	stop(int mediaSessionId, boolean synchronous) Asks the remote application to stop playback and unload the media referenced by the specified media session ID, using Channel.DEFAULT_RESPONSE_TIMEOUT as the timeout value.
MediaStatus	stop(int mediaSessionId, boolean synchronous, long responseTimeout) Asks the remote application to stop playback and unload the media referenced by the specified media session ID.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

sourceId

@Nonnull
protected final String sourceId

The source ID used by this Session

id

@Nonnull
protected final String id

The session ID used by this Session

destinationId

@Nonnull
protected final String destinationId

The destination ID used by this Session

channel

@Nonnull
protected final Channel channel

The Channel used by this Session

listenerLock

@Nonnull
protected final Object listenerLock

The synchronization object used to protect listener

listener

@Nullable
protected Session.SessionClosedListener listener

The listener to invoke if the session is closed

Constructor Detail

Session

public Session(@Nonnull
               String sourceId,
               @Nonnull
               String sessionId,
               @Nonnull
               String destinationId,
               @Nonnull
               Channel channel)

Creates a new instance using the specified parameters.

Parameters:

sourceId - the source ID to use.

sessionId - the session ID to use.

destinationId - the destination ID to use.

channel - the Channel to use.

Method Detail

getSourceId

@Nonnull
public String getSourceId()

Returns:

The source ID used by this Session.

getId

@Nonnull
public String getId()

Returns:

The session ID used by this Session.

getDestinationId

@Nonnull
public String getDestinationId()

Returns:

The destination ID used by this Session.

isClosed

public boolean isClosed()

Returns:

true if this Session is closed, false otherwise.

close

public boolean close()
              throws IOException

Closes this Session.

Returns:

true if this Session was closed, false if it already was.

Throws:

IOException - If an error occurs during the operation.

getSessionClosedListener

@Nullable
public Session.SessionClosedListener getSessionClosedListener()

Returns:

The listener that is invoked if the session is closed, if any.

setSessionClosedListener

public void setSessionClosedListener(@Nullable
                                     Session.SessionClosedListener listener)

Sets the listener that is to be invoked if the session is closed.

Parameters:

listener - The Session.SessionClosedListener implementation to invoke.

load

@Nullable
public MediaStatus load(@Nonnull
                                   StandardRequest.Load loadRequest,
                                   boolean synchronous)
                            throws IOException

Asks the remote application to execute the specified StandardRequest.Load request, using Channel.DEFAULT_RESPONSE_TIMEOUT as the timeout value.

This can only succeed if the remote application supports the "urn:x-cast:com.google.cast.media" namespace.

Parameters:

loadRequest - the StandardRequest.Load request to send.

synchronous - true to make this call block until a response is received or times out, false to make it return immediately always returning null.

Returns:

The resulting MediaStatus if synchronous is true and a reply is received in time, null if synchronous is false.

Throws:

IllegalArgumentException - If session or loadRequest is null.

IOException - If the response times out or an error occurs during the operation.

load

@Nullable
public MediaStatus load(@Nonnull
                                   StandardRequest.Load loadRequest,
                                   boolean synchronous,
                                   long responseTimeout)
                            throws IOException

Asks the remote application to execute the specified StandardRequest.Load request.

This can only succeed if the remote application supports the "urn:x-cast:com.google.cast.media" namespace.

Parameters:

loadRequest - the StandardRequest.Load request to send.

synchronous - true to make this call block until a response is received or times out, false to make it return immediately always returning null.

responseTimeout - the response timeout in milliseconds if synchronous is true. If zero or negative, will be used.

Returns:

The resulting MediaStatus if synchronous is true and a reply is received in time, null if synchronous is false.

Throws:

IllegalArgumentException - If session or loadRequest is null.

IOException - If the response times out or an error occurs during the operation.

load

@Nullable
public MediaStatus load(@Nonnull
                                   Media.MediaBuilder mediaBuilder,
                                   @Nullable
                                   Boolean autoplay,
                                   @Nullable
                                   Double currentTime,
                                   boolean synchronous)
                            throws IOException

Asks the remote application to load the resulting Media created from the specified Media.MediaBuilder using the specified parameters and Channel.DEFAULT_RESPONSE_TIMEOUT as the timeout value.

This can only succeed if the remote application supports the "urn:x-cast:com.google.cast.media" namespace.

Parameters:

mediaBuilder - the Media.MediaBuilder to use to create the Media to load.

autoplay - true to ask the remote application to start playback as soon as the Media has been loaded, false to ask it to transition to a paused state after loading.

currentTime - the position in seconds where playback are to be started in the loaded Media.

synchronous - true to make this call blocking until a response is received or times out, false to make it return immediately always returning null.

Returns:

The resulting MediaStatus if synchronous is true and a reply is received in time, null if synchronous is false.

Throws:

IllegalArgumentException - If mediaBuilder is null.

IOException - If the response times out or an error occurs during the operation.

load

@Nullable
public MediaStatus load(@Nonnull
                                   Media.MediaBuilder mediaBuilder,
                                   @Nullable
                                   Boolean autoplay,
                                   @Nullable
                                   Double currentTime,
                                   boolean synchronous,
                                   long responseTimeout)
                            throws IOException

Asks the remote application to load the resulting Media created from the specified Media.MediaBuilder using the specified parameters.

This can only succeed if the remote application supports the "urn:x-cast:com.google.cast.media" namespace.

Parameters:

mediaBuilder - the Media.MediaBuilder to use to create the Media to load.

autoplay - true to ask the remote application to start playback as soon as the Media has been loaded, false to ask it to transition to a paused state after loading.

currentTime - the position in seconds where playback are to be started in the loaded Media.

synchronous - true to make this call blocking until a response is received or times out, false to make it return immediately always returning null.

responseTimeout - the response timeout in milliseconds if synchronous is true. If zero or negative, will be used.

Returns:

The resulting MediaStatus if synchronous is true and a reply is received in time, null if synchronous is false.

Throws:

IllegalArgumentException - If mediaBuilder is null.

IOException - If the response times out or an error occurs during the operation.

load

@Nullable
public MediaStatus load(@Nonnull
                                   Media media,
                                   @Nullable
                                   Boolean autoplay,
                                   @Nullable
                                   Double currentTime,
                                   boolean synchronous)
                            throws IOException

Asks the remote application to load the specified Media using the specified parameters and Channel.DEFAULT_RESPONSE_TIMEOUT as the timeout value.

This can only succeed if the remote application supports the "urn:x-cast:com.google.cast.media" namespace.

Parameters:

media - the Media to load.

autoplay - true to ask the remote application to start playback as soon as the Media has been loaded, false to ask it to transition to a paused state after loading.

currentTime - the position in seconds where playback are to be started in the loaded Media.

synchronous - true to make this call block until a response is received or times out, false to make it return immediately always returning null.

Returns:

The resulting MediaStatus if synchronous is true and a reply is received in time, null if synchronous is false.

Throws:

IllegalArgumentException - If media is null.

IOException - If the response times out or an error occurs during the operation.

load

@Nullable
public MediaStatus load(@Nonnull
                                   Media media,
                                   @Nullable
                                   Boolean autoplay,
                                   @Nullable
                                   Double currentTime,
                                   boolean synchronous,
                                   long responseTimeout)
                            throws IOException

Asks the remote application to load the specified Media using the specified parameters.

This can only succeed if the remote application supports the "urn:x-cast:com.google.cast.media" namespace.

Parameters:

media - the Media to load.

autoplay - true to ask the remote application to start playback as soon as the Media has been loaded, false to ask it to transition to a paused state after loading.

currentTime - the position in seconds where playback are to be started in the loaded Media.

synchronous - true to make this call block until a response is received or times out, false to make it return immediately always returning null.

responseTimeout - the response timeout in milliseconds if synchronous is true. If zero or negative, will be used.

Returns:

The resulting MediaStatus if synchronous is true and a reply is received in time, null if synchronous is false.

Throws:

IllegalArgumentException - If session or media is null.

IOException - If the response times out or an error occurs during the operation.

load

@Nullable
public MediaStatus load(@Nonnull
                                   Media media,
                                   @Nullable
                                   List<Integer> activeTrackIds,
                                   @Nullable
                                   Boolean autoplay,
                                   @Nullable
                                   Double currentTime,
                                   @Nullable
                                   Double playbackRate,
                                   boolean synchronous)
                            throws IOException

Asks the remote application to load the specified Media using the specified parameters.

This can only succeed if the remote application supports the "urn:x-cast:com.google.cast.media" namespace.

Parameters:

media - the Media to load.

activeTrackIds - the List of track IDs that are active. If the list is not provided, the default tracks will be active.

autoplay - true to ask the remote application to start playback as soon as the Media has been loaded, false to ask it to transition to a paused state after loading.

currentTime - the position in seconds from the start for where playback is to start in the loaded Media. If the content is live content, and currentTime is not specified, the stream will start at the live position.

playbackRate - the media playback rate.

synchronous - true to make this call block until a response is received or times out, false to make it return immediately always returning null.

Returns:

The resulting MediaStatus if synchronous is true and a reply is received in time, null if synchronous is false.

Throws:

IllegalArgumentException - If media is null.

IOException - If the response times out or an error occurs during the operation.

load

@Nullable
public MediaStatus load(@Nonnull
                                   Media media,
                                   @Nullable
                                   List<Integer> activeTrackIds,
                                   @Nullable
                                   Boolean autoplay,
                                   @Nullable
                                   Double currentTime,
                                   @Nullable
                                   Double playbackRate,
                                   boolean synchronous,
                                   long responseTimeout)
                            throws IOException

Asks the remote application to load the specified Media using the specified parameters and Channel.DEFAULT_RESPONSE_TIMEOUT as the timeout value.

This can only succeed if the remote application supports the "urn:x-cast:com.google.cast.media" namespace.

Parameters:

media - the Media to load.

activeTrackIds - the List of track IDs that are active. If the list is not provided, the default tracks will be active.

autoplay - true to ask the remote application to start playback as soon as the Media has been loaded, false to ask it to transition to a paused state after loading.

currentTime - the position in seconds from the start for where playback is to start in the loaded Media. If the content is live content, and currentTime is not specified, the stream will start at the live position.

playbackRate - the media playback rate.

synchronous - true to make this call block until a response is received or times out, false to make it return immediately always returning null.

responseTimeout - the response timeout in milliseconds if synchronous is true. If zero or negative, will be used.

Returns:

The resulting MediaStatus if synchronous is true and a reply is received in time, null if synchronous is false.

Throws:

IllegalArgumentException - If media is null.

IOException - If the response times out or an error occurs during the operation.

load

@Nullable
public MediaStatus load(@Nonnull
                                   Media media,
                                   @Nullable
                                   List<Integer> activeTrackIds,
                                   @Nullable
                                   Boolean autoplay,
                                   @Nullable
                                   String credentials,
                                   @Nullable
                                   String credentialsType,
                                   @Nullable
                                   Double currentTime,
                                   @Nullable
                                   Map<String,Object> customData,
                                   @Nullable
                                   LoadOptions loadOptions,
                                   @Nullable
                                   Double playbackRate,
                                   @Nullable
                                   QueueData queueData,
                                   boolean synchronous)
                            throws IOException

Asks the remote application to load the specified Media or QueueDatas using the specified parameters, using Channel.DEFAULT_RESPONSE_TIMEOUT as the timeout value. Either media or queueData must be non-null.

This can only succeed if the remote application supports the "urn:x-cast:com.google.cast.media" namespace.

Parameters:

media - the Media to load.

activeTrackIds - the List of track IDs that are active. If the list is not provided, the default tracks will be active.

autoplay - true to ask the remote application to start playback as soon as the Media has been loaded, false to ask it to transition to a paused state after loading.

credentials - the user credentials, if any.

credentialsType - the credentials type, if any. The type 'cloud' is a reserved type used by load requests that were originated by voice assistant commands.

currentTime - the position in seconds from the start for where playback is to start in the loaded Media. If the content is live content, and currentTime is not specified, the stream will start at the live position.

customData - the custom application data to send to the remote application with the load command.

loadOptions - the additional load options, if any.

playbackRate - the media playback rate.

queueData - the queue data.

synchronous - true to make this call block until a response is received or times out, false to make it return immediately always returning null.

Returns:

The resulting MediaStatus if synchronous is true and a reply is received in time, null if synchronous is false.

Throws:

IOException - If the response times out or an error occurs during the operation.

load

@Nullable
public MediaStatus load(@Nonnull
                                   Media media,
                                   @Nullable
                                   List<Integer> activeTrackIds,
                                   @Nullable
                                   Boolean autoplay,
                                   @Nullable
                                   String credentials,
                                   @Nullable
                                   String credentialsType,
                                   @Nullable
                                   Double currentTime,
                                   @Nullable
                                   Map<String,Object> customData,
                                   @Nullable
                                   LoadOptions loadOptions,
                                   @Nullable
                                   Double playbackRate,
                                   @Nullable
                                   QueueData queueData,
                                   boolean synchronous,
                                   long responseTimeout)
                            throws IOException

Asks the remote application to load the specified Media or QueueDatas using the specified parameters. Either media or queueData must be non-null.

This can only succeed if the remote application supports the "urn:x-cast:com.google.cast.media" namespace.

Parameters:

media - the Media to load.

activeTrackIds - the List of track IDs that are active. If the list is not provided, the default tracks will be active.

autoplay - true to ask the remote application to start playback as soon as the Media has been loaded, false to ask it to transition to a paused state after loading.

credentials - the user credentials, if any.

credentialsType - the credentials type, if any. The type 'cloud' is a reserved type used by load requests that were originated by voice assistant commands.

currentTime - the position in seconds from the start for where playback is to start in the loaded Media. If the content is live content, and currentTime is not specified, the stream will start at the live position.

customData - the custom application data to send to the remote application with the load command.

loadOptions - the additional load options, if any.

playbackRate - the media playback rate.

queueData - the queue data.

synchronous - true to make this call block until a response is received or times out, false to make it return immediately always returning null.

responseTimeout - the response timeout in milliseconds if synchronous is true. If zero or negative, will be used.

Returns:

The resulting MediaStatus if synchronous is true and a reply is received in time, null if synchronous is false.

Throws:

IOException - If the response times out or an error occurs during the operation.

play

@Nullable
public MediaStatus play(int mediaSessionId,
                                   boolean synchronous)
                            throws IOException

Asks the remote application to start playing the media referenced by the specified media session ID, using Channel.DEFAULT_RESPONSE_TIMEOUT as the timeout value.

This can only succeed if the remote application supports the "urn:x-cast:com.google.cast.media" namespace.

Parameters:

mediaSessionId - the media session ID for which the play request applies.

synchronous - true to make this call block until a response is received or times out, false to make it return immediately always returning null.

Returns:

The resulting MediaStatus if synchronous is true and a reply is received in time, null if synchronous is false.

Throws:

IOException - If the response times out or an error occurs during the operation.

play

@Nullable
public MediaStatus play(int mediaSessionId,
                                   boolean synchronous,
                                   long responseTimeout)
                            throws IOException

Asks the remote application to start playing the media referenced by the specified media session ID.

This can only succeed if the remote application supports the "urn:x-cast:com.google.cast.media" namespace.

Parameters:

mediaSessionId - the media session ID for which the play request applies.

synchronous - true to make this call block until a response is received or times out, false to make it return immediately always returning null.

responseTimeout - the response timeout in milliseconds if synchronous is true. If zero or negative, will be used.

Returns:

The resulting MediaStatus if synchronous is true and a reply is received in time, null if synchronous is false.

Throws:

IOException - If the response times out or an error occurs during the operation.

pause

@Nullable
public MediaStatus pause(int mediaSessionId,
                                    boolean synchronous)
                             throws IOException

Asks the remote application to pause playback of the media referenced by the specified media session ID, using Channel.DEFAULT_RESPONSE_TIMEOUT as the timeout value.

This can only succeed if the remote application supports the "urn:x-cast:com.google.cast.media" namespace.

Parameters:

mediaSessionId - the media session ID for which the pause request applies.

synchronous - true to make this call block until a response is received or times out, false to make it return immediately always returning null.

Returns:

The resulting MediaStatus if synchronous is true and a reply is received in time, null if synchronous is false.

Throws:

IOException - If the response times out or an error occurs during the operation.

pause

@Nullable
public MediaStatus pause(int mediaSessionId,
                                    boolean synchronous,
                                    long responseTimeout)
                             throws IOException

Asks the remote application to pause playback of the media referenced by the specified media session ID.

This can only succeed if the remote application supports the "urn:x-cast:com.google.cast.media" namespace.

Parameters:

mediaSessionId - the media session ID for which the pause request applies.

synchronous - true to make this call block until a response is received or times out, false to make it return immediately always returning null.

responseTimeout - the response timeout in milliseconds if synchronous is true. If zero or negative, will be used.

Returns:

The resulting MediaStatus if synchronous is true and a reply is received in time, null if synchronous is false.

Throws:

IOException - If the response times out or an error occurs during the operation.

seek

@Nullable
public MediaStatus seek(int mediaSessionId,
                                   double currentTime,
                                   @Nullable
                                   StandardRequest.ResumeState resumeState,
                                   boolean synchronous)
                            throws IOException

Asks the remote application to move the playback position of the media referenced by the specified media session ID to the specified position, using Channel.DEFAULT_RESPONSE_TIMEOUT as the timeout value.

This can only succeed if the remote application supports the "urn:x-cast:com.google.cast.media" namespace.

Parameters:

mediaSessionId - the media session ID for which the pause request applies.

currentTime - the new playback position in seconds.

resumeState - the desired media player state after the seek is complete. If null, it will retain the state it had before seeking.

synchronous - true to make this call block until a response is received or times out, false to make it return immediately always returning null.

Returns:

The resulting MediaStatus if synchronous is true and a reply is received in time, null if synchronous is false.

Throws:

IOException - If the response times out or an error occurs during the operation.

seek

@Nullable
public MediaStatus seek(int mediaSessionId,
                                   double currentTime,
                                   @Nullable
                                   StandardRequest.ResumeState resumeState,
                                   boolean synchronous,
                                   long responseTimeout)
                            throws IOException

Asks the remote application to move the playback position of the media referenced by the specified media session ID to the specified position.

This can only succeed if the remote application supports the "urn:x-cast:com.google.cast.media" namespace.

Parameters:

mediaSessionId - the media session ID for which the pause request applies.

currentTime - the new playback position in seconds.

resumeState - the desired media player state after the seek is complete. If null, it will retain the state it had before seeking.

synchronous - true to make this call block until a response is received or times out, false to make it return immediately always returning null.

responseTimeout - the response timeout in milliseconds if synchronous is true. If zero or negative, will be used.

Returns:

The resulting MediaStatus if synchronous is true and a reply is received in time, null if synchronous is false.

Throws:

IOException - If the response times out or an error occurs during the operation.

stop

@Nullable
public MediaStatus stop(int mediaSessionId,
                                   boolean synchronous)
                            throws IOException

Asks the remote application to stop playback and unload the media referenced by the specified media session ID, using Channel.DEFAULT_RESPONSE_TIMEOUT as the timeout value.

This can only succeed if the remote application supports the "urn:x-cast:com.google.cast.media" namespace.

Parameters:

mediaSessionId - the media session ID for which the MediaVolume request applies.

synchronous - true to make this call block until a response is received or times out, false to make it return immediately always returning null.

Returns:

The resulting MediaStatus if synchronous is true and a reply is received in time, null if synchronous is false.

Throws:

IOException - If the response times out or an error occurs during the operation.

stop

@Nullable
public MediaStatus stop(int mediaSessionId,
                                   boolean synchronous,
                                   long responseTimeout)
                            throws IOException

Asks the remote application to stop playback and unload the media referenced by the specified media session ID.

This can only succeed if the remote application supports the "urn:x-cast:com.google.cast.media" namespace.

Parameters:

mediaSessionId - the media session ID for which the MediaVolume request applies.

synchronous - true to make this call block until a response is received or times out, false to make it return immediately always returning null.

responseTimeout - the response timeout in milliseconds if synchronous is true. If zero or negative, will be used.

Returns:

The resulting MediaStatus if synchronous is true and a reply is received in time, null if synchronous is false.

Throws:

IOException - If the response times out or an error occurs during the operation.

setVolume

@Nullable
public MediaStatus setVolume(int mediaSessionId,
                                        @Nonnull
                                        MediaVolume volume,
                                        boolean synchronous)
                                 throws IOException

Asks the remote application to change the volume level or mute state of the stream of the specified media session. Please note that this is different from the device volume level or mute state, and that this will give the user no visual indication.

This can only succeed if the remote application supports the "urn:x-cast:com.google.cast.media" namespace.

Parameters:

mediaSessionId - the media session ID for which the MediaVolume request applies.

volume - the MediaVolume to set.

synchronous - true to make this call block until a response is received or times out, false to make it return immediately always returning null.

Returns:

The resulting MediaStatus if synchronous is true and a reply is received in time, null if synchronous is false.

Throws:

IllegalArgumentException - If volume is null.

IOException - If the response times out or an error occurs during the operation.

getMediaStatus

@Nullable
public MediaStatus getMediaStatus()
                                      throws IOException

Requests an updated MediaStatus from the remote application. This method is always blocking.

This can only succeed if the remote application supports the "urn:x-cast:com.google.cast.media" namespace.

Returns:

The resulting MediaStatus if a reply is received in time, or null if a timeout occurs.

Throws:

IOException - If an error occurs during the operation.

getMediaStatus

@Nullable
public MediaStatus getMediaStatus(long responseTimeout)
                                      throws IOException

Requests an updated MediaStatus from the remote application. This method is always blocking.

This can only succeed if the remote application supports the "urn:x-cast:com.google.cast.media" namespace.

Parameters:

responseTimeout - the response timeout in milliseconds. If zero or negative, Channel.DEFAULT_RESPONSE_TIMEOUT will be used.

Returns:

The resulting MediaStatus if a reply is received in time, or null if a timeout occurs.

Throws:

IOException - If an error occurs during the operation.

sendGenericRequest

public <T extends Response> T sendGenericRequest(String namespace,
                                                 Request request,
                                                 Class<T> responseClass)
                                          throws IOException

Sends the specified Request with the specified namespace using this Session.

Type Parameters:

T - the class of the Response object.

Parameters:

namespace - the namespace to use.

request - the Request to send.

responseClass - the response class to to block and wait for a response or null to return immediately.

Returns:

The Response if the response is received in time, or null if the responseClass is null or a timeout occurs.

Throws:

IOException - If an error occurs during the operation.

toString

public String toString()

Overrides:

toString in class Object