MediaPlaybackTrait.StatusEnum
enum MediaPlaybackTrait.StatusEnum : Enum, ClusterEnum
Playback statuses.
Summary
Enum Values |
|
|---|---|
InvalidStateForCommand |
Command failed: Requested playback command is invalid in the current playback state. |
NotActive |
Command failed: This endpoint is not active for playback. |
NotAllowed |
Command failed: The requested playback command is not allowed in the current playback state. |
SeekOutOfRange |
Command failed: The |
SpeedOutOfRange |
Command failed: The |
Success |
Command succeeded. |
UnknownValue |
The enum value is out of range. |
Public functions |
|
|---|---|
MediaPlaybackTrait.StatusEnum |
Returns the enum constant of this type with the specified name. |
Array<MediaPlaybackTrait.StatusEnum> |
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
InvalidStateForCommand
val MediaPlaybackTrait.StatusEnum.InvalidStateForCommand: MediaPlaybackTrait.StatusEnum
Command failed: Requested playback command is invalid in the current playback state.
NotActive
val MediaPlaybackTrait.StatusEnum.NotActive: MediaPlaybackTrait.StatusEnum
Command failed: This endpoint is not active for playback.
NotAllowed
val MediaPlaybackTrait.StatusEnum.NotAllowed: MediaPlaybackTrait.StatusEnum
Command failed: The requested playback command is not allowed in the current playback state. For example, attempting to fast-forward during a commercial might return NotAllowed.
SeekOutOfRange
val MediaPlaybackTrait.StatusEnum.SeekOutOfRange: MediaPlaybackTrait.StatusEnum
Command failed: The Seek command was issued with a specified position that is outside the allowed seek range of the media.
SpeedOutOfRange
val MediaPlaybackTrait.StatusEnum.SpeedOutOfRange: MediaPlaybackTrait.StatusEnum
Command failed: The FastForward command or Rewind command was issued but the media is already playing back at the fastest speed supported by the server in the respective direction.
UnknownValue
val MediaPlaybackTrait.StatusEnum.UnknownValue: MediaPlaybackTrait.StatusEnum
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.StatusEnum
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.StatusEnum>
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.