Builder

Builder

Builder()

Creates an initially empty state builder.

Builder

Builder(from: PlaybackState!)

Creates a builder with the same initial values as those in the from state.

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.

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.

build

fun build(): PlaybackState!

Build and return the PlaybackState instance with these values.

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

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

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.

setErrorMessage

fun setErrorMessage(error: CharSequence!): PlaybackState.Builder!

Set a user readable error message. This should be set when the state is PlaybackState#STATE_ERROR.

setExtras

fun setExtras(extras: Bundle!): PlaybackState.Builder!

Set any custom extras to be included with the playback state.

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
• android.media.session.PlaybackState#STATE_PLAYBACK_SUPPRESSED

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
• android.media.session.PlaybackState#STATE_PLAYBACK_SUPPRESSED