RemotePlaybackClient

public class RemotePlaybackClient

A helper class for playing media on remote routes using the remote playback protocol defined by MediaControlIntent.

The client maintains session state and offers a simplified interface for issuing remote playback media control intents to a single route.

Summary

Nested types

Base callback type for remote playback requests.

Callback for remote playback requests that operate on items.

A callback that will receive messages from media sessions.

Callback for remote playback requests that operate on sessions.

A callback that will receive media status updates.

Public constructors

Creates a remote playback client for a route.

Public methods
void

Sends a request to end the media playback session.
void
enqueue(
    @NonNull Uri contentUri,
    @Nullable String mimeType,
    @Nullable Bundle metadata,
    long positionMillis,
    @Nullable Bundle extras,
    @Nullable RemotePlaybackClient.ItemActionCallback callback
)

Sends a request to enqueue a media item.
@Nullable String

Gets the current session id if there is one.
void

Sends a request to get the status of the media playback session.
void
getStatus(
    @NonNull String itemId,
    @Nullable Bundle extras,
    @Nullable RemotePlaybackClient.ItemActionCallback callback
)

Sends a request to get the status of a media item.
boolean

Returns true if the client currently has a session.
boolean

Returns true if the route supports messages.
boolean

Returns true if the route supports queuing features.
boolean

Returns true if the route supports remote playback.
boolean

Returns true if the route supports session management features.
void

Sends a request to pause media playback.
void
play(
    @NonNull Uri contentUri,
    @Nullable String mimeType,
    @Nullable Bundle metadata,
    long positionMillis,
    @Nullable Bundle extras,
    @Nullable RemotePlaybackClient.ItemActionCallback callback
)

Sends a request to play a media item.
void

Releases resources owned by the client.
void
remove(
    @NonNull String itemId,
    @Nullable Bundle extras,
    @Nullable RemotePlaybackClient.ItemActionCallback callback
)

Sends a request to remove a media item from the queue.
void

Sends a request to resume (unpause) media playback.
void
seek(
    @NonNull String itemId,
    long positionMillis,
    @Nullable Bundle extras,
    @Nullable RemotePlaybackClient.ItemActionCallback callback
)

Sends a request to seek to a new position in a media item.
void

Sends a message.
void

Sets a callback that should receive messages when a message is sent from media sessions created by this instance of the remote playback client changes.
void

Sets the current session id.
void

Sets a callback that should receive status updates when the state of media sessions or media items created by this instance of the remote playback client changes.
void

Sends a request to start a new media playback session.
void

Sends a request to stop media playback and clear the media playback queue.

Public constructors

RemotePlaybackClient

Added in 1.1.0
public RemotePlaybackClient(
    @NonNull Context context,
    @NonNull MediaRouter.RouteInfo route
)

Creates a remote playback client for a route.

Parameters
@NonNull MediaRouter.RouteInfo route

The media route.

Public methods

endSession

Added in 1.1.0
public void endSession(
    @Nullable Bundle extras,
    @Nullable RemotePlaybackClient.SessionActionCallback callback
)

Sends a request to end the media playback session.

The request is issued in the current session. If this request is successful, the session id property will be set to null after the callback is invoked.

Please refer to ACTION_END_SESSION for more information about the semantics of this request.

Parameters
@Nullable Bundle extras

A bundle of extra arguments to be added to the ACTION_END_SESSION intent, or null if none.
@Nullable RemotePlaybackClient.SessionActionCallback callback

A callback to invoke when the request has been processed, or null if none.
Throws
java.lang.IllegalStateException

if there is no current session.
java.lang.UnsupportedOperationException

if the route does not support session management.
See also
ACTION_END_SESSION
isRemotePlaybackSupported
isSessionManagementSupported

enqueue

Added in 1.1.0
public void enqueue(
    @NonNull Uri contentUri,
    @Nullable String mimeType,
    @Nullable Bundle metadata,
    long positionMillis,
    @Nullable Bundle extras,
    @Nullable RemotePlaybackClient.ItemActionCallback callback
)

Sends a request to enqueue a media item.

Enqueues a new item to play. If the queue was previously paused, then will remain paused.

The request is issued in the current session. If no session is available, then one is created implicitly.

Please refer to ACTION_ENQUEUE for more information about the semantics of this request.

Parameters
@NonNull Uri contentUri

The content Uri to enqueue.
@Nullable String mimeType

The mime type of the content, or null if unknown.
@Nullable Bundle metadata

The media item metadata bundle, or null if none.
long positionMillis

The initial content position for the item in milliseconds, or 0 to start at the beginning.
@Nullable Bundle extras

A bundle of extra arguments to be added to the ACTION_ENQUEUE intent, or null if none.
@Nullable RemotePlaybackClient.ItemActionCallback callback

A callback to invoke when the request has been processed, or null if none.
Throws
java.lang.UnsupportedOperationException

if the route does not support queuing.
See also
ACTION_ENQUEUE
isRemotePlaybackSupported
isQueuingSupported

getSessionId

Added in 1.1.0
public @Nullable String getSessionId()

Gets the current session id if there is one.

Returns
@Nullable String

The current session id, or null if none.

getSessionStatus

Added in 1.1.0
public void getSessionStatus(
    @Nullable Bundle extras,
    @Nullable RemotePlaybackClient.SessionActionCallback callback
)

Sends a request to get the status of the media playback session.

The request is issued in the current session.

Please refer to ACTION_GET_SESSION_STATUS for more information about the semantics of this request.

Parameters
@Nullable Bundle extras

A bundle of extra arguments to be added to the ACTION_GET_SESSION_STATUS intent, or null if none.
@Nullable RemotePlaybackClient.SessionActionCallback callback

A callback to invoke when the request has been processed, or null if none.
Throws
java.lang.IllegalStateException

if there is no current session.
java.lang.UnsupportedOperationException

if the route does not support session management.
See also
ACTION_GET_SESSION_STATUS
isRemotePlaybackSupported
isSessionManagementSupported

getStatus

Added in 1.1.0
public void getStatus(
    @NonNull String itemId,
    @Nullable Bundle extras,
    @Nullable RemotePlaybackClient.ItemActionCallback callback
)

Sends a request to get the status of a media item.

The request is issued in the current session.

Please refer to ACTION_GET_STATUS for more information about the semantics of this request.

Parameters
@NonNull String itemId

The item id.
@Nullable Bundle extras

A bundle of extra arguments to be added to the ACTION_GET_STATUS intent, or null if none.
@Nullable RemotePlaybackClient.ItemActionCallback callback

A callback to invoke when the request has been processed, or null if none.
Throws
java.lang.IllegalStateException

if there is no current session.
See also
ACTION_GET_STATUS
isRemotePlaybackSupported

hasSession

Added in 1.1.0
public boolean hasSession()

Returns true if the client currently has a session.

Equivalent to checking whether getSessionId returns a non-null result.

Returns
boolean

True if there is a current session.

isMessagingSupported

Added in 1.1.0
public boolean isMessagingSupported()

Returns true if the route supports messages.

This method returns true if the route supports all of the basic remote playback actions and all of the following actions: start session, send message, end session.

Returns
boolean

True if session management is supported. Implies isRemotePlaybackSupported is also true.
See also
isRemotePlaybackSupported

isQueuingSupported

Added in 1.1.0
public boolean isQueuingSupported()

Returns true if the route supports queuing features.

If the route does not support queuing, then at most one media item can be played at a time and the enqueue method will not be available.

This method returns true if the route supports all of the basic remote playback actions and all of the following actions: enqueue, remove.

Returns
boolean

True if queuing is supported. Implies isRemotePlaybackSupported is also true.
See also
isRemotePlaybackSupported

isRemotePlaybackSupported

Added in 1.1.0
public boolean isRemotePlaybackSupported()

Returns true if the route supports remote playback.

If the route does not support remote playback, then none of the functionality offered by the client will be available.

This method returns true if the route supports all of the following actions: play, seek, get status, pause, resume, stop.

Returns
boolean

True if remote playback is supported.

isSessionManagementSupported

Added in 1.1.0
public boolean isSessionManagementSupported()

Returns true if the route supports session management features.

If the route does not support session management, then the session will not be created until the first media item is played.

This method returns true if the route supports all of the basic remote playback actions and all of the following actions: start session, get session status, end session.

Returns
boolean

True if session management is supported. Implies isRemotePlaybackSupported is also true.
See also
isRemotePlaybackSupported

pause

Added in 1.1.0
public void pause(
    @Nullable Bundle extras,
    @Nullable RemotePlaybackClient.SessionActionCallback callback
)

Sends a request to pause media playback.

The request is issued in the current session. If playback is already paused then the request has no effect.

Please refer to ACTION_PAUSE for more information about the semantics of this request.

Parameters
@Nullable Bundle extras

A bundle of extra arguments to be added to the ACTION_PAUSE intent, or null if none.
@Nullable RemotePlaybackClient.SessionActionCallback callback

A callback to invoke when the request has been processed, or null if none.
Throws
java.lang.IllegalStateException

if there is no current session.
See also
ACTION_PAUSE
isRemotePlaybackSupported

play

Added in 1.1.0
public void play(
    @NonNull Uri contentUri,
    @Nullable String mimeType,
    @Nullable Bundle metadata,
    long positionMillis,
    @Nullable Bundle extras,
    @Nullable RemotePlaybackClient.ItemActionCallback callback
)

Sends a request to play a media item.

Clears the queue and starts playing the new item immediately. If the queue was previously paused, then it is resumed as a side-effect of this request.

The request is issued in the current session. If no session is available, then one is created implicitly.

Please refer to ACTION_PLAY for more information about the semantics of this request.

Parameters
@NonNull Uri contentUri

The content Uri to play.
@Nullable String mimeType

The mime type of the content, or null if unknown.
@Nullable Bundle metadata

The media item metadata bundle, or null if none.
long positionMillis

The initial content position for the item in milliseconds, or 0 to start at the beginning.
@Nullable Bundle extras

A bundle of extra arguments to be added to the ACTION_PLAY intent, or null if none.
@Nullable RemotePlaybackClient.ItemActionCallback callback

A callback to invoke when the request has been processed, or null if none.
Throws
java.lang.UnsupportedOperationException

if the route does not support remote playback.
See also
ACTION_PLAY
isRemotePlaybackSupported

release

Added in 1.1.0
public void release()

Releases resources owned by the client.

remove

Added in 1.1.0
public void remove(
    @NonNull String itemId,
    @Nullable Bundle extras,
    @Nullable RemotePlaybackClient.ItemActionCallback callback
)

Sends a request to remove a media item from the queue.

The request is issued in the current session.

Please refer to ACTION_REMOVE for more information about the semantics of this request.

Parameters
@NonNull String itemId

The item id.
@Nullable Bundle extras

A bundle of extra arguments to be added to the ACTION_REMOVE intent, or null if none.
@Nullable RemotePlaybackClient.ItemActionCallback callback

A callback to invoke when the request has been processed, or null if none.
Throws
java.lang.IllegalStateException

if there is no current session.
java.lang.UnsupportedOperationException

if the route does not support queuing.
See also
ACTION_REMOVE
isRemotePlaybackSupported
isQueuingSupported

resume

Added in 1.1.0
public void resume(
    @Nullable Bundle extras,
    @Nullable RemotePlaybackClient.SessionActionCallback callback
)

Sends a request to resume (unpause) media playback.

The request is issued in the current session. If playback is not paused then the request has no effect.

Please refer to ACTION_RESUME for more information about the semantics of this request.

Parameters
@Nullable Bundle extras

A bundle of extra arguments to be added to the ACTION_RESUME intent, or null if none.
@Nullable RemotePlaybackClient.SessionActionCallback callback

A callback to invoke when the request has been processed, or null if none.
Throws
java.lang.IllegalStateException

if there is no current session.
See also
ACTION_RESUME
isRemotePlaybackSupported

seek

Added in 1.1.0
public void seek(
    @NonNull String itemId,
    long positionMillis,
    @Nullable Bundle extras,
    @Nullable RemotePlaybackClient.ItemActionCallback callback
)

Sends a request to seek to a new position in a media item.

Seeks to a new position. If the queue was previously paused then it remains paused but the item's new position is still remembered.

The request is issued in the current session.

Please refer to ACTION_SEEK for more information about the semantics of this request.

Parameters
@NonNull String itemId

The item id.
long positionMillis

The new content position for the item in milliseconds, or 0 to start at the beginning.
@Nullable Bundle extras

A bundle of extra arguments to be added to the ACTION_SEEK intent, or null if none.
@Nullable RemotePlaybackClient.ItemActionCallback callback

A callback to invoke when the request has been processed, or null if none.
Throws
java.lang.IllegalStateException

if there is no current session.
See also
ACTION_SEEK
isRemotePlaybackSupported

sendMessage

Added in 1.1.0
public void sendMessage(
    @Nullable Bundle message,
    @Nullable RemotePlaybackClient.SessionActionCallback callback
)

Sends a message.

The request is issued in the current session.

Please refer to ACTION_SEND_MESSAGE for more information about the semantics of this request.

Parameters
@Nullable Bundle message

A bundle message denoting EXTRA_MESSAGE.
@Nullable RemotePlaybackClient.SessionActionCallback callback

A callback to invoke when the request has been processed, or null if none.
Throws
java.lang.IllegalStateException

if there is no current session.
java.lang.UnsupportedOperationException

if the route does not support messages.
See also
ACTION_SEND_MESSAGE
isMessagingSupported

setOnMessageReceivedListener

Added in 1.1.0
public void setOnMessageReceivedListener(
    @Nullable RemotePlaybackClient.OnMessageReceivedListener listener
)

Sets a callback that should receive messages when a message is sent from media sessions created by this instance of the remote playback client changes.

The callback should be set before the session is created.

Parameters
@Nullable RemotePlaybackClient.OnMessageReceivedListener listener

The callback to set. May be null to remove the previous callback.

setSessionId

Added in 1.1.0
public void setSessionId(@Nullable String sessionId)

Sets the current session id.

It is usually not necessary to set the session id explicitly since it is created as a side-effect of other requests such as play, enqueue, and startSession.

Parameters
@Nullable String sessionId

The new session id, or null if none.

setStatusCallback

Added in 1.1.0
public void setStatusCallback(
    @Nullable RemotePlaybackClient.StatusCallback callback
)

Sets a callback that should receive status updates when the state of media sessions or media items created by this instance of the remote playback client changes.

The callback should be set before the session is created or any play commands are issued.

Parameters
@Nullable RemotePlaybackClient.StatusCallback callback

The callback to set. May be null to remove the previous callback.

startSession

Added in 1.1.0
public void startSession(
    @Nullable Bundle extras,
    @Nullable RemotePlaybackClient.SessionActionCallback callback
)

Sends a request to start a new media playback session.

The application must wait for the callback to indicate that this request is complete before issuing other requests that affect the session. If this request is successful then the previous session will be invalidated.

Please refer to ACTION_START_SESSION for more information about the semantics of this request.

Parameters
@Nullable Bundle extras

A bundle of extra arguments to be added to the ACTION_START_SESSION intent, or null if none.
@Nullable RemotePlaybackClient.SessionActionCallback callback

A callback to invoke when the request has been processed, or null if none.
Throws
java.lang.UnsupportedOperationException

if the route does not support session management.
See also
ACTION_START_SESSION
isRemotePlaybackSupported
isSessionManagementSupported

stop

Added in 1.1.0
public void stop(
    @Nullable Bundle extras,
    @Nullable RemotePlaybackClient.SessionActionCallback callback
)

Sends a request to stop media playback and clear the media playback queue.

The request is issued in the current session. If the queue is already empty then the request has no effect.

Please refer to ACTION_STOP for more information about the semantics of this request.

Parameters
@Nullable Bundle extras

A bundle of extra arguments to be added to the ACTION_STOP intent, or null if none.
@Nullable RemotePlaybackClient.SessionActionCallback callback

A callback to invoke when the request has been processed, or null if none.
Throws
java.lang.IllegalStateException

if there is no current session.
See also
ACTION_STOP
isRemotePlaybackSupported