public static final class PlaybackStateCompat.CustomAction extends Object implements Parcelable
CustomActions
can be used to
extend the capabilities of the standard transport controls by exposing
app specific actions to Controllers
.Modifier and Type | Class and Description |
---|---|
static class |
PlaybackStateCompat.CustomAction.Builder
Builder for
PlaybackStateCompat.CustomAction objects. |
Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>
Modifier and Type | Field and Description |
---|---|
static Parcelable.Creator<PlaybackStateCompat.CustomAction> |
CREATOR |
CONTENTS_FILE_DESCRIPTOR, PARCELABLE_ELIDE_DUPLICATES, PARCELABLE_WRITE_RETURN_VALUE
Modifier and Type | Method and Description |
---|---|
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
PlaybackState.CustomAction object. |
String |
getAction()
Returns the action of the
PlaybackStateCompat.CustomAction . |
Object |
getCustomAction()
Gets the underlying framework
PlaybackState.CustomAction
object. |
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
Session's package. |
CharSequence |
getName()
Returns the display name of this action. e.g.
|
String |
toString()
Returns a string representation of the object.
|
void |
writeToParcel(Parcel dest,
int flags)
Flatten this object in to a Parcel.
|
public static final Parcelable.Creator<PlaybackStateCompat.CustomAction> CREATOR
public void writeToParcel(Parcel dest, int flags)
Parcelable
writeToParcel
in interface Parcelable
dest
- The Parcel in which the object should be written.flags
- Additional flags about how the object should be written.
May be 0 or Parcelable.PARCELABLE_WRITE_RETURN_VALUE
.public int describeContents()
Parcelable
Parcelable.writeToParcel(Parcel, int)
,
the return value of this method must include the
Parcelable.CONTENTS_FILE_DESCRIPTOR
bit.describeContents
in interface Parcelable
Parcelable.CONTENTS_FILE_DESCRIPTOR
public static PlaybackStateCompat.CustomAction fromCustomAction(Object customActionObj)
PlaybackState.CustomAction
object.
This method is only supported on API 21+.
customActionObj
- A PlaybackState.CustomAction
object,
or null if none.PlaybackStateCompat.CustomAction
object, or null if none.public Object getCustomAction()
PlaybackState.CustomAction
object.
This method is only supported on API 21+.
PlaybackState.CustomAction
object,
or null if none.public String getAction()
PlaybackStateCompat.CustomAction
.PlaybackStateCompat.CustomAction
.public CharSequence getName()
PlaybackStateCompat.CustomAction
.public int getIcon()
Session's
package.Session's
package.public Bundle getExtras()
MediaControllerCompat
if it knows
how to handle them.PlaybackStateCompat.CustomAction
.public String toString()
Object
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())