ContentLauncherTrait.BrandingInformationStruct
class ContentLauncherTrait.BrandingInformationStruct : ClusterStruct
Branding information that customizes the video player skin.
Summary
Nested types |
|---|
@HomeExperimentalGenericApiDescriptor enum for this struct's fields. |
Public constructors |
|---|
BrandingInformationStruct(Creates the BrandingInformationStruct 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<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 |
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
@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
background
val background: OptionalValue<ContentLauncherTrait.StyleInformationStruct>
Background of the video player while it is processing a content launch request.
logo
val logo: OptionalValue<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 progressBar: OptionalValue<ContentLauncherTrait.StyleInformationStruct>
The style of progress bar for media playback.
splash
val splash: OptionalValue<ContentLauncherTrait.StyleInformationStruct>
The screen shown when the video player is in an idle state.
waterMark
val waterMark: OptionalValue<ContentLauncherTrait.StyleInformationStruct>
The watermark shown when the media is playing.