Class: UiConfig
Stay organized with collections
Save and categorize content based on your preferences.
Page Summary
-
cast.framework.ui.UiConfigis a class for configuring the user interface of a Cast receiver application. -
The
touchScreenOptimizedAppproperty inUiConfiginforms the SDK if the receiver application supports an interactive UI, which affects UI control assignments and the presentation of a scrim over content. -
Setting
touchScreenOptimizedAppto true enables configurable ControlsSlots and a transparent scrim, while setting it to false or leaving it undefined results in non-configurable ControlsSlots and an opaque scrim. -
The
touchScreenOptimizedAppflag is set by default when using thecast-media-playerelement for interactive devices but has no effect on non-interactive devices.
cast.framework.ui. UiConfig
UI Configuration.
Constructor
UiConfig
new UiConfig()
Property
touchScreenOptimizedApp
(boolean or undefined)
If set, the SDK will be notified that the receiver application is configured to support an interactive UI. This allows the receiver to modify the UI ControlsSlot assignments and shows a transparent scrim over the content when presented. If disabled, the ControlsSlots are not configurable and the scrim presented is opaque. When playing audio content the default UI will replace any custom UI. This flag is set by default when using the cast-media-player element. For non-interactive devices this flag has no effect. For these devices if using the cast-media-player element, the SDK will render default UI. If using a custom media element the SDK will rely on the receiver application to define the UI components.