Class: Receiver

  • chrome.cast.Receiver objects describe a receiver running an application and are typically not created directly by the client.

  • Receivers have properties like friendlyName, capabilities, volume, and receiverType providing information about the device.

  • The label property uniquely identifies the receiver within the browser profile and origin, persisting across restarts unless local storage is cleared.

  • The displayStatus property, specific to custom receivers, controls the status displayed in the extension UI and can be set to null for idle.

  • While volume reflects the current receiver volume, isActiveInput indicates if the cast device is the active input source, if supported and detectable.

chrome.cast.Receiver

class   static

Describes the receiver running an application. Normally, these objects should not be created by the client.

Constructor

Receiver

new Receiver(label, friendlyName, capabilities, volume)

Parameter

label

string

An identifier for the receiver.

friendlyName

string

The user-visible name of the receiver.

capabilities

Optional

Array of non-null chrome.cast.Capability

Set of receiver capabilities.

Value must not be null.

volume

Optional

chrome.cast.Volume

The receiver's current volume.

Value must not be null.

Properties

capabilities

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

The capabilities of the receiver, for example audio and video.

displayStatus

nullable chrome.cast.ReceiverDisplayStatus

Receiver status shown to the user in the extension UI. Only valid for CUSTOM receivers. To show the receiver as idle, set displayStatus to null.

friendlyName

string

The user given name (URI-escaped) for the receiver. Mandatory.

isActiveInput

nullable boolean

The value reflects whether the cast device is the active input. If the HDMI input the Cast device is connected to supports CEC and the device can know the active status, this value will be provided. Otherwise, it is null.

label

string

An identifier for the receiver that is unique to the browser profile and the origin of the API client. It is stable across browser restarts, but may change if the user clears his local storage.

receiverType

non-null chrome.cast.ReceiverType

The type of receiver device. Mandatory.

volume

nullable chrome.cast.Volume

The current volume of the receiver. If non-null, the volume's level and muted properties will always be set.