Builder
class Builder
| kotlin.Any | |
| ↳ | android.media.session.PlaybackState.Builder |
Builder for PlaybackState objects.
Summary
| Public constructors | |
|---|---|
Builder()Creates an initially empty state builder. |
|
Builder(from: PlaybackState!)Creates a builder with the same initial values as those in the from state. |
|
| Public methods | |
|---|---|
| PlaybackState.Builder! |
addCustomAction(customAction: PlaybackState.CustomAction!)Add a custom action to the playback state. |
| PlaybackState.Builder! |
addCustomAction(action: String!, name: String!, icon: Int)Add a custom action to the playback state. |
| PlaybackState! |
build()Build and return the |
| PlaybackState.Builder! |
setActions(actions: Long)Set the current actions available on this session. |
| PlaybackState.Builder! |
setActiveQueueItemId(id: Long)Set the active item in the play queue by specifying its id. |
| PlaybackState.Builder! |
setBufferedPosition(bufferedPosition: Long)Set the current buffered position in ms. |
| PlaybackState.Builder! |
setErrorMessage(error: CharSequence!)Set a user readable error message. |
| PlaybackState.Builder! |
Set any custom extras to be included with the playback state. |
| PlaybackState.Builder! |
Set the current state of playback. |
| PlaybackState.Builder! |
Set the current state of playback. |
Public constructors
Builder
Builder(from: PlaybackState!)
Creates a builder with the same initial values as those in the from state.
| Parameters | |
|---|---|
from |
PlaybackState!: The state to use for initializing the builder. |
Public methods
addCustomAction
fun addCustomAction(customAction: PlaybackState.CustomAction!): PlaybackState.Builder!
Add a custom action to the playback state. Actions can be used to expose additional functionality to MediaControllers beyond what is offered by the standard transport controls.
An example of an action would be to start a radio station based on the current item or to skip ahead by 30 seconds.
| Parameters | |
|---|---|
customAction |
PlaybackState.CustomAction!: The custom action to add to the PlaybackState. |
| Return | |
|---|---|
PlaybackState.Builder! |
this |
addCustomAction
fun addCustomAction(
action: String!,
name: String!,
icon: Int
): PlaybackState.Builder!
Add a custom action to the playback state. Actions can be used to expose additional functionality to MediaControllers beyond what is offered by the standard transport controls.
e.g. start a radio station based on the current item or skip ahead by 30 seconds.
| Parameters | |
|---|---|
action |
String!: An identifier for this action. It can be sent back to the MediaSession through MediaController.TransportControls.sendCustomAction(String, Bundle). |
name |
String!: The display name for the action. If text is shown with the action or used for accessibility, this is what should be used. |
icon |
Int: The resource action of the icon that should be displayed for the action. The resource should be in the package of the MediaSession. |
| Return | |
|---|---|
PlaybackState.Builder! |
this |
build
fun build(): PlaybackState!
Build and return the PlaybackState instance with these values.
| Return | |
|---|---|
PlaybackState! |
A new state instance. |
setActions
fun setActions(actions: Long): PlaybackState.Builder!
Set the current actions available on this session. This should use a bitmask of possible actions.
-
PlaybackState.ACTION_SKIP_TO_PREVIOUS -
PlaybackState.ACTION_REWIND -
PlaybackState.ACTION_PLAY -
PlaybackState.ACTION_PAUSE -
PlaybackState.ACTION_STOP -
PlaybackState.ACTION_FAST_FORWARD -
PlaybackState.ACTION_SKIP_TO_NEXT -
PlaybackState.ACTION_SEEK_TO -
PlaybackState.ACTION_SET_RATING -
PlaybackState.ACTION_PLAY_PAUSE -
PlaybackState.ACTION_PLAY_FROM_MEDIA_ID -
PlaybackState.ACTION_PLAY_FROM_SEARCH -
PlaybackState.ACTION_SKIP_TO_QUEUE_ITEM -
PlaybackState.ACTION_PLAY_FROM_URI -
PlaybackState.ACTION_PREPARE -
PlaybackState.ACTION_PREPARE_FROM_MEDIA_ID -
PlaybackState.ACTION_PREPARE_FROM_SEARCH -
PlaybackState.ACTION_PREPARE_FROM_URI -
PlaybackState.ACTION_SET_PLAYBACK_SPEED
| Return | |
|---|---|
PlaybackState.Builder! |
this |
setActiveQueueItemId
fun setActiveQueueItemId(id: Long): PlaybackState.Builder!
Set the active item in the play queue by specifying its id. The default value is MediaSession.QueueItem.UNKNOWN_ID
| Parameters | |
|---|---|
id |
Long: The id of the active item. |
| Return | |
|---|---|
PlaybackState.Builder! |
this |
setBufferedPosition
fun setBufferedPosition(bufferedPosition: Long): PlaybackState.Builder!
Set the current buffered position in ms. This is the farthest playback point that can be reached from the current position using only buffered content.
| Parameters | |
|---|---|
bufferedPosition |
Long: The position in ms that playback is buffered to. |
| Return | |
|---|---|
PlaybackState.Builder! |
this |
setErrorMessage
fun setErrorMessage(error: CharSequence!): PlaybackState.Builder!
Set a user readable error message. This should be set when the state is PlaybackState.STATE_ERROR.
| Parameters | |
|---|---|
error |
CharSequence!: The error message for display to the user. |
| Return | |
|---|---|
PlaybackState.Builder! |
this |
setExtras
fun setExtras(extras: Bundle!): PlaybackState.Builder!
Set any custom extras to be included with the playback state.
| Parameters | |
|---|---|
extras |
Bundle!: The extras to include. |
| Return | |
|---|---|
PlaybackState.Builder! |
this |
setState
fun setState(
state: Int,
position: Long,
playbackSpeed: Float
): PlaybackState.Builder!
Set the current state of playback.
The position must be in ms and indicates the current playback position within the item. If the position is unknown use PLAYBACK_POSITION_UNKNOWN. The update time will be set to the current SystemClock.elapsedRealtime().
The speed is a multiple of normal playback and should be 0 when paused and negative when rewinding. Normal playback speed is 1.0.
The state must be one of the following:
-
PlaybackState.STATE_NONE -
PlaybackState.STATE_STOPPED -
PlaybackState.STATE_PLAYING -
PlaybackState.STATE_PAUSED -
PlaybackState.STATE_FAST_FORWARDING -
PlaybackState.STATE_REWINDING -
PlaybackState.STATE_BUFFERING -
PlaybackState.STATE_ERROR -
PlaybackState.STATE_CONNECTING -
PlaybackState.STATE_SKIPPING_TO_PREVIOUS -
PlaybackState.STATE_SKIPPING_TO_NEXT -
PlaybackState.STATE_SKIPPING_TO_QUEUE_ITEM
| Parameters | |
|---|---|
state |
Int: The current state of playback. Value is android.media.session.PlaybackState#STATE_NONE, android.media.session.PlaybackState#STATE_STOPPED, android.media.session.PlaybackState#STATE_PAUSED, android.media.session.PlaybackState#STATE_PLAYING, android.media.session.PlaybackState#STATE_FAST_FORWARDING, android.media.session.PlaybackState#STATE_REWINDING, android.media.session.PlaybackState#STATE_BUFFERING, android.media.session.PlaybackState#STATE_ERROR, android.media.session.PlaybackState#STATE_CONNECTING, android.media.session.PlaybackState#STATE_SKIPPING_TO_PREVIOUS, android.media.session.PlaybackState#STATE_SKIPPING_TO_NEXT, or android.media.session.PlaybackState#STATE_SKIPPING_TO_QUEUE_ITEM |
position |
Long: The position in the current item in ms. |
playbackSpeed |
Float: The current speed of playback as a multiple of normal playback. |
| Return | |
|---|---|
PlaybackState.Builder! |
this |
setState
fun setState(
state: Int,
position: Long,
playbackSpeed: Float,
updateTime: Long
): PlaybackState.Builder!
Set the current state of playback.
The position must be in ms and indicates the current playback position within the item. If the position is unknown use PLAYBACK_POSITION_UNKNOWN. When not using an unknown position the time at which the position was updated must be provided. It is okay to use SystemClock.elapsedRealtime() if the current position was just retrieved.
The speed is a multiple of normal playback and should be 0 when paused and negative when rewinding. Normal playback speed is 1.0.
The state must be one of the following:
-
PlaybackState.STATE_NONE -
PlaybackState.STATE_STOPPED -
PlaybackState.STATE_PLAYING -
PlaybackState.STATE_PAUSED -
PlaybackState.STATE_FAST_FORWARDING -
PlaybackState.STATE_REWINDING -
PlaybackState.STATE_BUFFERING -
PlaybackState.STATE_ERROR -
PlaybackState.STATE_CONNECTING -
PlaybackState.STATE_SKIPPING_TO_PREVIOUS -
PlaybackState.STATE_SKIPPING_TO_NEXT -
PlaybackState.STATE_SKIPPING_TO_QUEUE_ITEM
| Parameters | |
|---|---|
state |
Int: The current state of playback. Value is android.media.session.PlaybackState#STATE_NONE, android.media.session.PlaybackState#STATE_STOPPED, android.media.session.PlaybackState#STATE_PAUSED, android.media.session.PlaybackState#STATE_PLAYING, android.media.session.PlaybackState#STATE_FAST_FORWARDING, android.media.session.PlaybackState#STATE_REWINDING, android.media.session.PlaybackState#STATE_BUFFERING, android.media.session.PlaybackState#STATE_ERROR, android.media.session.PlaybackState#STATE_CONNECTING, android.media.session.PlaybackState#STATE_SKIPPING_TO_PREVIOUS, android.media.session.PlaybackState#STATE_SKIPPING_TO_NEXT, or android.media.session.PlaybackState#STATE_SKIPPING_TO_QUEUE_ITEM |
position |
Long: The position in the current item in ms. |
playbackSpeed |
Float: The current speed of playback as a multiple of normal playback. |
updateTime |
Long: The time in the SystemClock.elapsedRealtime timebase that the position was updated at. |
| Return | |
|---|---|
PlaybackState.Builder! |
this |