MediaPlaybackTrait.CharacteristicEnum
enum MediaPlaybackTrait.CharacteristicEnum : Enum, ClusterEnum
Track characteristics.
Summary
Enum Values |
|
|---|---|
Alternate |
Textual media component containing transcriptions of spoken dialog and auditory cues such as sound effects and music for the hearing impaired. |
Caption |
Textual media component containing transcriptions of spoken dialog and auditory cues such as sound effects and music for the hearing impaired. |
Commentary |
Experience that contains a commentary (e.g. director’s commentary) (typically audio). |
DescribesVideo |
Textual or audio media component containing a textual description (intended for audio synthesis) or an audio description describing a visual component. |
Description |
Textual or audio media component containing a textual description (intended for audio synthesis) or an audio description describing a visual component. |
DubbedTranslation |
Experience that contains an element that is presented in a different language from the original (e.g. dubbed audio, translated captions). |
EasyToRead |
Simplified or reduced captions as specified in United States Code Title 47 CFR 79.103(c)(9). |
Emergency |
Experience that provides information, about a current emergency, that is intended to enable the protection of life, health, safety, and property, and may also include critical details regarding the emergency and how to respond to the emergency. |
EnhancedAudioIntelligibility |
Experience containing an element for improved intelligibility of the dialogue. |
ForcedSubtitles |
Textual information meant for display when no other text representation is selected. |
FrameBased |
A media characteristic that indicates that a track selection option includes frame-based content. |
Karaoke |
Textual representation of a songs’ lyrics, usually in the same language as the associated song as specified in SMPTE ST 2067-2. |
MainProgram |
Main media component(s) which is/are intended for presentation if no other information is provided. |
Metadata |
Media component containing information intended to be processed by application specific elements. |
OriginalContent |
A media characteristic that indicates that a track or media selection option contains original content. |
Subtitle |
Textual transcriptions of spoken dialog. |
Supplementary |
Media content component that is supplementary to a media content component of a different media component type. |
UnknownValue |
The enum value is out of range. |
VoiceOverTranslation |
A media characteristic that indicates that a track or media selection option contains a language translation and verbal interpretation of spoken dialog. |
Public functions |
|
|---|---|
String |
|
MediaPlaybackTrait.CharacteristicEnum |
Returns the enum constant of this type with the specified name. |
Array<MediaPlaybackTrait.CharacteristicEnum> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Public properties |
|
|---|---|
EnumEntries<MediaPlaybackTrait.CharacteristicEnum> |
Returns a representation of an immutable list of all enum entries, in the order they're declared. |
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
Alternate
val MediaPlaybackTrait.CharacteristicEnum.Alternate: MediaPlaybackTrait.CharacteristicEnum
Textual media component containing transcriptions of spoken dialog and auditory cues such as sound effects and music for the hearing impaired.
Caption
val MediaPlaybackTrait.CharacteristicEnum.Caption: MediaPlaybackTrait.CharacteristicEnum
Textual media component containing transcriptions of spoken dialog and auditory cues such as sound effects and music for the hearing impaired.
Commentary
val MediaPlaybackTrait.CharacteristicEnum.Commentary: MediaPlaybackTrait.CharacteristicEnum
Experience that contains a commentary (e.g. director’s commentary) (typically audio).
DescribesVideo
val MediaPlaybackTrait.CharacteristicEnum.DescribesVideo: MediaPlaybackTrait.CharacteristicEnum
Textual or audio media component containing a textual description (intended for audio synthesis) or an audio description describing a visual component.
Description
val MediaPlaybackTrait.CharacteristicEnum.Description: MediaPlaybackTrait.CharacteristicEnum
Textual or audio media component containing a textual description (intended for audio synthesis) or an audio description describing a visual component.
DubbedTranslation
val MediaPlaybackTrait.CharacteristicEnum.DubbedTranslation: MediaPlaybackTrait.CharacteristicEnum
Experience that contains an element that is presented in a different language from the original (e.g. dubbed audio, translated captions).
EasyToRead
val MediaPlaybackTrait.CharacteristicEnum.EasyToRead: MediaPlaybackTrait.CharacteristicEnum
Simplified or reduced captions as specified in United States Code Title 47 CFR 79.103(c)(9).
Emergency
val MediaPlaybackTrait.CharacteristicEnum.Emergency: MediaPlaybackTrait.CharacteristicEnum
Experience that provides information, about a current emergency, that is intended to enable the protection of life, health, safety, and property, and may also include critical details regarding the emergency and how to respond to the emergency.
EnhancedAudioIntelligibility
val MediaPlaybackTrait.CharacteristicEnum.EnhancedAudioIntelligibility: MediaPlaybackTrait.CharacteristicEnum
Experience containing an element for improved intelligibility of the dialogue.
ForcedSubtitles
val MediaPlaybackTrait.CharacteristicEnum.ForcedSubtitles: MediaPlaybackTrait.CharacteristicEnum
Textual information meant for display when no other text representation is selected.
FrameBased
val MediaPlaybackTrait.CharacteristicEnum.FrameBased: MediaPlaybackTrait.CharacteristicEnum
A media characteristic that indicates that a track selection option includes frame-based content.
Karaoke
val MediaPlaybackTrait.CharacteristicEnum.Karaoke: MediaPlaybackTrait.CharacteristicEnum
Textual representation of a songs’ lyrics, usually in the same language as the associated song as specified in SMPTE ST 2067-2.
MainProgram
val MediaPlaybackTrait.CharacteristicEnum.MainProgram: MediaPlaybackTrait.CharacteristicEnum
Main media component(s) which is/are intended for presentation if no other information is provided.
Metadata
val MediaPlaybackTrait.CharacteristicEnum.Metadata: MediaPlaybackTrait.CharacteristicEnum
Media component containing information intended to be processed by application specific elements.
OriginalContent
val MediaPlaybackTrait.CharacteristicEnum.OriginalContent: MediaPlaybackTrait.CharacteristicEnum
A media characteristic that indicates that a track or media selection option contains original content.
Subtitle
val MediaPlaybackTrait.CharacteristicEnum.Subtitle: MediaPlaybackTrait.CharacteristicEnum
Textual transcriptions of spoken dialog.
Supplementary
val MediaPlaybackTrait.CharacteristicEnum.Supplementary: MediaPlaybackTrait.CharacteristicEnum
Media content component that is supplementary to a media content component of a different media component type.
UnknownValue
val MediaPlaybackTrait.CharacteristicEnum.UnknownValue: MediaPlaybackTrait.CharacteristicEnum
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.
VoiceOverTranslation
val MediaPlaybackTrait.CharacteristicEnum.VoiceOverTranslation: MediaPlaybackTrait.CharacteristicEnum
A media characteristic that indicates that a track or media selection option contains a language translation and verbal interpretation of spoken dialog.
Public functions
valueOf
fun valueOf(value: String): MediaPlaybackTrait.CharacteristicEnum
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.CharacteristicEnum>
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
entries
val entries: EnumEntries<MediaPlaybackTrait.CharacteristicEnum>
Returns a representation of an immutable list of all enum entries, in the order they're declared.
This method may be used to iterate over the enum entries.
traitId
open val traitId: String
Trait identifier of the Matter Cluster that defines the enum Data Type. Refer to ClusterId.traitId for the format.