播放器API
播放器属性
参数名 | 类型 | 默认值 | 说明 |
---|---|---|---|
wrap | string / HTMLElement | - | 页面上存在需要载入播放器的DOM元素或css选择器 |
width | number / string | 100% | 播放器的宽度 |
height | number / string | auto | 播放器的高度 |
uid | string | - | 用户id,即账号信息中的userId |
vid | string | - | 频道id |
coverImg | string | - | 自定义暖场图 |
autoplay | boolean | - | 是否自动播放,默认跟随直播后台设置。 注:自动播放失败PC、移动端均有可能不成功,原因查看常见问题-自动播放 |
isAutoChange | boolean | false | 自动切换直播/回放(最新直播暂存) |
vodsrc | string | - | 回放视频的播放链接url |
hasControl | boolean | false | 是否显示控制栏预设皮肤。为false则使用各浏览器默认皮肤。 注:仅支持移动端。由于系统浏览器劫持,强制使用该浏览器默认皮肤,部分浏览器设置皮肤不生效。 使用此参数的同时,建议搭配skin_type: 'black' 一起使用 |
skin_type | string | - | 皮肤样式:设置'black'使用深色皮肤。 注:仅支持移动端 |
language | number | 0 | 播放器语言,0为中文,1为英文 |
df | number | - | 多码率默认视频清晰度,0 标清,1 高清,2 超清 |
banMultirate | boolean | false | 禁用多码率功能 |
banMuteTips | boolean | false | 隐藏静音提示, 详细查看常见问题-自动播放-静音播放 注:仅支持PC端 |
banRightMenu | boolean | false | 是否禁用右键菜单 |
banRate | boolean | false | 禁用倍速功能 |
danmuEnable | boolean | false | 为true开启弹幕,需要配合后台开关 |
showDanmu | boolean | - | 是否显示弹幕 |
banDanmuBtn | boolean | - | 禁用弹幕按钮 |
skinConfig | object | - | 皮肤设置 streamStop: 直播流停止时显示的图片地址 streamStopTxt: 直播流停止时显示的文本 streamPause: '直播流暂停时显示的图片地址 bgColor: '背景颜色 playBtnImg: 播放按钮图片地址 showPlayBtn: 是否显示播放按钮 showFullScreen: 是否显示全屏按钮 showProgress: 是否显示进度条 |
webPageFullScreen | boolean | false | 是否使用网页全屏 注意:仅支持移动端 |
fullScreenOrientation | string | none | 网页全屏方向,portrait 竖屏, landscape 横屏, none 无效果 注:仅支持移动端 |
banLivePause | boolean | false | 直播过程中不显示暂停按钮。该功能对回放的场景无效 |
播放器接口
接口名 | 参数 | 回调参数 | 说明 |
---|---|---|---|
j2s_resumeVideo | 播放视频 | ||
j2s_pauseVideo | 暂停视频 | ||
j2s_stopVideo | 停止播放 | ||
j2s_seekVideo | time:number | 视频(回放)指定位置播放 | |
j2s_setVolume | volume:number | 设置播放器声音,取值0-1 | |
j2s_getCurrentTime | time:number | 获取视频当前时间 | |
j2s_showBarrage | 开启弹幕 | ||
j2s_hideBarrage | 隐藏弹幕 | ||
j2s_addBarrageMessage | data:Object | 发送弹幕,详情查看功能使用说明 - 弹幕 | |
j2s_changeLevel | hd:number | 0/1/2 流畅/高清/超清 | |
j2s_changeRate | rate:number | 1.0/1.25/1.5/2.0 | |
changeLine(line) | line:number | 0/1 线路1/线路2 |
示例
播放器事件
事件名 | 回调参数 | 类型 | 说明 |
---|---|---|---|
s2j_onInitOver | / | / | 播放器初始化完毕事件 |
s2j_onApiStatus | streamStatus | string | 直播流状态,每10s触发一次。取值live/end/stop |
s2j_volume | volume | number | 播放器声音改变时触发,取值0-1 注意:仅支持PC端 |
s2j_onStartPlay | cid | string | 开始播放时触发,只触发一次 |
s2j_onPlay | cid | string | 开始播放时触发 |
s2j_onPause | cid | string | 暂停时触发 |
s2j_onSeek | / | / | 拖拽播放时触发。注意:PC、移动端回调参数不一致,移动端只获取到拖拽完成后的时间点 |
s2j_onOver | cid | string | 结束播放时触发 |
s2j_onPlayerKeyUp | keyCode | number | 键盘按键侦听 注意:仅支持PC端 |
s2j_onLevelsChanged | cid,hd | string,number | 清晰度切换时触发,hd为0/1/2 流畅/高清/超清 |
onLineChanged | cid,line | string,number | 线路切换时触发,line为 0/1 线路1/线路2 |
s2j_onPlayerError | errorCode | string | 播放错误时触发 |
示例
播放器错误码
错误码 | 说明 |
---|---|
LIVE-#001 | 传入的参数非法 |
LIVE-#002 | 用户状态异常 |
LIVE-#003 | 服务已过期 |
LIVE-#004 | 直播频道不存在或已关闭 |
LIVE-#005 | 直播可用分钟数不足 |
LIVE-#006 | 频道已达到最大同时在线观看人数 |
LIVE-#007 | 网站白名单限制 |
LIVE-#008 | 网站黑名单限制 |
LIVE-#009 | 地区白名单限制 |
LIVE-#010 | 地区黑名单限制 |
LIVE-#011 | 直播播放配置文件加载失败/解析错误 |
LIVE-#012 | 授权或跑马灯加载失败/解析错误/不通过 |
LIVE-#014 | 超过账号最高并发总人数限制 |
LIVE-#015 | 播放器识别到抓流 |
LIVE-#016 | 播放器禁止小窗播放 |
LIVE-#022 | 跑马灯被删除/修改 |
Last updated