ContentLauncherTrait.BrandingInformationStruct

class ContentLauncherTrait.BrandingInformationStruct : ClusterStruct


Branding information that customizes the video player skin.

Summary

Nested types

Descriptor enum for this struct's fields.

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<ContentLauncherTrait.StyleInformationStruct>

Background of the video player while it is processing a content launch request.

OptionalValue<ContentLauncherTrait.StyleInformationStruct>

The logo shown when the video player is launching, and when it is idle and the splash field isn't defined.

OptionalValue<ContentLauncherTrait.StyleInformationStruct>

The style of progress bar for media playback.

String

The name of the content provider.

OptionalValue<ContentLauncherTrait.StyleInformationStruct>

The screen shown when the video player is in an idle state.

OptionalValue<ContentLauncherTrait.StyleInformationStruct>

The watermark shown when the media is playing.

Public constructors

BrandingInformationStruct

BrandingInformationStruct(
    providerName: String = "",
    background: OptionalValue<ContentLauncherTrait.StyleInformationStruct> = OptionalValue.absent(),
    logo: OptionalValue<ContentLauncherTrait.StyleInformationStruct> = OptionalValue.absent(),
    progressBar: OptionalValue<ContentLauncherTrait.StyleInformationStruct> = OptionalValue.absent(),
    splash: OptionalValue<ContentLauncherTrait.StyleInformationStruct> = OptionalValue.absent(),
    waterMark: OptionalValue<ContentLauncherTrait.StyleInformationStruct> = OptionalValue.absent()
)

Creates the BrandingInformationStruct class.

Public functions

getDescriptor

@HomeExperimentalApi
open fun getDescriptor(): StructDescriptor

Returns the descriptor for the struct.

getFieldValueById

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

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

Public properties

background

val backgroundOptionalValue<ContentLauncherTrait.StyleInformationStruct>

Background of the video player while it is processing a content launch request.

logo

val logoOptionalValue<ContentLauncherTrait.StyleInformationStruct>

The logo shown when the video player is launching, and when it is idle and the splash field isn't defined.

progressBar

val progressBarOptionalValue<ContentLauncherTrait.StyleInformationStruct>

The style of progress bar for media playback.

providerName

val providerNameString

The name of the content provider.

splash

val splashOptionalValue<ContentLauncherTrait.StyleInformationStruct>

The screen shown when the video player is in an idle state.

waterMark

val waterMarkOptionalValue<ContentLauncherTrait.StyleInformationStruct>

The watermark shown when the media is playing.