videosdk 接口文档 (version 1.1.1)
环境配制
1.引入文件
1.1.script标签引入
1.2.npm+import引入
// 安装 npm i -D zby_video_sdk // 引入 ;
1.3.requirejs引入
;
2.API接口参数配制
2.1 zbyVideo初始化
初始化 | ||||||
接口 | let zbyVideo = new VideoSdk(options);// 创建SDK对象,传入相关参数 | |||||
zbyVideo.initVideo();// 初始化SDK, 当构造函数参数urls为空数组时,此接口需要在setStreamUrls方法之后调用 | ||||||
参数 |
类型 | 描述 | 备注 | |||
options.id | string | 播放器的video的ID | 必填 | |||
options.width | int | 播放器的宽度(px),默认500px | 选填 | |||
options.height | int | 播放器的高度(px),默认300px | 选填 | |||
options.controls | boolean | 是否显示播放器控制条 默认true(显示) | 选填 | |||
options.autoplay | boolean | 是否自动播放 默认false(否) | 选填 | |||
options.onVideoEvents | function | 播放器的事件监听,详细见文档3.1.1 | 必填 | |||
options.config | object | 数据上报基本参数,详细见文档3.1.2 | 必填 | |||
options.urls | array | 播放数据源,详细见文档3.1.3 | 必填 |
2.1.1 onVideoEvents
播放器事件监听 | 方法 | onVideoEvents(e,data) | |
---|---|---|---|
参数 |
描述 | 备注 | |
e.ready | 播放器初始化完毕 | ||
e.waiting | 视频加载中 | ||
e.playing | 开始播放 | ||
e.buffernull | 开始卡顿 | ||
e.bufferplay | 结束卡顿 | ||
e.seriousbuffer | 严重卡顿 | ||
e.autoChangeLine | 自动切换线路中 | ||
e.error | 地址错误 | ||
e.pause | 暂停 | ||
e.play | 即将播放 | ||
e.currentLine | 当前线路 | data | |
e.timeupdate | 当前播放时间 |
2.1.2 config
config | config参数说明 | |||
---|---|---|---|---|
参数 | 类型 | 描述 | 备注 | |
part_id | string | 部门id | 必填 | |
project_id | string | 机构id(instid) | 必填 | |
uid | string | 用户id | 选填 | |
city_id | string | 所属分校 | 选填 | |
course_id | string | 课堂(room)id | 选填 | |
class_id | string | 班级(class)id | 必填 | |
teacher_master_id | string | 主讲老师id | 必填 | |
teacher_assist_id | string | 辅导老师id | 选填 |
2.1.3urls
urls | datas参数说明 | urls:[ datas,datas,.....] | ||
---|---|---|---|---|
参数 | 类型 | 描述 | 备注 | |
lineid | string | 线路id | ||
name | string | 线路名称 | ||
url | string | 直播、点播地址 | ||
type | string | 视频类型 | rtmp、m3u8、flv、mp4 | |
streamid | string | 流id | ||
supplier | string | 供应商id | 1--网宿 2--阿里云 3--白山云 4--帝联 5--蓝讯 |