属性和接口说明
播放器属性
将所有参数以对象形式传入播放器,可以设置的属性包括:
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
vid | string | 是 | 上传到保利威平台的音视频的唯一ID |
viewerInfo | object | 可选 | 自定义观众信息。设置后,播放器上报的观看行为日志中会附带观众信息。详见观众信息设置与统计。 |
wrap | string | 可选 | 需要载入播放器的css选择器 |
skin | string | 可选 | 播放器皮肤(white / grey),如果使用自定义播放器皮肤,则不需传该参数。 |
autoPlay | boolean | 可选 | 是否自动播放。注:目前大多数浏览器都会限制自动播放,该参数可能无效。 |
loop | boolean | 可选 | 是否循环播放 |
volume | number | 可选 | 音量(范围0~1) |
speed | number | 可选 | 倍速播放 |
startTime | number | 可选 | 从第几秒开始播放,需小于视频时长 |
playsafe | function | string | 可选 | PC端播放加密音/视频所需的授权凭证,若要在PC端播放加密音视频才需要该参数,非加密音视频可忽略。详见:播放加密视频。 |
playsafeUrl | string | 可选 | 获取PC端播放加密音/视频凭证的接口URL。与playsafe参数二选一。 |
sign | string | 可选 | 移动端播放加密音/视频所需的签名,非加密音/视频可忽略。详见:播放加密视频。 |
ts | string | 可选 | 移动播放加密音/视频需传入的时间戳。 |
静态属性
可以通过 PlvAudioPlayer[key] 获取。
名称 | 类型 | 描述 |
---|---|---|
EventType | object | 回调事件的汇总。 |
实例属性
每个播放器实例都有以下属性:
名称 | 类型 | 描述 |
---|---|---|
audio | object | 原生的 audio 对象。 |
currentTime | number | 当前播放位置,单位:秒。 |
duration | number | 当前音频时长,单位:秒。 |
paused | boolean | 当前是否暂停状态。 |
播放器接口
API需要在播放器初始化完成之后调用,比如:
播放器接口列表如下:
名称 | 参数类型 | 说明 |
---|---|---|
play | / | 开始播放 |
pause | / | 暂停播放 |
(async) changeVid | (String|Object) | 切换媒体文件。可传入vid字符串,或包含playsafe、sign、ts、vid属性的对象。 |
seek | Number | 跳转到指定位置播放,参数单位为:秒。 |
setLoop | Boolean | 是否循环播放 |
setSpeed | Number | 设置倍速播放,参数取值(0,16]。非法值将设置为 1。 |
setVolume | Number | 设置音量,参数取值[0,1]。非法值将设置为1。 |
stop | / | 终止播放 |
(async) updateParam | / | 更新播放器参数,音频会结束播放并重新下载。支持本文档中所列的播放器属性参数。 |
destroy | / | 销毁当前播放器实例 |
播放器事件
播放器提供了一些常用的事件回调,使用方法如:
事件列表如下:
名称 | 说明 |
---|---|
ready | 播放器初始化完毕,播放器提供的方法需在此事件发生后才可以调用。参数返回包含音频信息的data对象,可通过 |
loadstart | 在媒体开始加载时触发。 |
play | 媒体播放时触发 |
playing | 播放中,会触发多次 |
pause | 暂停时触发 |
seeking | 在跳跃操作开始时触发 |
seeked | 在跳跃操作完成时触发 |
ratechange | 在播放速率改变时触发 |
timeupdate | 当前播放时间点(currentTime属性)改变时触发 |
waiting | 在一个待执行的操作(如播放)因等待另一个操作(如跳跃或加载)被延迟时触发。 |
ended | 播放结束时触发 |
stop | stop方法完成后触发 |
hlsError | 播放hls文件发生错误时触发 |
serverError | 发生播放错误时触发,参数返回保护报错信息的data对象,可以通过 |
Last updated