ContentLauncherTrait.TrackPreferenceStruct

class ContentLauncherTrait.TrackPreferenceStruct : ClusterStruct


Defines Text/Audio Track preferences.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors

TrackPreferenceStruct(
    languageCode: String,
    characteristics: OptionalValue<List<ContentLauncherTrait.CharacteristicEnum>>,
    audioOutputIndex: UByte
)

Creates the TrackPreferenceStruct class.

Public functions

open StructDescriptor

Returns the descriptor for the struct.

open Any?

Returns the value of the field for the given tag ID.

Public properties

UByte

Indicates which audio output the Audio Track should be played on.

OptionalValue<List<ContentLauncherTrait.CharacteristicEnum>>

Indicate a purpose, trait or feature associated with the Track.

String

Identifies the primary language used in the Track.

Public constructors

TrackPreferenceStruct

TrackPreferenceStruct(
    languageCode: String = "",
    characteristics: OptionalValue<List<ContentLauncherTrait.CharacteristicEnum>> = OptionalValue.absent(),
    audioOutputIndex: UByte
)

Creates the TrackPreferenceStruct class.

Public functions

getDescriptor

@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?

Returns the value of the field for the given tag ID.

Public properties

audioOutputIndex

val audioOutputIndexUByte

Indicates which audio output the Audio Track should be played on.

characteristics

val characteristicsOptionalValue<List<ContentLauncherTrait.CharacteristicEnum>>

Indicate a purpose, trait or feature associated with the Track.

languageCode

val languageCodeString

Identifies the primary language used in the Track.