PlaybackState.CustomAction
public
static
final
class
PlaybackState.CustomAction
extends Object
implements
Parcelable
java.lang.Object | |
↳ | android.media.session.PlaybackState.CustomAction |
CustomActions
can be used to extend the capabilities of
the standard transport controls by exposing app specific actions to
MediaControllers
.
Summary
Nested classes | |
---|---|
class |
PlaybackState.CustomAction.Builder
Builder for |
Inherited constants |
---|
Fields | |
---|---|
public
static
final
Creator<PlaybackState.CustomAction> |
CREATOR
|
Public methods | |
---|---|
int
|
describeContents()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
String
|
getAction()
Returns the action of the |
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()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
---|---|
Fields
Public methods
describeContents
public int describeContents ()
Describe the kinds of special objects contained in this Parcelable
instance's marshaled representation. For example, if the object will
include a file descriptor in the output of writeToParcel(android.os.Parcel, int)
,
the return value of this method must include the
CONTENTS_FILE_DESCRIPTOR
bit.
Returns | |
---|---|
int |
a bitmask indicating the set of special object types marshaled
by this Parcelable object instance.
Value is either 0 or CONTENTS_FILE_DESCRIPTOR |
getAction
public String getAction ()
Returns the action of the CustomAction
.
Returns | |
---|---|
String |
The action of the CustomAction . |
getExtras
public 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
MediaController
if it knows how to handle them.
Returns | |
---|---|
Bundle |
Optional arguments for the CustomAction . |
getIcon
public int getIcon ()
Returns the resource id of the icon in the MediaSession's
package.
Returns | |
---|---|
int |
The resource id of the icon in the MediaSession's package. |
getName
public CharSequence getName ()
Returns the display name of this action. e.g. "Favorite"
Returns | |
---|---|
CharSequence |
The display name of this CustomAction . |
toString
public String toString ()
Returns a string representation of the object.
Returns | |
---|---|
String |
a string representation of the object. |
writeToParcel
public void writeToParcel (Parcel dest, int flags)
Flatten this object in to a Parcel.
Parameters | |
---|---|
dest |
Parcel : The Parcel in which the object should be written.
This value cannot be null . |
flags |
int : Additional flags about how the object should be written.
May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE .
Value is either 0 or a combination of Parcelable.PARCELABLE_WRITE_RETURN_VALUE , and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES |
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.