Skip to main content

Class: Player

Represents a Vindral player

// minimal configuration of a Vindral web player
const instance = new Player({
  url: "https://lb.cdn.vindral.com",
  channelId: "vindral_demo1_ci_099ee1fa-80f3-455e-aa23-3d184e93e04f",
})

Properties​

airPlaySender​

• Optional Readonly airPlaySender: AirPlaySender

The AirPlaySender instance

castSender​

• Readonly castSender: CastSender

The CastSender instance

core​

• Readonly core: Vindral

The Vindral instance

Methods​

attach​

▸ attach(container): void

Attaches the Player root node to a container

Parameters​

NameType
containerHTMLElement

Returns​

void

enterFullscreen​

▸ enterFullscreen(): Promise<void>

Enter fullscreen mode

Returns​

Promise<void>

exitFullscreen​

▸ exitFullscreen(): Promise<void>

Exit fullscreen mode

Returns​

Promise<void>

isInFullscreen​

▸ isInFullscreen(): boolean

Returns true if the player is currently in fullscreen mode

Returns​

boolean

showAirPlayPicker​

▸ showAirPlayPicker(): void

Show the AirPlay picker

Returns​

void

unload​

▸ unload(): void

Fully unloads the Player and the Vindral instance.

Returns​

void