接入指南 API 工具 其他

视频

qg.createVideo(Object object)

创建视频

参数

Object object

属性类型默认值必填说明
xNumber0视频的左上角横坐标,单位 px。
yNumber0视频的左上角纵坐标,单位 px。
widthNumber300视频的宽度,单位 px。
heightNumber150视频的高度,单位 px。
srcString视频的资源地址
posterString视频的封面
initialTimeNumber0视频的初始播放位置,单位为 s 秒
playbackRateNumber1.0视频的播放速率,有效值有 0.5、0.8、1.0、1.25、1.5
objectFitString'contain'视频的缩放模式
controlsBooleantrue视频是否显示控件
showProgressBooleantrue是否显示视频底部进度条
showProgressInControlModeBooleantrue是否显示控制栏的进度条
backgroundColorString'#000000'视频背景颜色
autoplayBooleanfalse视频是否自动播放
loopBooleanfalse视频是否是否循环播放
mutedBooleanfalse视频是否禁音播放
enableProgressGestureBooleantrue是否启用手势控制播放进度
enablePlayGestureBooleanfalse是否开启双击播放的手势
showCenterPlayBtnBooleantrue是否显示视频中央的播放按钮
underGameViewBooleanfalse视频是否显示在游戏画布之下(配合 Canvas.getContext('webgl', {alpha: true}) 使主屏 canvas 实现透明效果)
autoPauseIfNavigateBooleantrue视频跳转后自动暂停播放
autoPauseIfOpenNativeBooleantrue视频跳转原生页后自动暂停播放

objectFit (视频的缩放模式)

合法值说明
fill填充,视频拉伸填满整个容器,不保证保持原有长宽比例
contain包含,保持原有长宽比例。保证视频尺寸一定可以在容器里面放得下。因此,可能会有部分空白
cover覆盖,保持原有长宽比例。保证视频尺寸一定大于容器尺寸,宽度和高度至少有一个和容器一致。因此,视频有部分会看不见

返回值 Video

一个视频对象,可以通过设置该对象上的属性和调用该对象上的方法来控制视频

属性

Number x

视频的左上角横坐标

Number y

视频的左上角纵坐标

Number width

视频的宽度

Number height

视频的高度

String src

视频的资源地址

String poster

视频的封面

Number initialTime

视频的初始播放位置,单位为 s 秒

Number playbackRate

视频的播放速率,有效值有 0.5、0.8、1.0、1.25、1.5

String objectFit

视频的缩放模式

Boolean controls

视频是否显示控件

Boolean showProgress

是否显示视频底部进度条

Boolean showProgressInControlMode

是否显示视频控制栏进度条

String backgroundColor

视频背景颜色

Boolean autoplay

视频是否自动播放

Boolean loop

视频是否是否循环播放

Boolean muted

视频是否禁音播放

Boolean enableProgressGesture

是否启用手势控制播放进度

Boolean enablePlayGesture

是否启用手势控制播放进度

Boolean showCenterPlayBtn

是否显示视频中央的播放按钮

Function onwaiting

视频由于需要缓冲下一帧而停止时触发的回调函数

Function onprogress

视频下载(缓冲)时周期性触发的回调函数

Function onplay

视频开始播放时触发的回调函数

Function onpause

视频暂停时触发的回调函数

Function onended

视频播放到末尾时触发的回调函数

Function ontimeupdate

每当视频播放进度更新时触发的回调函数

Function onerror

视频发生错误时触发的回调函数

方法

Video.play()

播放视频

返回值 Promise

视频播放完成的 Promise

Video.pause()

暂停视频

返回值 Promise

视频暂停完成的 Promise

Video.stop()

停止视频

返回值 Promise

视频停止完成的 Promise

Promise Video.seek(Number time)

视频跳转

参数 Number time

视频跳转到指定位置,单位为 s 秒

返回值 Promise

视频跳转完成的 Promise

Video.requestFullScreen(Number direction)

视频全屏

参数 Number direction

设置全屏时视频的方向

direction 的合法值
说明
0正常竖向
90屏幕逆时针 90 度
-90屏幕顺时针 90 度

返回值 Promise

视频全屏完成的 Promise

Video.destroy()

销毁视频

Video.exitFullScreen()

视频退出全屏

返回值 Promise

视频退出全屏完成的 Promise

Video.onEnded(Function listener)

监听视频播放到末尾事件

参数 listener

视频播放到末尾事件的监听函数

Video.onError(Function listener)

监听视频错误事件

参数 listener(Object res)

视频错误事件的监听函数

属性类型说明
errMsgString错误信息

Video.onPause(Function listener)

监听视频暂停事件

参数 listener

视频暂停事件的监听函数

Video.onPlay(Function listener)

监听视频播放事件

参数 listener

视频播放事件的监听函数

Video.onTimeUpdate(Function listener)

监听视频播放进度更新事件

参数 listener(Object res)

视频播放进度更新事件的监听函数

属性类型说明
positionNumber当前的播放位置,单位为秒
durationNumber视频的总时长,单位为秒

Video.offEnded(Function listener)

移除视频播放到末尾事件的监听函数

参数 listener

onEnded 传入的监听函数。不传此参数则移除所有监听函数。

示例代码

const listener = function(res) {
  console.log(res);
};

Video.onEnded(listener);
Video.offEnded(listener); // 需传入与监听时同一个的函数对象

Video.offError(Function listener)

移除视频错误事件的监听函数

参数 listener

onError 传入的监听函数。不传此参数则移除所有监听函数。

示例代码

const listener = function(res) {
  console.log(res);
};

Video.onError(listener);
Video.offError(listener); // 需传入与监听时同一个的函数对象

Video.offPause(Function listener)

移除视频暂停事件的监听函数

参数 listener

onPause 传入的监听函数。不传此参数则移除所有监听函数。

示例代码

const listener = function(res) {
  console.log(res);
};

Video.onPause(listener);
Video.offPause(listener); // 需传入与监听时同一个的函数对象

Video.offPlay(Function listener)

移除视频播放事件的监听函数

参数 listener

onPlay 传入的监听函数。不传此参数则移除所有监听函数。

示例代码

const listener = function(res) {
  console.log(res);
};

Video.onPlay(listener);
Video.offPlay(listener); // 需传入与监听时同一个的函数对象

Video.offTimeUpdate(Function listener)

移除视频播放进度更新事件的监听函数

参数 listener

onTimeUpdate 传入的监听函数。不传此参数则移除所有监听函数。

示例代码

const listener = function(res) {
  console.log(res);
};

Video.onTimeUpdate(listener);
Video.offTimeUpdate(listener); // 需传入与监听时同一个的函数对象

Video.onProgress(Function listener)

监听视频下载(缓冲)事件

参数 listener(Object res)

视频下载(缓冲)事件的监听函数

属性类型说明
bufferedNumber当前的缓冲进度,缓冲进度区间为 (0~100],100 表示缓冲完成
durationNumber视频的总时长,单位为秒

Video.offProgress(Function listener)

移除视频下载(缓冲)事件的监听函数

参数 listener

onProgress 传入的监听函数。不传此参数则移除所有监听函数。

示例代码

const listener = function(res) {
  console.log(res);
};

Video.onProgress(listener);
Video.offProgress(listener); // 需传入与监听时同一个的函数对象

条匹配 "" 的结果

    没有搜索到与 "" 相关的内容