Interface GlobalChromecast

The global Chromecast API.

interface GlobalChromecast {
    endSession(): void;
    initialize(configuration?: ChromecastConfiguration): PromiseLike<void>;
    startSession(): PromiseLike<void>;
}

Index

Methods

endSession initialize startSession

Methods

endSession

endSession(): void
Stop the active casting session.

Returns void

initialize

initialize(configuration?): PromiseLike<void>
Initialize the Chromecast framework.
Parameters
- Optionalconfiguration: ChromecastConfiguration
  Describes Chromecast specific options.
Returns PromiseLike<void>
Remarks

- If this method is not called, then the first created THEOplayer instance will automatically initialize the Chromecast framework.

startSession

startSession(): PromiseLike<void>
Start a casting session without a source.

Returns PromiseLike<void>
Remarks

- The Chromecast framework must be initialized before starting a session.