Summary: Ctors | Methods | Inherited Methods

MediaSession2.Builder

public static final class MediaSession2.Builder
extends Object

java.lang.Object
↳	android.media.MediaSession2.Builder

Builder for MediaSession2.

Any incoming event from the MediaController2 will be handled on the callback executor. If it's not set, Context#getMainExecutor() will be used by default.

Summary

Public constructors
`MediaSession2.Builder(Context context)` Creates a builder for `MediaSession2`.

Public methods
`MediaSession2`	`build()` Build `MediaSession2`.
`MediaSession2.Builder`	`setExtras(Bundle extras)` Set extras for the session token.
`MediaSession2.Builder`	`setId(String id)` Set ID of the session.
`MediaSession2.Builder`	`setSessionActivity(PendingIntent pi)` Set an intent for launching UI for this Session.
`MediaSession2.Builder`	`setSessionCallback(Executor executor, MediaSession2.SessionCallback callback)` Set callback for the session and its executor.

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 timeout, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long timeout)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Public constructors

MediaSession2.Builder

Added in Android Q

public MediaSession2.Builder (Context context)

Creates a builder for MediaSession2.

Parameters
`context`	`Context`: Context This value must never be `null`.

Throws
`IllegalArgumentException`	if context is `null`.

Public methods

build

Added in Android Q

public MediaSession2 build ()

Build MediaSession2.

Returns
`MediaSession2`	a new session This value will never be `null`.

Throws
`IllegalStateException`	if the session with the same id is already exists for the package.

setExtras

Added in Android Q

public MediaSession2.Builder setExtras (Bundle extras)

Set extras for the session token.

Parameters
`extras`	`Bundle`: This value may be `null`.

Returns
`MediaSession2.Builder`	The Builder to allow chaining This value will never be `null`.

See also:

Session2Token.getExtras()

setId

Added in Android Q

public MediaSession2.Builder setId (String id)

Set ID of the session. If it's not set, an empty string will be used to create a session.

Use this if and only if your app supports multiple playback at the same time and also wants to provide external apps to have finer controls of them.

Parameters
`id`	`String`: id of the session. Must be unique per package. This value must never be `null`.

Returns
`MediaSession2.Builder`	The Builder to allow chaining

Throws
`IllegalArgumentException`	if id is `null`.

setSessionActivity

Added in Android Q

public MediaSession2.Builder setSessionActivity (PendingIntent pi)

Set an intent for launching UI for this Session. This can be used as a quick link to an ongoing media screen. The intent should be for an activity that may be started using Context#startActivity(Intent).

Parameters
`pi`	`PendingIntent`: The intent to launch to show UI for this session. This value may be `null`.

Returns
`MediaSession2.Builder`	The Builder to allow chaining This value will never be `null`.

setSessionCallback

Added in Android Q

public MediaSession2.Builder setSessionCallback (Executor executor, 
                MediaSession2.SessionCallback callback)

Set callback for the session and its executor.

Parameters
`executor`	`Executor`: callback executor This value must never be `null`.
`callback`	`MediaSession2.SessionCallback`: session callback. This value must never be `null`.

Returns
`MediaSession2.Builder`	The Builder to allow chaining This value will never be `null`.