MediaLibraryService.MediaLibrarySession.Builder

@UnstableApi
public Builder(
    Context context,
    Player player,
    MediaLibraryService.MediaLibrarySession.Callback callback
)

Creates a builder for MediaLibrarySession.

public Builder(
    MediaLibraryService service,
    Player player,
    MediaLibraryService.MediaLibrarySession.Callback callback
)

Creates a builder for MediaLibrarySession.

public MediaLibraryService.MediaLibrarySession build()

Builds a MediaLibrarySession.

@UnstableApi
public MediaLibraryService.MediaLibrarySession.Builder setBitmapLoader(BitmapLoader bitmapLoader)

Sets a BitmapLoader for the MediaLibrarySession 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.

@UnstableApi
public MediaLibraryService.MediaLibrarySession.Builder setCommandButtonsForMediaItems(List<CommandButton> commandButtons)

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

@UnstableApi
@CanIgnoreReturnValue
public MediaLibraryService.MediaLibrarySession.Builder setCustomLayout(List<CommandButton> customLayout)

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 buttons are converted to custom actions in the legacy media session playback state for legacy controllers (see PlaybackStateCompat.Builder#addCustomAction(PlaybackStateCompat.CustomAction)). When converting, the custom extras of the session command is used for the extras of the legacy 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.

On the controller side, isEnabled is overridden according to the available commands of the controller.

Use setCustomLayout to update the custom layout during the lifetime of the session.

public MediaLibraryService.MediaLibrarySession.Builder setExtras(Bundle tokenExtras)

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.

public MediaLibraryService.MediaLibrarySession.Builder setId(String id)

Sets an ID of the MediaLibrarySession. 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.

@UnstableApi
@CanIgnoreReturnValue
public MediaLibraryService.MediaLibrarySession.Builder setLibraryErrorReplicationMode(int libraryErrorReplicationMode)

Sets whether library result errors should be replicated to the platform media session's android.media.session.PlaybackState as a fatal error, a non-fatal error or not replicated at all. Replication is only executed for calling legacy browsers ( and android.media.browse.MediaBrowser) to which no error codes can be transmitted as a result of the service call.

The default is LIBRARY_ERROR_REPLICATION_MODE_FATAL.

onGetLibraryRoot is exempted from replication, because this method is part of the connection process of a legacy browser.

The following error codes are replicated:

• ERROR_SESSION_AUTHENTICATION_EXPIRED
• ERROR_SESSION_PREMIUM_ACCOUNT_REQUIRED

See clearReplicatedLibraryError also.

@CanIgnoreReturnValue
@UnstableApi
public MediaLibraryService.MediaLibrarySession.Builder setMediaButtonPreferences(List<CommandButton> mediaButtonPreferences)

Sets the media button preferences.

The button are converted to custom actions in the legacy media session playback state for legacy controllers (see PlaybackStateCompat.Builder#addCustomAction(PlaybackStateCompat.CustomAction)). When converting, the custom extras of the session command is used for the extras of the legacy 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
public MediaLibraryService.MediaLibrarySession.Builder setPeriodicPositionUpdateEnabled(boolean isEnabled)

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.

public MediaLibraryService.MediaLibrarySession.Builder setSessionActivity(PendingIntent pendingIntent)

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

@UnstableApi
public MediaLibraryService.MediaLibrarySession.Builder setSessionExtras(Bundle sessionExtras)

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

A controller has access to session extras through getSessionExtras.

@UnstableApi
public MediaLibraryService.MediaLibrarySession.Builder setShowPlayButtonIfPlaybackIsSuppressed(
    boolean showPlayButtonIfPlaybackIsSuppressed
)

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

The default is true.