Class: ReceiverDisplayStatus

  • chrome.cast.ReceiverDisplayStatus provides status information about a Cast receiver, primarily for custom receivers, for display in the extension UI.

  • It includes properties like statusText (text description of the status), appImages (images related to the app), and showStop (whether the user can stop the application).

  • The constructor takes statusText and appImages as arguments to initialize the status object.

  • appImages is an array of chrome.cast.Image objects, while showStop is a boolean indicating user control over stopping the application, defaulting to the extension's or receiver's behavior if null.

chrome.cast.ReceiverDisplayStatus

class   static

Receiver status shown to the user in the extension UI. Only valid for CUSTOM receivers.

Constructor

ReceiverDisplayStatus

new ReceiverDisplayStatus(statusText, appImages)

Parameter

statusText

string

Description of current application status in plain text, for example, name of the content being shown.

appImages

Array of non-null chrome.cast.Image

Images associated with the app.

Value must not be null.

Properties

appImages

non-null Array of non-null chrome.cast.Image

Array of images available describing the application.

showStop

nullable boolean

Whether the user is offered the choice to stop the application.

The default value is null, which means extension chooses a default for CUSTOM receivers, and detect DELETE availability for DIAL receivers. |true| means the user can request to stop the application and |false| means they cannot.

statusText

string

Descriptive text for the current application content, for example “My Wedding Slideshow”.