MediaControllerCompat

MediaControllerCompat(context: Context!, session: MediaSessionCompat)

Creates a media controller from a session.

MediaControllerCompat(
    context: Context!,
    sessionToken: MediaSessionCompat.Token
)

Creates a media controller from a session token which may have been obtained from another process.

fun addQueueItem(description: MediaDescriptionCompat!): Unit

Adds a queue item from the given description at the end of the play queue of this session. Not all sessions may support this. To know whether the session supports this, get the session's flags with getFlags and check that the flag FLAG_HANDLES_QUEUE_COMMANDS is set.

fun addQueueItem(description: MediaDescriptionCompat!, index: Int): Unit

Adds a queue item from the given description at the specified position in the play queue of this session. Shifts the queue item currently at that position (if any) and any subsequent queue items to the right (adds one to their indices). Not all sessions may support this. To know whether the session supports this, get the session's flags with getFlags and check that the flag FLAG_HANDLES_QUEUE_COMMANDS is set.

fun adjustVolume(direction: Int, flags: Int): Unit

Adjusts the volume of the output this session is playing on. The direction must be one of ADJUST_LOWER, ADJUST_RAISE, or ADJUST_SAME. The command will be ignored if the session does not support VOLUME_CONTROL_RELATIVE or VOLUME_CONTROL_ABSOLUTE. The flags in AudioManager may be used to affect the handling.

fun dispatchMediaButtonEvent(keyEvent: KeyEvent!): Boolean

Sends the specified media button event to the session. Only media keys can be sent by this method, other keys will be ignored.

fun getExtras(): Bundle!

Gets the extras for this session.

fun getFlags(): Long

Gets the flags for this session. Flags are defined in MediaSessionCompat.

fun getMediaController(): Any!

Gets the underlying framework android.media.session.MediaController object.

This method is only supported on API 21+.

java-static fun getMediaController(activity: Activity): MediaControllerCompat!

Retrieves the MediaControllerCompat set in the activity by setMediaController for sending media key and volume events.

This is compatible with getMediaController.

fun getMetadata(): MediaMetadataCompat!

Gets the current metadata for this session.

fun getPackageName(): String!

Gets the session owner's package name.

fun getPlaybackInfo(): MediaControllerCompat.PlaybackInfo!

Gets the current playback info for this session.

fun getPlaybackState(): PlaybackStateCompat!

Gets the current playback state for this session.

If the session is not ready, getExtras on the result of this method may return null.

fun getQueue(): (Mutable)List<MediaSessionCompat.QueueItem!>!

Gets the current play queue for this session if one is set. If you only care about the current item getMetadata should be used.

fun getQueueTitle(): CharSequence!

Gets the queue title for this session.

fun getRatingType(): Int

Gets the rating type supported by the session. One of:

• RATING_NONE
• RATING_HEART
• RATING_THUMB_UP_DOWN
• RATING_3_STARS
• RATING_4_STARS
• RATING_5_STARS
• RATING_PERCENTAGE

If the session is not ready, it will return RATING_NONE.

fun getRepeatMode(): Int

Gets the repeat mode for this session.

fun getSessionActivity(): PendingIntent!

Gets an intent for launching UI associated with this session if one exists.

fun getSessionInfo(): Bundle

Gets the additional session information which was set when the session was created. The returned Bundle can include additional unchanging information about the session. For example, it can include the version of the session application, or other app-specific unchanging information.

fun getSessionToken(): MediaSessionCompat.Token!

Gets the token for the session that this controller is connected to.

fun getShuffleMode(): Int

Gets the shuffle mode for this session.

fun getTransportControls(): MediaControllerCompat.TransportControls!

Gets a TransportControls instance for this session.

fun isCaptioningEnabled(): Boolean

Returns whether captioning is enabled for this session.

If the session is not ready, it will return a false.

fun isSessionReady(): Boolean

Returns whether the session is ready or not.

If the session is not ready, following methods can work incorrectly.

• getPlaybackState
• getRatingType
• getRepeatMode
• getSessionInfo}
• getShuffleMode
• isCaptioningEnabled

fun registerCallback(callback: MediaControllerCompat.Callback): Unit

Adds a callback to receive updates from the Session. Updates will be posted on the caller's thread.

fun registerCallback(
    callback: MediaControllerCompat.Callback,
    handler: Handler!
): Unit

Adds a callback to receive updates from the session. Updates will be posted on the specified handler's thread.

fun removeQueueItem(description: MediaDescriptionCompat!): Unit

Removes the first occurrence of the specified MediaSessionCompat.QueueItem with the given description in the play queue of the associated session. Not all sessions may support this. To know whether the session supports this, get the session's flags with getFlags and check that the flag FLAG_HANDLES_QUEUE_COMMANDS is set.

fun removeQueueItemAt(index: Int): Unit

Removes an queue item at the specified position in the play queue of this session. Not all sessions may support this. To know whether the session supports this, get the session's flags with getFlags and check that the flag FLAG_HANDLES_QUEUE_COMMANDS is set.

fun sendCommand(command: String, params: Bundle?, cb: ResultReceiver?): Unit

Sends a generic command to the session. It is up to the session creator to decide what commands and parameters they will support. As such, commands should only be sent to sessions that the controller owns.

java-static fun setMediaController(
    activity: Activity,
    mediaController: MediaControllerCompat!
): Unit

Sets a MediaControllerCompat in the activity for later retrieval via getMediaController.

On API 21 and later, setMediaController will also be called.

fun setVolumeTo(value: Int, flags: Int): Unit

Sets the volume of the output this session is playing on. The command will be ignored if it does not support VOLUME_CONTROL_ABSOLUTE. The flags in AudioManager may be used to affect the handling.

fun unregisterCallback(callback: MediaControllerCompat.Callback): Unit

Stops receiving updates on the specified callback. If an update has already been posted you may still receive it after calling this method.