创建视频
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
x | Number | 0 | 否 | 视频的左上角横坐标,单位 px。 |
y | Number | 0 | 否 | 视频的左上角纵坐标,单位 px。 |
width | Number | 300 | 否 | 视频的宽度,单位 px。 |
height | Number | 150 | 否 | 视频的高度,单位 px。 |
src | String | 是 | 视频的资源地址 | |
poster | String | 否 | 视频的封面 | |
initialTime | Number | 0 | 否 | 视频的初始播放位置,单位为 s 秒 |
playbackRate | Number | 1.0 | 否 | 视频的播放速率,有效值有 0.5、0.8、1.0、1.25、1.5 |
objectFit | String | 'contain' | 否 | 视频的缩放模式 |
controls | Boolean | true | 否 | 视频是否显示控件 |
showProgress | Boolean | true | 否 | 是否显示视频底部进度条 |
showProgressInControlMode | Boolean | true | 否 | 是否显示控制栏的进度条 |
backgroundColor | String | '#000000' | 否 | 视频背景颜色 |
autoplay | Boolean | false | 否 | 视频是否自动播放 |
loop | Boolean | false | 否 | 视频是否是否循环播放 |
muted | Boolean | false | 否 | 视频是否禁音播放 |
enableProgressGesture | Boolean | true | 否 | 是否启用手势控制播放进度 |
enablePlayGesture | Boolean | false | 否 | 是否开启双击播放的手势 |
showCenterPlayBtn | Boolean | true | 否 | 是否显示视频中央的播放按钮 |
underGameView | Boolean | false | 否 | 视频是否显示在游戏画布之下(配合 Canvas.getContext('webgl', {alpha: true}) 使主屏 canvas 实现透明效果) |
autoPauseIfNavigate | Boolean | true | 否 | 视频跳转后自动暂停播放 |
autoPauseIfOpenNative | Boolean | true | 否 | 视频跳转原生页后自动暂停播放 |
objectFit (视频的缩放模式)
合法值 | 说明 |
---|---|
fill | 填充,视频拉伸填满整个容器,不保证保持原有长宽比例 |
contain | 包含,保持原有长宽比例。保证视频尺寸一定可以在容器里面放得下。因此,可能会有部分空白 |
cover | 覆盖,保持原有长宽比例。保证视频尺寸一定大于容器尺寸,宽度和高度至少有一个和容器一致。因此,视频有部分会看不见 |
一个视频对象,可以通过设置该对象上的属性和调用该对象上的方法来控制视频
视频的左上角横坐标
视频的左上角纵坐标
视频的宽度
视频的高度
视频的资源地址
视频的封面
视频的初始播放位置,单位为 s 秒
视频的播放速率,有效值有 0.5、0.8、1.0、1.25、1.5
视频的缩放模式
视频是否显示控件
是否显示视频底部进度条
是否显示视频控制栏进度条
视频背景颜色
视频是否自动播放
视频是否是否循环播放
视频是否禁音播放
是否启用手势控制播放进度
是否启用手势控制播放进度
是否显示视频中央的播放按钮
视频由于需要缓冲下一帧而停止时触发的回调函数
视频下载(缓冲)时周期性触发的回调函数
视频开始播放时触发的回调函数
视频暂停时触发的回调函数
视频播放到末尾时触发的回调函数
每当视频播放进度更新时触发的回调函数
视频发生错误时触发的回调函数
播放视频
视频播放完成的 Promise
暂停视频
视频暂停完成的 Promise
停止视频
视频停止完成的 Promise
视频跳转
视频跳转到指定位置,单位为 s 秒
视频跳转完成的 Promise
视频全屏
设置全屏时视频的方向
值 | 说明 |
---|---|
0 | 正常竖向 |
90 | 屏幕逆时针 90 度 |
-90 | 屏幕顺时针 90 度 |
视频全屏完成的 Promise
销毁视频
视频退出全屏
视频退出全屏完成的 Promise
监听视频播放到末尾事件
视频播放到末尾事件的监听函数
监听视频错误事件
视频错误事件的监听函数
属性 | 类型 | 说明 |
---|---|---|
errMsg | String | 错误信息 |
监听视频暂停事件
视频暂停事件的监听函数
监听视频播放事件
视频播放事件的监听函数
监听视频播放进度更新事件
视频播放进度更新事件的监听函数
属性 | 类型 | 说明 |
---|---|---|
position | Number | 当前的播放位置,单位为秒 |
duration | Number | 视频的总时长,单位为秒 |
移除视频播放到末尾事件的监听函数
onEnded 传入的监听函数。不传此参数则移除所有监听函数。
const listener = function(res) {
console.log(res);
};
Video.onEnded(listener);
Video.offEnded(listener); // 需传入与监听时同一个的函数对象
移除视频错误事件的监听函数
onError 传入的监听函数。不传此参数则移除所有监听函数。
const listener = function(res) {
console.log(res);
};
Video.onError(listener);
Video.offError(listener); // 需传入与监听时同一个的函数对象
移除视频暂停事件的监听函数
onPause 传入的监听函数。不传此参数则移除所有监听函数。
const listener = function(res) {
console.log(res);
};
Video.onPause(listener);
Video.offPause(listener); // 需传入与监听时同一个的函数对象
移除视频播放事件的监听函数
onPlay 传入的监听函数。不传此参数则移除所有监听函数。
const listener = function(res) {
console.log(res);
};
Video.onPlay(listener);
Video.offPlay(listener); // 需传入与监听时同一个的函数对象
移除视频播放进度更新事件的监听函数
onTimeUpdate 传入的监听函数。不传此参数则移除所有监听函数。
const listener = function(res) {
console.log(res);
};
Video.onTimeUpdate(listener);
Video.offTimeUpdate(listener); // 需传入与监听时同一个的函数对象
监听视频下载(缓冲)事件
视频下载(缓冲)事件的监听函数
属性 | 类型 | 说明 |
---|---|---|
buffered | Number | 当前的缓冲进度,缓冲进度区间为 (0~100],100 表示缓冲完成 |
duration | Number | 视频的总时长,单位为秒 |
移除视频下载(缓冲)事件的监听函数
onProgress 传入的监听函数。不传此参数则移除所有监听函数。
const listener = function(res) {
console.log(res);
};
Video.onProgress(listener);
Video.offProgress(listener); // 需传入与监听时同一个的函数对象