belongs to Maven artifact com.android.support:support-media-compat:28.0.0-alpha1
PlaybackStateCompat.CustomAction
public
static
final
class
PlaybackStateCompat.CustomAction
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.support.v4.media.session.PlaybackStateCompat.CustomAction |
CustomActions
can be used to
extend the capabilities of the standard transport controls by exposing
app specific actions to Controllers
.
Summary
Nested classes | |
---|---|
class |
PlaybackStateCompat.CustomAction.Builder
Builder for |
Inherited constants |
---|
From
interface
android.os.Parcelable
|
Fields | |
---|---|
public
static
final
Creator<PlaybackStateCompat.CustomAction> |
CREATOR
|
Public methods | |
---|---|
int
|
describeContents()
|
static
PlaybackStateCompat.CustomAction
|
fromCustomAction(Object customActionObj)
Creates an instance from a framework
|
String
|
getAction()
Returns the action of the |
Object
|
getCustomAction()
Gets the underlying framework |
Bundle
|
getExtras()
Returns extras which provide additional application-specific information about the action, or null if none. |
int
|
getIcon()
Returns the resource id of the icon in the |
CharSequence
|
getName()
Returns the display name of this action. |
String
|
toString()
|
void
|
writeToParcel(Parcel dest, int flags)
|
Inherited methods | |
---|---|
From
class
java.lang.Object
| |
From
interface
android.os.Parcelable
|
Fields
Public methods
fromCustomAction
PlaybackStateCompat.CustomAction fromCustomAction (Object customActionObj)
Creates an instance from a framework
PlaybackState.CustomAction
object.
This method is only supported on API 21+.
Parameters | |
---|---|
customActionObj |
Object : A PlaybackState.CustomAction object,
or null if none. |
Returns | |
---|---|
PlaybackStateCompat.CustomAction |
An equivalent PlaybackStateCompat.CustomAction object, or null if none.
|
getAction
String getAction ()
Returns the action of the PlaybackStateCompat.CustomAction
.
Returns | |
---|---|
String |
The action of the PlaybackStateCompat.CustomAction .
|
getCustomAction
Object getCustomAction ()
Gets the underlying framework PlaybackState.CustomAction
object.
This method is only supported on API 21+.
Returns | |
---|---|
Object |
An equivalent PlaybackState.CustomAction object,
or null if none.
|
getExtras
Bundle getExtras ()
Returns extras which provide additional application-specific
information about the action, or null if none. These arguments are
meant to be consumed by a MediaControllerCompat
if it knows
how to handle them.
Returns | |
---|---|
Bundle |
Optional arguments for the PlaybackStateCompat.CustomAction .
|
getIcon
int getIcon ()
Returns the resource id of the icon in the Session's
package.
Returns | |
---|---|
int |
The resource id of the icon in the Session's package.
|
getName
CharSequence getName ()
Returns the display name of this action. e.g. "Favorite"
Returns | |
---|---|
CharSequence |
The display name of this PlaybackStateCompat.CustomAction .
|
toString
String toString ()
Returns | |
---|---|
String |
writeToParcel
void writeToParcel (Parcel dest, int flags)
Parameters | |
---|---|
dest |
Parcel |
flags |
int |
Interfaces
Classes
- MediaButtonReceiver
- MediaControllerCompat
- MediaControllerCompat.Callback
- MediaControllerCompat.PlaybackInfo
- MediaControllerCompat.TransportControls
- MediaSessionCompat
- MediaSessionCompat.Callback
- MediaSessionCompat.QueueItem
- MediaSessionCompat.Token
- ParcelableVolumeInfo
- PlaybackStateCompat
- PlaybackStateCompat.Builder
- PlaybackStateCompat.CustomAction
- PlaybackStateCompat.CustomAction.Builder
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2024-04-11 UTC.