Interface LaunchUrlRequest

Input to the ContentLauncher launchUrl command

See

MatterSpecification.v13.Cluster § 6.7.7.2

interface LaunchUrlRequest {
    brandingInformation?: TypeFromFields<{
        background: OptionalFieldType<TypeFromFields<{
            color: OptionalFieldType<string>;
            imageUrl: OptionalFieldType<string>;
            size: OptionalFieldType<TypeFromFields<{
                height: FieldType<number>;
                metric: FieldType<ContentLauncher.MetricType>;
                width: FieldType<number>;
            }>>;
        }>>;
        logo: OptionalFieldType<TypeFromFields<{
            color: OptionalFieldType<string>;
            imageUrl: OptionalFieldType<string>;
            size: OptionalFieldType<TypeFromFields<{
                height: FieldType<number>;
                metric: FieldType<ContentLauncher.MetricType>;
                width: FieldType<number>;
            }>>;
        }>>;
        progressBar: OptionalFieldType<TypeFromFields<{
            color: OptionalFieldType<string>;
            imageUrl: OptionalFieldType<string>;
            size: OptionalFieldType<TypeFromFields<{
                height: FieldType<number>;
                metric: FieldType<ContentLauncher.MetricType>;
                width: FieldType<number>;
            }>>;
        }>>;
        providerName: FieldType<string>;
        splash: OptionalFieldType<TypeFromFields<{
            color: OptionalFieldType<string>;
            imageUrl: OptionalFieldType<string>;
            size: OptionalFieldType<TypeFromFields<{
                height: FieldType<number>;
                metric: FieldType<ContentLauncher.MetricType>;
                width: FieldType<number>;
            }>>;
        }>>;
        waterMark: OptionalFieldType<TypeFromFields<{
            color: OptionalFieldType<string>;
            imageUrl: OptionalFieldType<string>;
            size: OptionalFieldType<TypeFromFields<{
                height: FieldType<number>;
                metric: FieldType<ContentLauncher.MetricType>;
                width: FieldType<number>;
            }>>;
        }>>;
    }>;
    contentUrl: string;
    displayString?: string;
    playbackPreferences?: TypeFromFields<{
        audioTracks: OptionalFieldType<null | TypeFromFields<{
            audioOutputIndex: OptionalFieldType<null | number>;
            characteristics: OptionalFieldType<null | (...)[]>;
            languageCode: FieldType<string>;
        }>[]>;
        playbackPosition: OptionalFieldType<null | number | bigint>;
        textTrack: OptionalFieldType<null | TypeFromFields<{
            audioOutputIndex: OptionalFieldType<null | number>;
            characteristics: OptionalFieldType<null | MediaPlayback.Characteristic[]>;
            languageCode: FieldType<string>;
        }>>;
    }>;
}

Hierarchy (view full)

Properties

brandingInformation? contentUrl displayString? playbackPreferences?

Properties

OptionalbrandingInformation

brandingInformation?: TypeFromFields<{
    background: OptionalFieldType<TypeFromFields<{
        color: OptionalFieldType<string>;
        imageUrl: OptionalFieldType<string>;
        size: OptionalFieldType<TypeFromFields<{
            height: FieldType<number>;
            metric: FieldType<ContentLauncher.MetricType>;
            width: FieldType<number>;
        }>>;
    }>>;
    logo: OptionalFieldType<TypeFromFields<{
        color: OptionalFieldType<string>;
        imageUrl: OptionalFieldType<string>;
        size: OptionalFieldType<TypeFromFields<{
            height: FieldType<number>;
            metric: FieldType<ContentLauncher.MetricType>;
            width: FieldType<number>;
        }>>;
    }>>;
    progressBar: OptionalFieldType<TypeFromFields<{
        color: OptionalFieldType<string>;
        imageUrl: OptionalFieldType<string>;
        size: OptionalFieldType<TypeFromFields<{
            height: FieldType<number>;
            metric: FieldType<ContentLauncher.MetricType>;
            width: FieldType<number>;
        }>>;
    }>>;
    providerName: FieldType<string>;
    splash: OptionalFieldType<TypeFromFields<{
        color: OptionalFieldType<string>;
        imageUrl: OptionalFieldType<string>;
        size: OptionalFieldType<TypeFromFields<{
            height: FieldType<number>;
            metric: FieldType<ContentLauncher.MetricType>;
            width: FieldType<number>;
        }>>;
    }>>;
    waterMark: OptionalFieldType<TypeFromFields<{
        color: OptionalFieldType<string>;
        imageUrl: OptionalFieldType<string>;
        size: OptionalFieldType<TypeFromFields<{
            height: FieldType<number>;
            metric: FieldType<ContentLauncher.MetricType>;
            width: FieldType<number>;
        }>>;
    }>>;
}>

This field, if present, shall indicate the branding information that may be displayed when playing back the given content.

Type declaration

See

MatterSpecification.v13.Cluster § 6.7.7.2.3

contentUrl

contentUrl: string

This field shall indicate the URL of content to launch.

See

MatterSpecification.v13.Cluster § 6.7.7.2.1

OptionaldisplayString

displayString?: string

This field, if present, shall provide a string that may be used to describe the content being accessed at the given URL.

See

MatterSpecification.v13.Cluster § 6.7.7.2.2

OptionalplaybackPreferences

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

This field, if present, shall indicate the user’s preferred Text/AudioTracks and playbackPosition for the media, sent from the client to the server. If the server does not find an available track for the title being played exactly matching a Track requested here, in the list of available tracks, it may default to picking another track that closely matches the requested track. Alternately, it may go with user preferences set on the server side (it will use this option if these PlaybackPreferences are not specified). In the case of text tracks, that may mean that the subtitle text is not displayed at all. In the cases where the preferred Text/AudioTracks are not available, the server shall return the TextTrackNotAvailable and/or AudioTrackNotAvailable Status(es) in the LauncherResponse.

Type declaration

  • audioTracks: OptionalFieldType<null | TypeFromFields<{
        audioOutputIndex: OptionalFieldType<null | number>;
        characteristics: OptionalFieldType<null | (...)[]>;
        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

  • playbackPosition: OptionalFieldType<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

  • textTrack: OptionalFieldType<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

See

MatterSpecification.v13.Cluster § 6.7.7.2.4

Settings

Member Visibility

On This Page

Properties