Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 1.64 KB

README.md

File metadata and controls

53 lines (37 loc) · 1.64 KB

Plugin: AirPlay

Supports for Apple AirPlay API.

Overview
Name airplay
Global name¹ window.VlitejsAirPlay
Path vlitejs/dist/plugins/airplay
Entry point vlitejs/dist/plugins/airplay/airplay.js
Stylesheet vlitejs/dist/plugins/airplay/airplay.css
Provider² 'html5'
Media type³ 'video'
  • ¹ Useful only if vLitejs is included with a <script> tag (see CDN section).

Usage

HTML

<video id="player" class="vlite-js" src="<path_to_video_mp4>"></video>

JavaScript

import 'vlitejs/dist/vlite.css';
import 'vlitejs/dist/plugins/airplay.css';
import Vlitejs from 'vlitejs';
import VlitejsAirPlay from 'vlitejs/dist/plugins/airplay';

Vlitejs.registerPlugin('airplay', VlitejsAirPlay);

new Vlitejs('#player', {
  plugins: ['airplay']
});

Events

The plugin exposes the following native Event on the .v-vlite element.

Event Type Description
airplaysessionstarted Sent when the AirPlay session is established.
airplaysessionended Sent when the AirPlay session is disconnected.

Limits

The subtitle plugin does not display subtitles on the AirPlay screen.