Class: Controls

  • The cast.framework.ui.Controls class provides an interface for configuring controls on touch-enabled devices.

  • You can get an instance of the UI Controls using the getInstance() method.

  • The assignButton() method allows you to display a specific button in a designated slot.

  • The clearDefaultSlotAssignments() method removes all buttons assigned by default from slots.

  • The hasMediaControlsOverlay() method returns a promise indicating whether a media controls overlay will be rendered during playback.

  • The setBrowseContent() method allows you to set Media Browse content for users to discover more content.

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.