RemotePlaybackClient

RemotePlaybackClient(context: Context, route: MediaRouter.RouteInfo)

Creates a remote playback client for a route.

fun endSession(
    extras: Bundle?,
    callback: RemotePlaybackClient.SessionActionCallback?
): Unit

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.

fun enqueue(
    contentUri: Uri,
    mimeType: String?,
    metadata: Bundle?,
    positionMillis: Long,
    extras: Bundle?,
    callback: RemotePlaybackClient.ItemActionCallback?
): Unit

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.

fun getSessionId(): String?

Gets the current session id if there is one.

fun getSessionStatus(
    extras: Bundle?,
    callback: RemotePlaybackClient.SessionActionCallback?
): Unit

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.

fun getStatus(
    itemId: String,
    extras: Bundle?,
    callback: RemotePlaybackClient.ItemActionCallback?
): Unit

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.

fun hasSession(): Boolean

Returns true if the client currently has a session.

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

fun isMessagingSupported(): Boolean

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.

fun isQueuingSupported(): Boolean

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.

fun isRemotePlaybackSupported(): Boolean

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.

fun isSessionManagementSupported(): Boolean

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.

fun pause(
    extras: Bundle?,
    callback: RemotePlaybackClient.SessionActionCallback?
): Unit

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.

fun play(
    contentUri: Uri,
    mimeType: String?,
    metadata: Bundle?,
    positionMillis: Long,
    extras: Bundle?,
    callback: RemotePlaybackClient.ItemActionCallback?
): Unit

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.

fun release(): Unit

Releases resources owned by the client.

fun remove(
    itemId: String,
    extras: Bundle?,
    callback: RemotePlaybackClient.ItemActionCallback?
): Unit

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.

fun resume(
    extras: Bundle?,
    callback: RemotePlaybackClient.SessionActionCallback?
): Unit

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.

fun seek(
    itemId: String,
    positionMillis: Long,
    extras: Bundle?,
    callback: RemotePlaybackClient.ItemActionCallback?
): Unit

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.

fun sendMessage(
    message: Bundle?,
    callback: RemotePlaybackClient.SessionActionCallback?
): Unit

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.

fun setOnMessageReceivedListener(
    listener: RemotePlaybackClient.OnMessageReceivedListener?
): Unit

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.

fun setSessionId(sessionId: String?): Unit

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.

fun setStatusCallback(callback: RemotePlaybackClient.StatusCallback?): Unit

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.

fun startSession(
    extras: Bundle?,
    callback: RemotePlaybackClient.SessionActionCallback?
): Unit

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.

fun stop(
    extras: Bundle?,
    callback: RemotePlaybackClient.SessionActionCallback?
): Unit

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.