Most visited

Recently visited

Results for

Summary: Ctors | Methods | Inherited Methods | [Expand All]

PlaybackStateCompat.Builder

public static final class PlaybackStateCompat.Builder
extends Object

java.lang.Object
↳	android.support.v4.media.session.PlaybackStateCompat.Builder

Builder for PlaybackStateCompat objects.

Summary

Public constructors
`PlaybackStateCompat.Builder()` Create an empty Builder.
`PlaybackStateCompat.Builder(PlaybackStateCompat source)` Create a Builder using a `PlaybackStateCompat` instance to set the initial values.

Public methods
`PlaybackStateCompat.Builder`	`addCustomAction(String action, String name, int icon)` Add a custom action to the playback state.
`PlaybackStateCompat.Builder`	`addCustomAction(PlaybackStateCompat.CustomAction customAction)` Add a custom action to the playback state.
`PlaybackStateCompat`	`build()` Creates the playback state object.
`PlaybackStateCompat.Builder`	`setActions(long capabilities)` Set the current capabilities available on this session.
`PlaybackStateCompat.Builder`	`setActiveQueueItemId(long id)` Set the active item in the play queue by specifying its id.
`PlaybackStateCompat.Builder`	`setBufferedPosition(long bufferPosition)` Set the current buffered position in ms.
`PlaybackStateCompat.Builder`	`setErrorMessage(CharSequence errorMessage)` Set a user readable error message.
`PlaybackStateCompat.Builder`	`setExtras(Bundle extras)` Set any custom extras to be included with the playback state.
`PlaybackStateCompat.Builder`	`setState(int state, long position, float playbackSpeed)` Set the current state of playback.
`PlaybackStateCompat.Builder`	`setState(int state, long position, float playbackSpeed, long updateTime)` Set the current state of playback.

Inherited methods

From class


  
    java.lang.Object

`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object obj)` Indicates whether some other object is "equal to" this one.
`void`	`finalize()` Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
`final Class<?>`	`getClass()` Returns the runtime class of this `Object`.
`int`	`hashCode()` Returns a hash code value for the object.
`final void`	`notify()` Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()` Wakes up all threads that are waiting on this object's monitor.
`String`	`toString()` Returns a string representation of the object.
`final void`	`wait(long millis, int nanos)` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
`final void`	`wait(long millis)` Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
`final void`	`wait()` Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

Public constructors

PlaybackStateCompat.Builder

PlaybackStateCompat.Builder ()

Create an empty Builder.

PlaybackStateCompat.Builder

PlaybackStateCompat.Builder (PlaybackStateCompat source)

Create a Builder using a PlaybackStateCompat instance to set the initial values.

Parameters
`source`	`PlaybackStateCompat`: The playback state to copy.

Public methods

addCustomAction

PlaybackStateCompat.Builder addCustomAction (String action, 
                String name, 
                int icon)

Add a custom action to the playback state. Actions can be used to expose additional functionality to Controllers 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 `MediaSessionCompat` through `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 `MediaSessionCompat`.

Returns
`PlaybackStateCompat.Builder`	this

addCustomAction

PlaybackStateCompat.Builder addCustomAction (PlaybackStateCompat.CustomAction customAction)

Add a custom action to the playback state. Actions can be used to expose additional functionality to Controllers 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`	`PlaybackStateCompat.CustomAction`: The custom action to add to the `PlaybackStateCompat`.

Returns
`PlaybackStateCompat.Builder`	this

build

PlaybackStateCompat build ()

Creates the playback state object.

Returns
`PlaybackStateCompat`

setActions

PlaybackStateCompat.Builder setActions (long capabilities)

Set the current capabilities available on this session. This should use a bitmask of the available capabilities.

Parameters
`capabilities`	`long`

Returns
`PlaybackStateCompat.Builder`	this

setActiveQueueItemId

PlaybackStateCompat.Builder setActiveQueueItemId (long id)

Set the active item in the play queue by specifying its id. The default value is UNKNOWN_ID

Parameters
`id`	`long`: The id of the active item.

Returns
`PlaybackStateCompat.Builder`	this

setBufferedPosition

PlaybackStateCompat.Builder setBufferedPosition (long bufferPosition)

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
`bufferPosition`	`long`

Returns
`PlaybackStateCompat.Builder`	this

setErrorMessage

PlaybackStateCompat.Builder setErrorMessage (CharSequence errorMessage)

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

Parameters
`errorMessage`	`CharSequence`

Returns
`PlaybackStateCompat.Builder`	this

setExtras

PlaybackStateCompat.Builder setExtras (Bundle extras)

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

Parameters
`extras`	`Bundle`: The extras to include.

Returns
`PlaybackStateCompat.Builder`	this

setState

PlaybackStateCompat.Builder setState (int state, 
                long position, 
                float playbackSpeed)

Set the current state of playback.

The position must be in ms and indicates the current playback position within the track. If the position is unknown use PLAYBACK_POSITION_UNKNOWN.

The rate is a multiple of normal playback and should be 0 when paused and negative when rewinding. Normal playback rate is 1.0.

The state must be one of the following:

Parameters
`state`	`int`: The current state of playback.
`position`	`long`: The position in the current track in ms.
`playbackSpeed`	`float`: The current rate of playback as a multiple of normal playback.

Returns
`PlaybackStateCompat.Builder`

setState

PlaybackStateCompat.Builder setState (int state, 
                long position, 
                float playbackSpeed, 
                long updateTime)

Set the current state of playback.

The position must be in ms and indicates the current playback position within the track. If the position is unknown use PLAYBACK_POSITION_UNKNOWN.

The rate is a multiple of normal playback and should be 0 when paused and negative when rewinding. Normal playback rate is 1.0.

The state must be one of the following:

Parameters
`state`	`int`: The current state of playback.
`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 `elapsedRealtime()` timebase that the position was updated at.

Returns
`PlaybackStateCompat.Builder`	this

Interfaces

Classes

Most visited

Recently visited

Results for

PlaybackStateCompat.Builder

Summary

Public constructors

Public methods

Inherited methods

Public constructors

PlaybackStateCompat.Builder

PlaybackStateCompat.Builder

Public methods

addCustomAction

addCustomAction

build

setActions

setActiveQueueItemId

setBufferedPosition

setErrorMessage

setExtras

setState

setState