Added in API level 29

Summary: Nested Classes | Methods | Inherited Methods

MediaController2

Kotlin |Java

public class MediaController2
extends Object implements AutoCloseable

java.lang.Object
↳	android.media.MediaController2

This API is not generally intended for third party application developers. Use the AndroidX Media3 session Library for consistent behavior across all devices. Allows an app to interact with an active MediaSession2 or a MediaSession2Service which would provide MediaSession2.

Summary

Nested classes
`class`	`MediaController2.Builder` This API is not generally intended for third party application developers.
`class`	`MediaController2.ControllerCallback` This API is not generally intended for third party application developers.

Public methods
`void`	`cancelSessionCommand(Object token)` Cancels the session command previously sent.
`void`	`close()` Closes this resource, relinquishing any underlying resources.
`Session2Token`	`getConnectedToken()` Returns `Session2Token` of the connected session.
`boolean`	`isPlaybackActive()` Returns whether the session's playback is active.
`Object`	`sendSessionCommand(Session2Command command, Bundle args)` Sends a session command to the session

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.

From interface


        
          java.lang.AutoCloseable


      close()

Closes this resource, relinquishing any underlying resources.

Public methods

cancelSessionCommand

Added in API level 29

public void cancelSessionCommand (Object token)

Cancels the session command previously sent.

Parameters
`token`	`Object`: the token which is returned from `sendSessionCommand(Session2Command, Bundle)`. This value cannot be `null`.

close

Added in API level 29

public void close ()

Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the try-with-resources statement.

getConnectedToken

Added in API level 29

public Session2Token getConnectedToken ()

Returns Session2Token of the connected session. If it is not connected yet, it returns null.

This may differ with the Session2Token from the constructor. For example, if the controller is created with the token for MediaSession2Service, this would return token for the MediaSession2 in the service.

Returns
`Session2Token`	Session2Token of the connected session, or `null` if not connected

isPlaybackActive

Added in API level 29

public boolean isPlaybackActive ()

Returns whether the session's playback is active.

Returns
`boolean`	`true` if playback active. `false` otherwise.

See also:

MediaController2.ControllerCallback.onPlaybackActiveChanged(MediaController2, boolean)

sendSessionCommand

Added in API level 29

public Object sendSessionCommand (Session2Command command, 
                Bundle args)

Sends a session command to the session

Parameters
`command`	`Session2Command`: the session command This value cannot be `null`.
`args`	`Bundle`: optional arguments This value may be `null`.

Returns
`Object`	a token which will be sent together in `ControllerCallback.onCommandResult` when its result is received. This value cannot be `null`.

MediaController2

Summary

Nested classes

Public methods

Inherited methods

Public methods

cancelSessionCommand

close

getConnectedToken

isPlaybackActive

sendSessionCommand