MediaActionType enum

Specifies an action that the OS's background audio system may support.

Values are used both to request what actions are enabled (see AudioSystem.setSupportedMediaActionsMethod), and to specify what types of events have been received (see MediaEvent).

These inform both device displays (i.e. iOS lockscreen/control center) and external controllers (such as watches, auto displays, etc) on what controls to show.

Note that not all actions are supported on both Android and iOS.

Not yet supported:

  • cross-platform functionality: ratings/like/dislike, repeat mode, shuffle mode.
  • Android-specific functionality: playFromMediaId, playFromSearch, skipToQueueItem, playFromUri.
  • iOS-specific functionality: bookmark, language.
Inheritance

Constructors

MediaActionType()
const

Values

playPause → const MediaActionType
pause → const MediaActionType
play → const MediaActionType
stop → const MediaActionType
next → const MediaActionType
previous → const MediaActionType
seekForward → const MediaActionType
seekBackward → const MediaActionType
seekTo → const MediaActionType

Enables use seeking in the progress bar.

skipForward → const MediaActionType
skipBackward → const MediaActionType
custom → const MediaActionType

Only used when receiving a MediaEvent from an Android custom button.

Properties

hashCode int
The hash code for this object.
no setterinherited
index int
A numeric identifier for the enumerated value.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Constants

values → const List<MediaActionType>
A constant List of the values in this enum, in order of their declaration.