Boot

ID: vBoot | Type: Plugin

This plugin installs the following plugins:

• Icons
• Poster
• Scrim
• Spinner
• Captions
• Controls
• Settings
• ActionDisplay
• Tooltips
• Keyboard
• ClickToPlay
• DblClickFullscreen

Setup

Basic

import { Player, Boot } from '@vime-js/complete';

// ...

const player = new Player({

target,

props: {

plugins: [Boot],

},

});

Manager

import { Player, Boot } from '@vime-js/complete';

// ...

player

.getPluginsManager()

.addPlugin(Boot)

.then(boot => {

// ...

});

Props

manifest

Type: { [id]: boolean } | Default: All plugins default to true.

The manifest determines which plugins should be installed. All plugins are identified by their ID with the v prefix removed and first letter lowercased.

• vControls = controls
• vActionDisplay = actionDisplay
• vClickToPlay = clickToPlay

JavaScript

import { Player, Boot } from '@vime-js/complete';

const target = document.getElementById('player-target');

const player = new Player({

target,

props: {

plugins: [Boot],

},

});

const off = player.$on('mount', () => {

player.vBoot.manifest = {

controls: false,

actionDisplay: false,

clickToPlay: false,

};

});

Svelte

<Player plugins="{[Boot]}" on:mount="{onPlayerMount}" bind:this="{player}" />

<script>

import { Player, Boot } from '@vime-js/complete';

let player;

const onPlayerMount = () => {

player.vBoot.manifest = {

controls: false,

actionDisplay: false,

clickToPlay: false,

};

};

</script>