MediaLibraryService.MediaLibrarySession.Builder
public final class MediaLibraryService.MediaLibrarySession.Builder
Builder for MediaLibrarySession.
Any incoming event from the MediaController will be handled on the callback executor. If it's not set, getMainExecutor will be used by default.
Summary
Public constructors |
|---|
Builder( |
Public methods |
|
|---|---|
@NonNull MediaLibraryService.MediaLibrarySession |
build()Builds a |
@NonNull MediaLibraryService.MediaLibrarySession.Builder |
Sets extras for the session token. |
@NonNull MediaLibraryService.MediaLibrarySession.Builder |
Sets the ID of the session. |
@NonNull MediaLibraryService.MediaLibrarySession.Builder |
Sets an intent for launching UI for this Session. |
Public constructors
public Builder(
@NonNull MediaLibraryService service,
@NonNull SessionPlayer player,
@NonNull Executor callbackExecutor,
@NonNull MediaLibraryService.MediaLibrarySession.MediaLibrarySessionCallback callback
)
Public methods
public @NonNull MediaLibraryService.MediaLibrarySession build()
Builds a MediaSession.
| Returns | |
|---|---|
@NonNull MediaLibraryService.MediaLibrarySession |
a new session |
| Throws | |
|---|---|
java.lang.IllegalStateException |
if the session with the same id already exists for the package. |
public @NonNull MediaLibraryService.MediaLibrarySession.Builder setExtras(@NonNull Bundle extras)
Sets extras for the session token. If not set, getExtras will return an empty Bundle.
| Returns | |
|---|---|
@NonNull MediaLibraryService.MediaLibrarySession.Builder |
the Builder to allow chaining |
| Throws | |
|---|---|
java.lang.IllegalArgumentException |
if the bundle contains any non-framework Parcelable objects. |
| See also | |
|---|---|
getExtras |
public @NonNull MediaLibraryService.MediaLibrarySession.Builder setId(@NonNull String id)
Sets the 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.
public @NonNull MediaLibraryService.MediaLibrarySession.Builder setSessionActivity(@Nullable PendingIntent pi)
Sets 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 startActivity.
| Parameters | |
|---|---|
@Nullable PendingIntent pi |
The intent to launch to show UI for this session. |