videojs 开源的HTML5和Flash视频播放器

2020-01-08 15:07:54 视频

videojs 开源的HTML5和Flash视频播放器

Video.js是一款HTML5视频播放器。它支持HTML5视频和现代的流媒体格式,功能强大同时支持桌面和移动设备的视频播放。


使用示例

插入代码:

<link href="https://cdn.bootcss.com/video.js/7.6.5/video-js.min.css" rel="stylesheet">
<script src="https://cdn.bootcss.com/video.js/7.6.5/video.min.js"></script>
<script src="https://cdn.bootcss.com/video.js/7.6.5/lang/zh-CN.js"></script>

调用HTML

<video
  id="my-player"
  class="video-js"
  controls
  preload="auto"
  poster="https://vjs.zencdn.net/v/oceans.png"
  data-setup='{}'>
  <source src="https://vjs.zencdn.net/v/oceans.mp4" type="video/mp4"></source>
  <source src="https://vjs.zencdn.net/v/oceans.webm" type="video/webm"></source>
  <source src="https://vjs.zencdn.net/v/oceans.ogv" type="video/ogg"></source>
  <p class="vjs-no-js">
    您的浏览器不支持HTML5
  </p>
</video>
<h3>其它位置触发示例</h3>
<button onclick="player.play()">播放</button>
<button onclick="player.pause()">暂停</button>

调用Js

var player = videojs(document.getElementById('myVideo'), {
  controls: true, // 是否显示控制条
  poster: 'xxx', // 视频封面图地址
  preload: 'auto',
  autoplay: false,
  fluid: true, // 自适应宽高
  language: 'zh-CN', // 设置语言
  muted: false, // 是否静音
  inactivityTimeout: false,
  controlBar: { // 设置控制条组件
    /* 设置控制条里面组件的相关属性及显示与否
    'currentTimeDisplay':true,
    'timeDivider':true,
    'durationDisplay':true,
    'remainingTimeDisplay':false,
    volumePanel: {
      inline: false,
    }
    */
    /* 使用children的形式可以控制每一个控件的位置,以及显示与否 */
    children: [
      {name: 'playToggle'}, // 播放按钮
      {name: 'currentTimeDisplay'}, // 当前已播放时间
      {name: 'progressControl'}, // 播放进度条
      {name: 'durationDisplay'}, // 总时间
      { // 倍数播放
        name: 'playbackRateMenuButton',
        'playbackRates': [0.5, 1, 1.5, 2, 2.5]
      },
      {
        name: 'volumePanel', // 音量控制
        inline: false, // 不使用水平方式
      },
      {name: 'FullscreenToggle'} // 全屏
    ]
  },
  // sources:[ // 视频源-可以在这里定义
  //     {
  //         src: '//vjs.zencdn.net/v/oceans.mp4',
  //         type: 'video/mp4',
  //         poster: '//vjs.zencdn.net/v/oceans.png'
  //     }
  // ]
}, function (){
  console.log('视频可以播放了',this);
});

常用事件:

  • 播放 this.play()
  • 停止 – video没有stop方法,可以用pause 暂停获得同样的效果
  • 暂停 this.pause()
  • 销毁 this.dispose()
  • 监听 this.on('click',fn)
  • 触发事件this.trigger('dispose')

options参数说明

autoplay

类型: boolean;
如果true,则在播放器准备就绪时开始播放。

controls

类型: boolean
如果true,播放器具有用户可以与之交互的控件(比如音量调节,全屏等)。没有控件,启动视频播放的唯一方法是使用autoplay属性或通过Player API。

width

类型: string|number
设置视频播放器的显示宽度(以像素为单位)。

height

类型: string|number
设置视频播放器的显示高度(以像素为单位)。

loop

类型: boolean
如果true,使视频一结束就重新开始,循环播放。

muted

类型: boolean
如果true,默认情况下会静音任何音频。

poster

类型: string
视频缩略图,在视频开始播放之前显示的图像的URL。这通常是视频的框架或自定义标题屏幕。一旦用户点击“播放”,图像就会消失。

preload

类型: string
视频预加载,建议浏览器是否应在加载元素后立即开始下载视频数据。支持的值是:
'auto'
载入页面后立即开始加载视频(如果浏览器支持)。
'metadata'
仅加载视频的元数据,其中包括视频的持续时间和尺寸等信息。有时,元数据将通过下载几帧视频来加载。
'none'
不要预加载任何数据。浏览器将等待用户点击“播放”开始下载。

src

类型: string
视频URL地址,要嵌入的视频源的源URL。

Video.js特定的参数

aspectRatio

类型: string
将播放器置于流体模式,并在计算播放器的动态大小时使用该值。该值应表示比率 - 由冒号(例如"16:9"或"4:3")分隔的两个数字。

autoSetup

类型: boolean
阻止播放器为具有data-setup属性的媒体元素运行autoSetup 。
注意:必须在与videojs.options.autoSetup = falsevideojs源加载生效的同一时刻全局设置。

children

类型: Array|Object
此选项继承自基Component类。

fluid

类型: boolean
如果true,Video.js播放器将具有流畅的大小。换句话说,它将扩展以适应其容器。
此外,如果元素具有"vjs-fluid",则此选项自动设置为true。

inactivityTimeout

类型: number
Video.js表示用户通过"vjs-user-active"和"vjs-user-inactive"类以及"useractive"事件与玩家进行交互。
在inactivityTimeout决定了不活动的许多毫秒声明用户闲置之前是必需的。值为0表示没有inactivityTimeout,用户永远不会被视为非活动状态。

language

键入:string,默认值:浏览器默认值或'en'
设置语言,中文zh-CN,繁体zh-TW。与播放器中的一种可用语言匹配的语言代码。这为播放器设置了初始语言。

nativeControlsForTouch

类型: boolean
明确设置关联技术选项的默认值。

notSupportedMessage

类型: string
允许覆盖Video.js无法播放媒体源时显示的默认消息。

playbackRates

类型: Array
用户可供用户选择播放速度倍率。严格大于0的数字数组,其中1表示常速(100%),0.5表示半速(50%),2表示双速(200%)等。如果指定,Video.js显示控件(类vjs-playback-rate)允许用户从选择数组中选择播放速度。选项以从下到上的指定顺序显示。

例如:

videojs('my-player', {
  playbackRates: [0.5, 1, 1.5, 2]
});

plugins

类型: Object
这支持在初始化播放器时使用自定义选项自动初始化插件。
videojs('my-player', {
  plugins: {
    foo: {bar: true},
    boo: {baz: false}
  }
});

以上大致相当于:

var player = videojs('my-player');
player.foo({bar: true});
player.boo({baz: false});

虽然,由于plugins选项是对象,因此无法保证初始化顺序!

sources

类型: Array
一组对象,它们反映了本机元素具有一系列子元素的能力。这应该是带有src和type属性的对象数组。例如:
videojs('my-player', {
  sources: [{
    src: '//path/to/video.mp4',
    type: 'video/mp4'
  }, {
    src: '//path/to/video.webm',
    type: 'video/webm'
  }]
});

上方等同于直接在video元素中的定义,效果是一样的:

<video>
  <source src="//path/to/video.mp4" type="video/mp4">
  <source src="//path/to/video.webm" type="video/webm">
</video>

techCanOverridePoster

类型: boolean
使技术人员有可能覆盖玩家的海报并融入玩家的海报生命周期。当使用多个技术时,这可能很有用,每个技术都必须在播放新源时设置自己的海报。

techOrder

输入:Array,默认值:['html5']
这个参数对于不支持HTML5的很有用,比如让视频播放以Flash模式播放。定义Video.js技术首选的顺序。默认情况下,这意味着Html5首选技术。其他注册的技术将在此技术之后按其注册顺序添加。

vtt.js

类型: string
允许覆盖vtt.js的默认URL,该URL可以异步加载到polyfill支持WebVTT。
此选项将用于Video.js(即video.novtt.js)的“novtt”版本中。否则,vtt.js与Video.js捆绑在一起。

组件参数

children

类型: Array|Object
如果Array- 这是默认值 - 这用于确定哪些子节点(按组件名称)以及在播放器(或其他组件)上创建它们的顺序:
// The following code creates a player with ONLY bigPlayButton and
// controlBar child components.
videojs('my-player', {
  children: [
    'bigPlayButton',
    'controlBar'
  ]
});

该children选项还可以作为传递Object。在这种情况下,它用于提供options任何/所有子项,包括禁用它们false:

// This player's ONLY child will be the controlBar. Clearly, this is not the
// ideal method for disabling a grandchild!
videojs('my-player', {
  children: {
    controlBar: {
      fullscreenToggle: false
    }
  }
});

${componentName}

类型: Object
可以通过组件名称的低驼峰案例变体(例如controlBarfor ControlBar)为组件提供自定义选项。这些可以嵌套在孙子关系的表示中。例如,要禁用全屏控件:
videojs('my-player', {
  controlBar: {
    fullscreenToggle: false
  }
});

技术选择

${techName}
类型: Object
Video.js回放技术(例如"techs")可以作为传递给该videojs功能的选项的一部分给予自定义选项。它们应该在技术名称的小写变体下传递(例如"flash"或"html5")。

flash

swf
指定Video.js SWF文件在Flash技术位置的位置:
videojs('my-player', {
  flash: {
    swf: '//path/to/videojs.swf'
  }
});

但是,更改全局默认值通常更合适:
videojs.options.flash.swf = '//path/to/videojs.swf'
html5
nativeControlsForTouch
类型: boolean
只有技术支持Html5,此选项可以设置true为强制触摸设备的本机控件。

nativeAudioTracks

类型: boolean
可以设置为false禁用本机音轨支持。最常用于videojs-contrib-hls。

nativeTextTracks

类型: boolean
可以设置为false强制模拟文本轨道而不是本机支持。该nativeCaptions选项也存在,但只是一个别名nativeTextTracks、

nativeVideoTracks

类型: boolean
可以设置为false禁用本机视频轨道支持。最常用于videojs-contrib-hls。

评论