Interface PlaybackPreferences

PlaybackPreferencesStruct defines the preferences sent by the client to the receiver in the ContentLauncher LaunchURL or LaunchContent commands.

See

MatterSpecification.v13.Cluster § 6.7.5.11

interface PlaybackPreferences {
    audioTracks?: null | TypeFromFields<{
        audioOutputIndex: OptionalFieldType<null | number>;
        characteristics: OptionalFieldType<null | MediaPlayback.Characteristic[]>;
        languageCode: FieldType<string>;
    }>[];
    playbackPosition?: null | number | bigint;
    textTrack?: null | TypeFromFields<{
        audioOutputIndex: OptionalFieldType<null | number>;
        characteristics: OptionalFieldType<null | MediaPlayback.Characteristic[]>;
        languageCode: FieldType<string>;
    }>;
}

Hierarchy (view full)

Properties

audioTracks? playbackPosition? textTrack?

Properties

OptionalaudioTracks

audioTracks?: null | TypeFromFields<{
    audioOutputIndex: OptionalFieldType<null | number>;
    characteristics: OptionalFieldType<null | MediaPlayback.Characteristic[]>;
    languageCode: FieldType<string>;
}>[]

This field shall indicate the list of the user’s preferred Audio Tracks. If the list contains multiple values, each AudioTrack must also specify a unique audioOutputIndex to play the track on. A value of null shall indicate that the user did not specify a preferred Audio Track on the client. In such a case, the decision to play and select an Audio Track is up to the server.

See

MatterSpecification.v13.Cluster § 6.7.5.11.3

OptionalplaybackPosition

playbackPosition?: null | number | bigint

This field shall indicate the preferred position (in milliseconds) in the media to launch playback from. In case the position falls in the middle of a frame, the server shall set the position to the beginning of that frame and set the SampledPosition attribute on the MediaPlayback cluster accordingly. A value of null shall indicate that playback position is not applicable for the current state of the media playback.

ported).

See

MatterSpecification.v13.Cluster § 6.7.5.11.1

OptionaltextTrack

textTrack?: null | TypeFromFields<{
    audioOutputIndex: OptionalFieldType<null | number>;
    characteristics: OptionalFieldType<null | MediaPlayback.Characteristic[]>;
    languageCode: FieldType<string>;
}>

This field shall indicate the user’s preferred Text Track. A value of null shall indicate that the user did not specify a preferred Text Track on the client. In such a case, the decision to display and select a Text Track is up to the server.

See

MatterSpecification.v13.Cluster § 6.7.5.11.2

Settings

Member Visibility

On This Page

Properties