MediaSession.Builder

Builder(context: Context!, player: Player!)

Creates a builder for MediaSession.

fun build(): MediaSession!

Builds a MediaSession.

@UnstableApi
fun setBitmapLoader(bitmapLoader: BitmapLoader!): MediaSession.Builder!

Sets a BitmapLoader for the MediaSession to decode bitmaps from compressed binary data or load bitmaps from Uri.

The provided instance will likely be called repeatedly with the same request, so it would be best if any provided instance does some caching. Simple caching can be added to any BitmapLoader implementation by wrapping it in CacheBitmapLoader before passing it to this method.

If no instance is set, a CacheBitmapLoader with a DataSourceBitmapLoader inside will be used.

fun setCallback(callback: MediaSession.Callback!): MediaSession.Builder!

Sets a callback for the MediaSession to handle incoming requests from {link MediaController}.

Apps that want to allow controllers to set or add media items to the playlist, must use a callback and override its onSetMediaItems or onSetMediaItems methods.

@UnstableApi
fun setCommandButtonsForMediaItems(
    commandButtons: (Mutable)List<CommandButton!>!
): MediaSession.Builder!

Sets command buttons that can be added as supported media item commands.

@CanIgnoreReturnValue
@UnstableApi
fun setCustomLayout(customLayout: (Mutable)List<CommandButton!>!): MediaSession.Builder!

Sets the custom layout of the session.

This method will be deprecated, prefer to use setMediaButtonPreferences. Note that the media button preferences use slots to define the allowed button placement.

The button are converted to custom actions in the platform media session playback state for platform or legacy android.support.v4.media.session.MediaControllerCompat controllers (see PlaybackStateCompat.Builder#addCustomAction(PlaybackStateCompat.CustomAction)). When converting, the custom extras of the session command is used for the extras of the platform custom action.

Controllers that connect have the custom layout of the session available with the initial connection result by default. A custom layout specific to a controller can be set when the controller connects by using an ConnectionResult.AcceptedResultBuilder.

Use MediaSession.setCustomLayout(..) to update the custom layout during the life time of the session.

On the controller side, the enabled flag is set to false if the available commands of a controller do not allow to use a button.

@CanIgnoreReturnValue
@UnstableApi
fun setExperimentalSetUseLegacySurfaceHandling(
    useLegacySurfaceHandling: Boolean
): MediaSession.Builder!

Sets whether to use the legacy surface handling logic by ignoring the surface size.

When set to true, the session will call setVideoSurface directly, which may not work correctly with video effects. This is intended as a temporary opt-out for applications that experience issues with the new SurfaceHolder-based approach.

This method is experimental and may be removed in a future release.

fun setExtras(tokenExtras: Bundle!): MediaSession.Builder!

Sets an extras Bundle for the session token. If not set, EMPTY is used.

A controller has access to these extras through the connected token.

fun setId(id: String!): MediaSession.Builder!

Sets an ID of the MediaSession. If not set, an empty string will be used.

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-grained controls.

@CanIgnoreReturnValue
@UnstableApi
fun setMediaButtonPreferences(
    mediaButtonPreferences: (Mutable)List<CommandButton!>!
): MediaSession.Builder!

Sets the media button preferences.

The button are converted to custom actions in the platform media session playback state for platform or legacy android.support.v4.media.session.MediaControllerCompat controllers (see PlaybackStateCompat.Builder#addCustomAction(PlaybackStateCompat.CustomAction)). When converting, the custom extras of the session command is used for the extras of the platform custom action.

Controllers that connect have the media button preferences of the session available with the initial connection result by default. Media button preferences specific to a controller can be set when the controller connects by using an ConnectionResult.AcceptedResultBuilder.

Use MediaSession.setMediaButtonPreferences(..) to update the media button preferences during the life time of the session.

On the controller side, the enabled flag is set to false if the available commands of a controller do not allow to use a button.

@UnstableApi
fun setPeriodicPositionUpdateEnabled(isEnabled: Boolean): MediaSession.Builder!

Sets whether periodic position updates should be sent to controllers while playing. If false, no periodic position updates are sent to controllers.

The default is true.

fun setSessionActivity(pendingIntent: PendingIntent!): MediaSession.Builder!

Sets a PendingIntent to launch an android.app.Activity for the MediaSession. This can be used as a quick link to an ongoing media screen.

A client can use this pending intent to start an activity belonging to this session. On API levels below 33 the pending intent can be used as the content intent. Tapping the notification will then send that pending intent and open the activity (see 'Start an Activity from a Notification'). For API levels starting with 33, the media notification reads the pending intent directly from the session.

fun setSessionExtras(sessionExtras: Bundle!): MediaSession.Builder!

Sets the session extras. If not set, EMPTY is used.

A controller has access to session extras through getSessionExtras.

@UnstableApi
fun setShowPlayButtonIfPlaybackIsSuppressed(
    showPlayButtonIfPlaybackIsSuppressed: Boolean
): MediaSession.Builder!

Sets whether a play button is shown if playback is suppressed.

The default is true.

@EnsuresNonNull(value = "bitmapLoader")
protected fun ensureBitmapLoaderIsSizeLimited(): Unit

Updates bitmap loader to ensure its using the maximum media session size limit.