ContentLauncherTrait.PlaybackPreferencesStruct

class ContentLauncherTrait.PlaybackPreferencesStruct : ClusterStruct


Preferences sent by the client to the receiver.

Summary

Nested types

Descriptor enum for this struct's fields.

Public constructors

Creates the PlaybackPreferencesStruct 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

OptionalValue<List<ContentLauncherTrait.TrackPreferenceStruct>>

The list of the user’s preferred Audio Tracks.

ULong

The preferred position in the media to launch playback from.

ContentLauncherTrait.TrackPreferenceStruct

The user’s preferred Text Track.

Public constructors

PlaybackPreferencesStruct

PlaybackPreferencesStruct(
    playbackPosition: ULong,
    textTrack: ContentLauncherTrait.TrackPreferenceStruct = TrackPreferenceStruct(),
    audioTracks: OptionalValue<List<ContentLauncherTrait.TrackPreferenceStruct>> = OptionalValue.absent()
)

Creates the PlaybackPreferencesStruct 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

audioTracks

val audioTracksOptionalValue<List<ContentLauncherTrait.TrackPreferenceStruct>>

The list of the user’s preferred Audio Tracks.

playbackPosition

val playbackPositionULong

The preferred position in the media to launch playback from.

textTrack

val textTrackContentLauncherTrait.TrackPreferenceStruct

The user’s preferred Text Track.