Added in API level 21

Summary: Nested Classes | Ctors | Methods | Inherited Methods

MediaController

Kotlin |Java

public final class MediaController
extends Object

java.lang.Object
↳	android.media.session.MediaController

Allows an app to interact with an ongoing media session. Media buttons and other commands can be sent to the session. A callback may be registered to receive updates from the session, such as metadata and play state changes.

A MediaController can be created through MediaSessionManager if you hold the "android.permission.MEDIA_CONTENT_CONTROL" permission or are an enabled notification listener or by getting a MediaSession.Token directly from the session owner.

MediaController objects are thread-safe.

Summary

Nested classes
`class`	`MediaController.Callback` Callback for receiving updates from the session.
`class`	`MediaController.PlaybackInfo` Holds information about the current playback and how audio is handled for this session.
`class`	`MediaController.TransportControls` Interface for controlling media playback on a session.

Public constructors
`MediaController(Context context, MediaSession.Token token)` Create a new MediaController from a session's token.

Public methods
`void`	`adjustVolume(int direction, int flags)` Adjust the volume of the output this session is playing on.
`boolean`	`dispatchMediaButtonEvent(KeyEvent keyEvent)` Send the specified media button event to the session.
`Bundle`	`getExtras()` Get the extras for this session.
`long`	`getFlags()` Get the flags for this session.
`MediaMetadata`	`getMetadata()` Get the current metadata for this session.
`String`	`getPackageName()` Get the session owner's package name.
`MediaController.PlaybackInfo`	`getPlaybackInfo()` Returns the current playback info for this session.
`PlaybackState`	`getPlaybackState()` Get the current playback state for this session.
`List<MediaSession.QueueItem>`	`getQueue()` Get the current play queue for this session if one is set.
`CharSequence`	`getQueueTitle()` Get the queue title for this session.
`int`	`getRatingType()` Get the rating type supported by the session.
`PendingIntent`	`getSessionActivity()` Get an intent for launching UI associated with this session if one exists.
`Bundle`	`getSessionInfo()` Gets the additional session information which was set when the session was created.
`MediaSession.Token`	`getSessionToken()` Get the token for the session this is connected to.
`String`	`getTag()` Get the session's tag for debugging purposes.
`MediaController.TransportControls`	`getTransportControls()` Get a `TransportControls` instance to send transport actions to the associated session.
`void`	`registerCallback(MediaController.Callback callback, Handler handler)` Registers a callback to receive updates from the session.
`void`	`registerCallback(MediaController.Callback callback)` Registers a callback to receive updates from the Session.
`void`	`sendCommand(String command, Bundle args, ResultReceiver cb)` Sends a generic command to the session.
`void`	`setVolumeTo(int value, int flags)` Set the volume of the output this session is playing on.
`void`	`unregisterCallback(MediaController.Callback callback)` Unregisters the specified callback.

Inherited methods

From class


        
          java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long timeoutMillis, int nanos)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis)` Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait()` Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

MediaController

Added in API level 21

public MediaController (Context context, 
                MediaSession.Token token)

Create a new MediaController from a session's token.

Parameters
`context`	`Context`: The caller's context. This value cannot be `null`.
`token`	`MediaSession.Token`: The token for the session. This value cannot be `null`.

Public methods

adjustVolume

Added in API level 21

public void adjustVolume (int direction, 
                int flags)

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

Parameters
`direction`	`int`: The direction to adjust the volume in.
`flags`	`int`: Any flags to pass with the command.

See also:

getPlaybackInfo()

dispatchMediaButtonEvent

Added in API level 21

public boolean dispatchMediaButtonEvent (KeyEvent keyEvent)

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

Parameters
`keyEvent`	`KeyEvent`: The media button event to dispatch. This value cannot be `null`.

Returns
`boolean`	true if the event was sent to the session, false otherwise.

getExtras

Added in API level 21

public Bundle getExtras ()

Get the extras for this session.

Returns
`Bundle`	This value may be `null`.

getFlags

Added in API level 21

public long getFlags ()

Get the flags for this session. Flags are defined in MediaSession.

Returns
`long`	The current set of flags for the session.

getMetadata

Added in API level 21

public MediaMetadata getMetadata ()

Get the current metadata for this session.

Returns
`MediaMetadata`	The current MediaMetadata or null.

getPackageName

Added in API level 21

public String getPackageName ()

Get the session owner's package name.

Returns
`String`	The package name of the session owner.

getPlaybackInfo

Added in API level 21

public MediaController.PlaybackInfo getPlaybackInfo ()

Returns the current playback info for this session.

Returns
`MediaController.PlaybackInfo`	This value cannot be `null`.

getPlaybackState

Added in API level 21

public PlaybackState getPlaybackState ()

Get the current playback state for this session.

Returns
`PlaybackState`	The current PlaybackState or null

getQueue

Added in API level 21

public List<MediaSession.QueueItem> getQueue ()

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

Returns
`List<MediaSession.QueueItem>`	The current play queue or null.

getQueueTitle

Added in API level 21

public CharSequence getQueueTitle ()

Get the queue title for this session.

Returns
`CharSequence`	This value may be `null`.

getRatingType

Added in API level 21

public int getRatingType ()

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

Returns
`int`	The supported rating type

getSessionActivity

Added in API level 21

public PendingIntent getSessionActivity ()

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

Returns
`PendingIntent`	A `PendingIntent` to launch UI or null.

getSessionInfo

Added in API level 29

public Bundle getSessionInfo ()

Gets the additional session information which was set when the session was created.

Returns
`Bundle`	The additional session information, or an empty `Bundle` if not set. This value cannot be `null`.

getSessionToken

Added in API level 21

public MediaSession.Token getSessionToken ()

Get the token for the session this is connected to.

Returns
`MediaSession.Token`	The token for the connected session. This value cannot be `null`.

getTag

Added in API level 30

public String getTag ()

Get the session's tag for debugging purposes.

Returns
`String`	The session's tag. This value cannot be `null`.

getTransportControls

Added in API level 21

public MediaController.TransportControls getTransportControls ()

Get a TransportControls instance to send transport actions to the associated session.

Returns
`MediaController.TransportControls`	A transport controls instance. This value cannot be `null`.

registerCallback

Added in API level 21

public void registerCallback (MediaController.Callback callback, 
                Handler handler)

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

Parameters
`callback`	`MediaController.Callback`: The callback object, must not be null.
`handler`	`Handler`: The handler to post updates on. If null the callers thread will be used.

registerCallback

Added in API level 21

public void registerCallback (MediaController.Callback callback)

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

Parameters
`callback`	`MediaController.Callback`: The callback object, must not be null.

sendCommand

Added in API level 21

public void sendCommand (String command, 
                Bundle args, 
                ResultReceiver cb)

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.

Parameters
`command`	`String`: The command to send This value cannot be `null`.
`args`	`Bundle`: Any parameters to include with the command This value may be `null`.
`cb`	`ResultReceiver`: The callback to receive the result on This value may be `null`.

setVolumeTo

Added in API level 21

public void setVolumeTo (int value, 
                int flags)

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

Parameters
`value`	`int`: The value to set it to, between 0 and the reported max.
`flags`	`int`: Flags from `AudioManager` to include with the volume request.

See also:

getPlaybackInfo()

unregisterCallback

Added in API level 21

public void unregisterCallback (MediaController.Callback callback)

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

Parameters
`callback`	`MediaController.Callback`: The callback to remove. This value cannot be `null`.

MediaController

Summary

Nested classes

Public constructors

Public methods

Inherited methods

Public constructors

MediaController

Public methods

adjustVolume

dispatchMediaButtonEvent

getExtras

getFlags

getMetadata

getPackageName

getPlaybackInfo

getPlaybackState

getQueue

getQueueTitle

getRatingType

getSessionActivity

getSessionInfo

getSessionToken

getTag

getTransportControls

registerCallback

registerCallback

sendCommand

setVolumeTo

unregisterCallback