Skip to main content
Version: 1.x

Complete Player

version-badge size-badge license-badge github-badge tweet-badge

The Complete Player is Vime's greatest offering. It enables complete customization of the player. If you'd like to know what features it includes and how it compares to other options then see the getting started page.

Installation#

npm install @vime-js/complete

The dist folder inside the package contains multiple exports:

  • complete.js is a UMD development build that can be used directly in the browser via the <script> tag.
  • complete.esm.js is intended for use with modern bundlers like Webpack or Rollup.
  • complete.min.js is a UMD production build that can be used directly in the browser via the <script> tag.
  • complete.esm.min.js is an ESM production build that can be used directly in modern browsers via the <script type="module"> tag.
info
  • UMD builds are exported under the Vime namespace.
  • If you're using a bundler then it will automatically pull in the correct files.
  • If you're using svelte-loader or rollup-plugin-svelte then you'll receive the uncompiled components.

Setup#

import { Player, Boot, FileProvider } from '@vime-js/complete';
const target = document.getElementById('player-target');
// Mountconst player = new Player({  target,  // If you'd like to initialize any props on setup, you can do so here.  props: {    src: '/media/my-video.mp4',    plugins: [Boot],    providers: [FileProvider],  },});
const off = player.$on('mount', () => {  // Interact with the player and plugins here.});
// ...
// Destroyoff();player.$destroy();
info

See the client-side component API for the complete set of component initialization options.

Where to next?#

To customize the player go to the customization page, and then go to the API section to find out how to interact with the player.

info
  • See the provider notes for any provider specific issues or features.
  • To see how to set the src prop checkout the loading media guide.
  • If you want more control over which plugins are loaded then see this page.
  • You don't need to load any Vime specific icons or CSS, they're all loaded via plugins.
  • Vime only has a few basic events, you listen to changes through store subscriptions. For example, if you wanted to get updates on the currentTime, you'd subscribe to it. More information can be found here.
  • This player extends the Standard Player, all the props/methods/events listed here are also available directly from the Complete Player. :::