1.0.0 • Published 5 years ago

vue-mediaelement v1.0.0

Weekly downloads
52
License
ISC
Repository
github
Last release
5 years ago

vue-mediaelement

video live player

Install

$ npm install vue-mediaelement

Import

Import using module

Import components to your project:

require('vue-mediaelement/dist/vue-mediaelement.css');

// in ES6 modules
import { Mediaelement } from 'vue-mediaelement';

// in CommonJS
const { Mediaelement } = require('vue-mediaelement');

// in Global variable
const { Mediaelement } = VueMediaelement;

And register components:

Vue.component('mediaelement', Mediaelement);

Import using script tag

<link rel="stylesheet" href="../node-modules/vue-mediaelement/dist/vue-mediaelement.css" charset="utf-8">
<script src="../node-modules/vue-mediaelement/dist/vue-mediaelement.js"></script>
const vueMediaelement = VueMediaelement.Mediaelement;

new Vue({
  el: 'body',
  components: {
    'mediaelement': vueMediaelement
  }
});

Usage

Work on a Vue instance:

<mediaelement class="my-play"></mediaelement>
.my-play {
  height: 200px;
  text-align: center;
}

Options

Props

OptionTypeDescriptionDefault
sourceStringSpecifies the URL of the video file; this value can also be indicated with source tags (refer to the Multiple Codecs section for more information)''
widthStringSets the width of the video player in pixels; you can also indicate percentages480
heightStringSets the height of the video player in pixels; you can also indicate percentages270
preloadStringSpecifies if and how the author thinks the video should be loaded when the page loads; possible values: auto, metadata or none (recommended)none
autoplayBooleanSpecifies that the video will start playing as soon as it is readyfalse
forceLiveBooleanIf set to true, the Live Broadcast message will be displayed and progress bar will be hidden, no matter if duration is a valid numbertrue

Events

Event NameTypeDescription
successcallbackAction(s) that will be executed as soon as the source is loaded; passes 2 arguments: media (the wrapper that mimics all the native events/properties/methods for all renderers) and node (the original HTML video, audio or iframe tag where the media was loaded originally; if html5 is being used, media and node are the basically the same)
errorcallbackAction(s) that will be executed if source doesn't load for any reason. Passes same arguments as success

FAQ

How to programminly mediaelement to an item?

Use ref and call remove() method.

this.$refs.mediaelement.remove(newIndex)

For more details, please refer to example code.

Development

Watching with hot-reload:

$ npm run dev

Develop on real remote device:

$ npm run remote-dev {{ YOUR IP ADDRESS }}

License

MIT