Class: Controls

AI-generated Key Takeaways

• The cast.framework.ui.Controls class provides an interface for configuring UI controls on touch-enabled devices for the Cast Web Receiver application.

• You can use the assignButton method to display custom buttons within predefined slots and clearDefaultSlotAssignments to remove default buttons.

• The hasMediaControlsOverlay method indicates whether a media overlay will be shown during playback, and setBrowseContent allows you to set media browse content for user discovery.

• Obtain an instance of the UI Controls using the getInstance static method.

cast.framework.ui.Controls

class   static

Touch Controls. Provides interface for configuring controls on touch-enabled devices.

Methods

getInstance

static

getInstance() returns cast.framework.ui.Controls

Returns the UI Controls instance.

Returns

cast.framework.ui.Controls An instance of the UI Controls.

assignButton

assignButton(slot, button)

Displays button in the specified slot.

Parameter
slot	cast.framework.ui.ControlsSlot Value must not be null.
button	cast.framework.ui.ControlsButton Value must not be null.

Throws

non-null Error if slot or button name is incorrect

clearDefaultSlotAssignments

clearDefaultSlotAssignments()

Remove all buttons assigned by default from slots.

hasMediaControlsOverlay

hasMediaControlsOverlay() returns Promise containing boolean

Signals whether the media controls overlay will be rendered during playback on top of the application UI.

Returns

non-null Promise containing boolean a promise that resolves to true if the media controls will be rendered and to false otherwise.

setBrowseContent

setBrowseContent(browseContent)

Set Media Browse content for users to discover more contents from your receiver.

Parameter
browseContent	cast.framework.ui.BrowseContent Value may be null.