Builder
class Builder : BuilderBase<MediaController!, MediaController.Builder!, MediaController.ControllerCallback!>
| androidx.media2.session.MediaController.Builder |
Builder for MediaController.
To set the token of the session for the controller to connect to, one of the setSessionToken(SessionToken) or setSessionCompatToken(MediaSessionCompat.Token) should be called. Otherwise, the build() will throw an IllegalArgumentException.
Any incoming event from the MediaSession will be handled on the callback executor.
Summary
Public constructors |
|
|---|---|
Public methods |
|
|---|---|
| MediaController |
build()Build |
| MediaController.Builder |
setControllerCallback(@NonNull executor: Executor, @NonNull callback: MediaController.ControllerCallback) |
| MediaController.Builder |
setSessionCompatToken(@NonNull compatToken: MediaSessionCompat.Token) |
| MediaController.Builder |
setSessionToken(@NonNull token: SessionToken) |
Public constructors
<init>
Builder(@NonNull context: Context)
Public methods
build
@NonNull fun build(): MediaController
Build MediaController.
It will throw an IllegalArgumentException if both SessionToken and MediaSessionCompat.Token are not set.
| Return | |
|---|---|
| MediaController: a new controller |
setControllerCallback
@NonNull fun setControllerCallback(@NonNull executor: Executor, @NonNull callback: MediaController.ControllerCallback): MediaController.Builder
setSessionCompatToken
@NonNull fun setSessionCompatToken(@NonNull compatToken: MediaSessionCompat.Token): MediaController.Builder
setSessionToken
@NonNull fun setSessionToken(@NonNull token: SessionToken): MediaController.Builder