1.0.0 • Published 5 years ago

vue-vjs-hls v1.0.0

Weekly downloads
87
License
GPL-3.0
Repository
github
Last release
5 years ago

Vue-Video-Player

Video.js for Vue.js

Dependency

Example

Demo page from original vue-video-player

Demo Page

Use Setup

Install vue-video-player

npm install ice48623/vue-video-player --save
// import with ES6
import Vue from 'vue'
import VideoPlayer from 'vue-video-player'

// require with Node.js/Webpack
var Vue = require('vue')
var VideoPlayer = require('vue-video-player')

// The default is to turn off some of the features, you can choose according to their use of certain features enabled, do not enable the introduction will not require the corresponding file.

// You can configure the global function switch (of course, will be covered by local switches), where non-mandatory

VideoPlayer.config({
  youtube: true,  // default false
  switcher: true, // default true
  hls: true       // default true
})

// use
Vue.use(VideoPlayer)

// --------------------------------------

// or use with component(ES6)
import Vue from 'vue'
import { videoPlayer } from 'vue-video-player'

// use
export default {
  components: {
    videoPlayer
  }
}
<!-- Use in component(Vue.js1.X && Vue.js2.X) -->
<video-player :options="videoOptions"></video-player>

<!-- Use in component(Vue.js1.X && Vue.js2.X && function switch config) -->
<video-player :options="videoOptions" :configs="{ youtube: true }"></video-player>

<!-- Use in component(Vue.js2.X) && event callback -->
<video-player :options="videoOptions" @player-state-changed="playerStateChanged"></video-player>

<!-- Use in component(Vue.js2.X) && custom event name && ref property-->
<video-player :options="videoOptions" @my-player-state-changed-event-custom-name="playerStateChanged" ref="myPlayer"></video-player>
// base - player config example
export default {
  data () {
    return {
       videoOptions: {
        source: {
          type: "video/webm",
          src: 'https://cdn.theguardian.tv/webM/2015/07/20/150716YesMen_synd_768k_vp8.webm',
          // if you need custom player state changed event name, you can config it like this
          customEventName: 'my-player-state-changed-event-custom-name'
        }
      }
    }
  }
}

// playbackRates switch and sources switch - player config example
export default {
  data () {
    return {
      videoOptions: {
        source: [
          { type: "video/mp4", src: 'http://example.com/sample_video_H.mp4', label: '原画', res: 1 },
          { type: "video/mp4", src: 'http://example.com/sample_video_M.mp4', label: '高清', res: 2 },
          { type: "video/mp4", src: 'http://example.com/sample_video_L.mp4', label: '流畅', res: 3 }
        ],
        language: 'zh-CN',
        playbackRates: [0.7, 1.0, 1.3, 1.5, 1.7],
        poster: 'http://cn.vuejs.org/images/logo.png',
        defaultSrcReId: 2
      }
    }
  }
}

// live - player config example
export default {
  data () {
    return {
       videoOptions: {
        source: {
          type: 'application/x-mpegURL',
          src: 'https://example.net/live/playlist.m3u8',
          withCredentials: false
        },
        live: true
      }
    }
  }
}

// youtube - player config example
export default {
  data () {
    return {
      videoOptions: {
        source: {
          type: "video/youtube",
          src: "https://www.youtube.com/watch?v=iD_MyDbP_ZE"
        },
        techOrder: ["youtube"],
        autoplay: false,
        controls: false,
        ytControls: true
      }
    }
  }
}

// vimeo - player config example
export default {
  data () {
    return {
      videoOptions: {
        source: {
          type: "video/vimeo",
          src: "https://vimeo.com/167054481"
        },
        techOrder: ["vimeo"],
        autoplay: false,
        controls: false
      }
    }
  }
}

//-------------------------------------------------------------
// player state changed callback event

// events with Vue.js1.x
export default {
  events: {
    playerStateChanged(playerCurrentState) {
      console.log(playerCurrentState)
    }
  }
}

// methods with Vue.js2.x
export default {
  methods: {
    playerStateChanged(playerCurrentState) {
      console.log(playerCurrentState)
    }
  }
}

//-------------------------------------------------------------
// get current player object in parent component

export default {
  computed: {
    player() {
      return this.$refs.myPlayer.player
    }
  },
  mounted: {
    console.log('this is current player object', this.player)
    this.player.pause()
    // and do something...
  }
}

More Code Example

API

protypetypedescriptionexample
playsinlineBooleanthe player default play auto fullscreen in IOS(!safari) (Y/n) default: true
sourceObject/Arraythe player source src(required)
mutedBooleandefault: false
autoplayBooleandefault: true
startNumberplayer start time(default: 0)
liveBooleanplayer is live?
playbackRatesArrayplayer play backrates0.7, 1.0, 1.3, 1.5, 1.7
defaultSrcReIdNumberWhen there are multiple sources, used to specify the default source (default: 1)
controlsBooleanplayer controls display or hidden
preloadBooleanplayer preload ?
posterStringplayer poster(default: '')'http://adasd.jpg' / 'data:image/png;base64,iVB...'
widthNumberplayer width (default: 100%)
heightNumberplayer height (default: 360)
controlBarObjectplayer controlBar dsipaly configneed to video.js api doc
languageStringplayer language(default: 'en')
techOrderArrayplayer support video type (default: example)'html5', 'flash', 'youtube', 'vimeo'
customEventNameStringplayer state changed event name (default: example)'player-state-changed'

Credits

video.js

video.js api

videojs-resolution-switcher

videojs-contrib-hls

videojs-youtube

videojs-vimeo

vue-video-player