Interface BrandingInformation

This object defines Branding Information which can be provided by the client in order to customize the skin of the Video Player during playback.

See

MatterSpecification.v13.Cluster § 6.7.5.10

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

Hierarchy (view full)

Properties

background? logo? progressBar? providerName splash? waterMark?

Properties

Optionalbackground

background?: TypeFromFields<{
    color: OptionalFieldType<string>;
    imageUrl: OptionalFieldType<string>;
    size: OptionalFieldType<TypeFromFields<{
        height: FieldType<number>;
        metric: FieldType<ContentLauncher.MetricType>;
        width: FieldType<number>;
    }>>;
}>

This field shall indicate background of the Video Player while content launch request is being processed by it. This background information may also be used by the Video Player when it is in idle state.

Type declaration

  • color: OptionalFieldType<string>

    This field shall indicate the color, in RGB or RGBA, used for styling different Video Player sections like Logo, Watermark, etc. The value shall conform to the 6-digit or 8-digit format defined for CSS sRGB hexadecimal color notation [https://www.w3.org/TR/css-color-4/#hex-notation]. Examples:

    • #76DE19 for R=0x76, G=0xDE, B=0x19, A absent

    • #76DE1980 for R=0x76, G=0xDE, B=0x19, A=0x80

    See

    MatterSpecification.v13.Cluster § 6.7.5.9.2

  • imageUrl: OptionalFieldType<string>

    This field shall indicate the URL of image used for Styling different Video Player sections like Logo, Watermark etc.

    See

    MatterSpecification.v13.Cluster § 6.7.5.9.1

  • size: OptionalFieldType<TypeFromFields<{
        height: FieldType<number>;
        metric: FieldType<ContentLauncher.MetricType>;
        width: FieldType<number>;
    }>>

    This field shall indicate the size of the image used for Styling different Video Player sections like Logo, Watermark etc.

    See

    MatterSpecification.v13.Cluster § 6.7.5.9.3

See

MatterSpecification.v13.Cluster § 6.7.5.10.2

Optionallogo

logo?: TypeFromFields<{
    color: OptionalFieldType<string>;
    imageUrl: OptionalFieldType<string>;
    size: OptionalFieldType<TypeFromFields<{
        height: FieldType<number>;
        metric: FieldType<ContentLauncher.MetricType>;
        width: FieldType<number>;
    }>>;
}>

This field shall indicate the logo shown when the Video Player is launching. This is also used when the Video Player is in the idle state and Splash field is not available.

Type declaration

  • color: OptionalFieldType<string>

    This field shall indicate the color, in RGB or RGBA, used for styling different Video Player sections like Logo, Watermark, etc. The value shall conform to the 6-digit or 8-digit format defined for CSS sRGB hexadecimal color notation [https://www.w3.org/TR/css-color-4/#hex-notation]. Examples:

    • #76DE19 for R=0x76, G=0xDE, B=0x19, A absent

    • #76DE1980 for R=0x76, G=0xDE, B=0x19, A=0x80

    See

    MatterSpecification.v13.Cluster § 6.7.5.9.2

  • imageUrl: OptionalFieldType<string>

    This field shall indicate the URL of image used for Styling different Video Player sections like Logo, Watermark etc.

    See

    MatterSpecification.v13.Cluster § 6.7.5.9.1

  • size: OptionalFieldType<TypeFromFields<{
        height: FieldType<number>;
        metric: FieldType<ContentLauncher.MetricType>;
        width: FieldType<number>;
    }>>

    This field shall indicate the size of the image used for Styling different Video Player sections like Logo, Watermark etc.

    See

    MatterSpecification.v13.Cluster § 6.7.5.9.3

See

MatterSpecification.v13.Cluster § 6.7.5.10.3

OptionalprogressBar

progressBar?: TypeFromFields<{
    color: OptionalFieldType<string>;
    imageUrl: OptionalFieldType<string>;
    size: OptionalFieldType<TypeFromFields<{
        height: FieldType<number>;
        metric: FieldType<ContentLauncher.MetricType>;
        width: FieldType<number>;
    }>>;
}>

This field shall indicate the style of progress bar for media playback.

Type declaration

  • color: OptionalFieldType<string>

    This field shall indicate the color, in RGB or RGBA, used for styling different Video Player sections like Logo, Watermark, etc. The value shall conform to the 6-digit or 8-digit format defined for CSS sRGB hexadecimal color notation [https://www.w3.org/TR/css-color-4/#hex-notation]. Examples:

    • #76DE19 for R=0x76, G=0xDE, B=0x19, A absent

    • #76DE1980 for R=0x76, G=0xDE, B=0x19, A=0x80

    See

    MatterSpecification.v13.Cluster § 6.7.5.9.2

  • imageUrl: OptionalFieldType<string>

    This field shall indicate the URL of image used for Styling different Video Player sections like Logo, Watermark etc.

    See

    MatterSpecification.v13.Cluster § 6.7.5.9.1

  • size: OptionalFieldType<TypeFromFields<{
        height: FieldType<number>;
        metric: FieldType<ContentLauncher.MetricType>;
        width: FieldType<number>;
    }>>

    This field shall indicate the size of the image used for Styling different Video Player sections like Logo, Watermark etc.

    See

    MatterSpecification.v13.Cluster § 6.7.5.9.3

See

MatterSpecification.v13.Cluster § 6.7.5.10.4

providerName

providerName: string

This field shall indicate name of the provider for the given content.

See

MatterSpecification.v13.Cluster § 6.7.5.10.1

Optionalsplash

splash?: TypeFromFields<{
    color: OptionalFieldType<string>;
    imageUrl: OptionalFieldType<string>;
    size: OptionalFieldType<TypeFromFields<{
        height: FieldType<number>;
        metric: FieldType<ContentLauncher.MetricType>;
        width: FieldType<number>;
    }>>;
}>

This field shall indicate the screen shown when the Video Player is in an idle state. If this property is not populated, the Video Player shall default to logo or the provider name.

Type declaration

  • color: OptionalFieldType<string>

    This field shall indicate the color, in RGB or RGBA, used for styling different Video Player sections like Logo, Watermark, etc. The value shall conform to the 6-digit or 8-digit format defined for CSS sRGB hexadecimal color notation [https://www.w3.org/TR/css-color-4/#hex-notation]. Examples:

    • #76DE19 for R=0x76, G=0xDE, B=0x19, A absent

    • #76DE1980 for R=0x76, G=0xDE, B=0x19, A=0x80

    See

    MatterSpecification.v13.Cluster § 6.7.5.9.2

  • imageUrl: OptionalFieldType<string>

    This field shall indicate the URL of image used for Styling different Video Player sections like Logo, Watermark etc.

    See

    MatterSpecification.v13.Cluster § 6.7.5.9.1

  • size: OptionalFieldType<TypeFromFields<{
        height: FieldType<number>;
        metric: FieldType<ContentLauncher.MetricType>;
        width: FieldType<number>;
    }>>

    This field shall indicate the size of the image used for Styling different Video Player sections like Logo, Watermark etc.

    See

    MatterSpecification.v13.Cluster § 6.7.5.9.3

See

MatterSpecification.v13.Cluster § 6.7.5.10.5

OptionalwaterMark

waterMark?: TypeFromFields<{
    color: OptionalFieldType<string>;
    imageUrl: OptionalFieldType<string>;
    size: OptionalFieldType<TypeFromFields<{
        height: FieldType<number>;
        metric: FieldType<ContentLauncher.MetricType>;
        width: FieldType<number>;
    }>>;
}>

This field shall indicate watermark shown when the media is playing.

Type declaration

  • color: OptionalFieldType<string>

    This field shall indicate the color, in RGB or RGBA, used for styling different Video Player sections like Logo, Watermark, etc. The value shall conform to the 6-digit or 8-digit format defined for CSS sRGB hexadecimal color notation [https://www.w3.org/TR/css-color-4/#hex-notation]. Examples:

    • #76DE19 for R=0x76, G=0xDE, B=0x19, A absent

    • #76DE1980 for R=0x76, G=0xDE, B=0x19, A=0x80

    See

    MatterSpecification.v13.Cluster § 6.7.5.9.2

  • imageUrl: OptionalFieldType<string>

    This field shall indicate the URL of image used for Styling different Video Player sections like Logo, Watermark etc.

    See

    MatterSpecification.v13.Cluster § 6.7.5.9.1

  • size: OptionalFieldType<TypeFromFields<{
        height: FieldType<number>;
        metric: FieldType<ContentLauncher.MetricType>;
        width: FieldType<number>;
    }>>

    This field shall indicate the size of the image used for Styling different Video Player sections like Logo, Watermark etc.

    See

    MatterSpecification.v13.Cluster § 6.7.5.9.3

See

MatterSpecification.v13.Cluster § 6.7.5.10.6

Settings

Member Visibility

On This Page

Properties