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.
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()
Describe the kinds of special objects contained in this Parcelable instance's marshaled representation. |
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()
Returns a string representation of the object. |
void
|
writeToParcel(Parcel dest, int flags)
Flatten this object in to a Parcel. |
Inherited methods | |
|---|---|
From
class
java.lang.Object
| |
From
interface
android.os.Parcelable
| |
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(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. |
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.
|
String getAction ()
Returns the action of the PlaybackStateCompat.CustomAction.
| Returns | |
|---|---|
String |
The action of the PlaybackStateCompat.CustomAction.
|
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.
|
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.
|
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.
|
CharSequence getName ()
Returns the display name of this action. e.g. "Favorite"
| Returns | |
|---|---|
CharSequence |
The display name of this PlaybackStateCompat.CustomAction.
|
String toString ()
Returns a string representation of the object. In general, the
toString method returns a string that
"textually represents" this object. The result should
be a concise but informative representation that is easy for a
person to read.
It is recommended that all subclasses override this method.
The toString method for class Object
returns a string consisting of the name of the class of which the
object is an instance, the at-sign character `@', and
the unsigned hexadecimal representation of the hash code of the
object. In other words, this method returns a string equal to the
value of:
getClass().getName() + '@' + Integer.toHexString(hashCode())
| Returns | |
|---|---|
String |
a string representation of the object. |
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. |
flags |
int:
Additional flags about how the object should be written.
May be 0 or PARCELABLE_WRITE_RETURN_VALUE.
|
Developers