HTML5播放器文档
HTML5播放器调用示例(1):
- <div id="player"></div>
- <script src="//player.polyv.net/script/player.js"></script>
- <script>
- var player = polyvPlayer({
- wrap: '#player',
- autoplay:'true',
- width: 800,
- height: 533,
- vid: '88083abbf5f16507525894e5a997aeb2_8',
- });
- </script>
- <h1>酷播云代码测试</h1>
HTML5播放器调用示例(2):
- <script src="//player.polyv.net/script/player.js"></script>
- <div id="test">
- <div id='player'></div>
- </div>
- <script>
- var width = document.getElementById("test").scrollWidth;
- var height = width*0.5625; // 16/9 = 0.5625;
- var player = polyvPlayer({
- wrap: '#player',
- autoplay:'true',
- 'width':width,
- 'height':height,
- 'vid' : '88083abbf5f16507525894e5a997aeb2_8'
- });
- </script>
- <h1>酷播云代码测试</h1>
酷播云html5播放器参数说明:
参数 | 类型 | 默认值 | 说明 |
---|---|---|---|
wrap | string / HTMLElement | - | 页面上存在需要载入播放器的DOM元素或css选择器 |
width | number / string | 100% | 播放器的宽度 |
height | number / string | auto | 播放器的高度 |
vid | string | - | 从 polyv 后台上传的视频会生成一个视频唯一vid |
loop | boolean | false | 视频播放结束后是否循环播放 |
autoplay | boolean | undefined | 播放器加载后视频是否自动播放,也可从后台设置 |
volume | number | 0.75 | 视频默认音量大小,范围 (0, 1),播放器会记录上一次播放的音量 |
flash | boolean | false | 是否默认打开flash播放器 |
df | number | - | 视频默认清晰度,可设置为0、1、2、3,分别对应自动、流畅、高清、超清,设置该参数会覆盖后台的设置 |
hideRepeat | boolean | false | 播放结束后是否显示重播面板,可通过play.HTML5.changeRepeat改变 |
code | string | - | 跑马灯设置中自定义的code值 |
speed | boolean/array | [2, 1.5, 1.2, 0.5] | 设置为false则关闭倍速,可传入数组自定义显示哪几种倍速,速率1不需要填入,会自动添加,所设置速率值必须大于0,少于或等于3,最多设置6种速率(不包含1),所设置值会按由大到小自动排序 |
showHd | boolean | true | 是否显示清晰度选择 |
ignoreIE | boolean | false | 设置该选项将会在ie浏览器中禁用HTML5播放器(edge浏览器除外,国内360,QQ等浏览器的兼容模式表现为ie浏览器,所以也会被禁用) |
watchStartTime | number | undefined | 从第几秒开始播放,需少于视频时长 |
watchEndTime | number | undefined | 播放到第几秒结束播放,需少于视频时长,在该值到结束的进度条禁止点击,如果设置值少入watchStartTime,则watchStartTime失效 |
skinLocation | number | 1 | 控制栏显示在视频区域内外或不显示,可选0(不显示)、1(视频内)、2(视频外) |
ban_history_time | string | off | 是否禁止记住播放进度,下次打开会从上次进度打开(设置watchStartTime后还是会从watchStartTime处开始播放),默认为off(不禁止),on为禁止 |
hideSwitchPlayer | boolean | false | 是否禁止显示HTML5与flash播放器切换按钮 |
priorityMode | string | video | 默认打开视频模式还是音频模式,需要该视频有对应的音频转码可选video/audio |
audioMode | boolean | true | 是否开启音频模式 |
videoMode | boolean | true | 是否开启视频模式,设置为false后将会以音频模式播放,无论是否有音频转码 |
screenshot | boolean | false | 是否开启视频截图功能 |
ban_seek_by_limit_time | string | off | 是否禁止视频拖拽未播放区域 |
ban_seek | string | off | 设置为 on 播放器将会彻底禁止拖拽 |
loading_bg_img | string | - | 视频默认封面图 |
ban_record_ interaction_right_answer |
string | off | 设置为 on 问答回答正确不会记录,每次刷新播放都需重新回答 |
url | string | undefined | 设置后播放器以该url为播放地址播放(支持m3u8、mp4或其他当前浏览器支持的格式视频),不与vid同时设置也可以从changeVid中切换vid或另外的播放url |
start | number | undefined | 子视频开始时间 |
end | number | undefined | 子视频结束时间 |
lang | string | undefined | 播放器显示语言,若未设置则读取后台设置,自动选择暂未支持,默认中文,可设置zh_CN/en |
mainScreen | string | "ppt" | 默认三分屏主屏(video/ppt) |
subWidth/subHeight | number | 355/200 | 默认三分屏副屏宽/高 |
pptVisible | boolean | true | 三分屏初始化时是否需要默认显示 |
pptEnable | boolean | false | 是否显示三分屏 |
show_rate | number | undefined | 允许播放的最高清晰度 1(流畅)、2(高清) |
preloadDataSize | number(kb) | 15000 | 视频最大缓冲量,设置后会根据实际播放时长和清晰度加载切片数量(500 - 60000) |
is_interaction | string | on | 是否显示后台设置的问答 |
keyboardSeekTime | number | 15000 | 键盘控制前进/后退毫秒数 |
allowFullscreen | boolean | true | 是否允许全屏,界面上操作禁止全屏,接口全屏依然允许 |
viewerInfo | object | 15000 | 键盘控制前进/后退毫秒数 |
history_video_duration | number | 5 | 视频总时长超过多少分钟时记录播放进度 |
showAuto | boolean | true | 是否显示自动清晰度按钮 |
flashConfig | object | {} | 切换flash播放器,或者在移动端下额外传入参数对象 |
video_align | string | "center" 视频内容对齐方式 top / bottom / left / right | |
srt_caption_txt_size | number | 20 | 字幕字体大小, 20~40 px |
srt_caption_txt_height | number | 20 | 底部字幕离底部高度,单位px |
srt_caption_base_height | number | 720 | 字幕字体底部基准高度,视频尺寸变化,srt_caption_txt_height 值会根据该高度调整高度 |
srt_caption_base_width | number | 1280 | 字幕字体大小基准宽度,字幕大小会随视频尺寸变化 |
fullscreenProxy | boolean | false | 全屏代理,设置后点击全屏按钮或者双击播放器不会调用全屏api,会触发 window.onFullscreenProxy(vid, toFullscreen) 事件,调用者自行做全屏处理,适合在全屏状态下叠加用户自定义的元素 |
实例属性
属性 | 返回值 | 说明 |
---|---|---|
isSupportHTML5 | boolean | 浏览器是否支持 HTML5 播放器,若返回 true 则播放器默认打开 HTML5 播放器,否则将打开flash 播放器 |
HTML5 | boolean / object | 当前打开的是flash播放器则该属性为 false,反之为HTML5播放器的实例,该实例之后会说明 |
flash | boolean / object | 当前打开的是HTML5播放器则该属性为 false,反之返回多终端代码初始化的实例,该实例之后会说明 |
实例方法
player.toFlash
- 切换到 flash 播放器
player.toHTML5
- 切换到 HTML5 播放器
player.destroy
- 销毁播放器,包括HTML5和flash播放器
player.on
- 事件绑定
player.changeStatistics(session_id, param1, param2, param3, param4)
- 修改播放统计参数
player.getCurrentMode
- 返回当前播放模式('video' / 'audio')
player.setMode
- 切换播放模式,可选 'video' / 'audio',切换音频时需要有相应的音频转码
player.changeVid(object / string)
- 接口支持传入object、json格式化字符串、多个参数传入,使用如下
- const option = {
- vid: '需要切换视频的vid',
- autoplay: true,
- ts: '移动端授权ts',
- sign: '移动端授权sign',
- playsafe: '若是加密视频需重新生成',
- statistics: {}, // 和选项中statistics一样,会覆盖掉原本的统计参数
- skipTeaser: false, // 切换视频是否跳过片头
- ban_seek: 'off', // 设置为 on 播放器将会彻底禁止拖拽
- ban_seek_by_limit_time: 'off', // 是否禁止视频拖拽未播放区域
- };
- // 方法一
- player.changeVid(option);
- //方法二
- player.changeVid(JSON.stringify(option));
- // 方法三 该写法为flash播放器的写法,请尽量使用方法一、方法二
- player.changeVid(vid, watchStartTime, autoplay, ts, sign)
另提供以下方法
j2s_getCurrentTime
、 j2s_getDuration
、 j2s_pauseVideo
、 j2s_resumeVideo
、
j2s_stopVideo
、 changeVid
、 j2s_stayInVideoTime
、 j2s_realPlayVideoTime
、
j2s_seekVideo
、 j2s_setVolume
、 changeRepeat
、 toggleFullscreen
- 具体方法与flash播放器一致,具体参考播放器函数接口汇总
-
toggleFullscreen只在HTML5播放器生效,因为浏览器安全限制,flash尚不支持