Interface Cast

The cast API.

interface Cast {
    airplay?: AirPlay;
    casting: boolean;
    chromecast?: Chromecast;
    addEventListener<TType extends "castingchange">(
        type: TType | readonly TType[],
        listener: EventListener<CastEventMap[TType]>,
    ): void;
    removeEventListener<TType extends "castingchange">(
        type: TType | readonly TType[],
        listener: EventListener<CastEventMap[TType]>,
    ): void;
}

Hierarchy (View Summary)

EventDispatcher<CastEventMap>
- Cast

Index

Properties

airplay? casting chromecast?

Methods

addEventListener removeEventListener

Properties

`Optional`airplay

airplay?: AirPlay

The Airplay integration API.

Remarks

- Only available with the feature 'airplay'.

casting

casting: boolean

Whether the player is connected with a casting device.

`Optional`chromecast

chromecast?: Chromecast

The Chromecast integration API.

Remarks

- Only available with the feature 'chromecast'.

Methods

addEventListener

addEventListener<TType extends "castingchange">(
type: TType | readonly TType[],
listener: EventListener<CastEventMap[TType]>,
): void
Add the given listener for the given event type(s).
Type Parameters
- TType extends "castingchange"
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<CastEventMap[TType]>
  The callback which is executed when the event occurs.
Returns void
Inherited from EventDispatcher.addEventListener

removeEventListener

removeEventListener<TType extends "castingchange">(
type: TType | readonly TType[],
listener: EventListener<CastEventMap[TType]>,
): void
Remove the given listener for the given event type(s).
Type Parameters
- TType extends "castingchange"
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<CastEventMap[TType]>
  The callback which will be removed.
Returns void
Inherited from EventDispatcher.removeEventListener