MediaPlaybackTrait.PlaybackStateEnum
enum MediaPlaybackTrait.PlaybackStateEnum : Enum, ClusterEnum
Playback states.
Summary
Enum Values |
|
|---|---|
Buffering |
The media is not currently buffering, playback will start when buffer is filled. |
NotPlaying |
The media is not currently playing. |
Paused |
The media is currently paused. |
Playing |
The media is currently playing, fast-forwarding, or rewinding. |
UnknownValue |
The enum value is out of range. |
Public functions |
|
|---|---|
MediaPlaybackTrait.PlaybackStateEnum |
Returns the enum constant of this type with the specified name. |
Array<MediaPlaybackTrait.PlaybackStateEnum> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Public properties |
|
|---|---|
open String |
Trait identifier of the Matter Cluster that defines the enum Data Type. |
open String |
Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster. |
open ULong |
Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset. |
Enum Values
Buffering
val MediaPlaybackTrait.PlaybackStateEnum.Buffering: MediaPlaybackTrait.PlaybackStateEnum
The media is not currently buffering, playback will start when buffer is filled.
NotPlaying
val MediaPlaybackTrait.PlaybackStateEnum.NotPlaying: MediaPlaybackTrait.PlaybackStateEnum
The media is not currently playing.
Paused
val MediaPlaybackTrait.PlaybackStateEnum.Paused: MediaPlaybackTrait.PlaybackStateEnum
The media is currently paused.
Playing
val MediaPlaybackTrait.PlaybackStateEnum.Playing: MediaPlaybackTrait.PlaybackStateEnum
The media is currently playing, fast-forwarding, or rewinding.
UnknownValue
val MediaPlaybackTrait.PlaybackStateEnum.UnknownValue: MediaPlaybackTrait.PlaybackStateEnum
The enum value is out of range. For example, a newer Matter cluster definition may support enum values not yet supported by the Home APIs.
Public functions
valueOf
fun valueOf(value: String): MediaPlaybackTrait.PlaybackStateEnum
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if this enum type has no constant with the specified name |
values
fun values(): Array<MediaPlaybackTrait.PlaybackStateEnum>
Returns an array containing the constants of this enum type, in the order they're declared.
This method may be used to iterate over the constants.
Public properties
traitId
open val traitId: String
Trait identifier of the Matter Cluster that defines the enum Data Type. Refer to ClusterId.traitId for the format.