WEB SDK开发指南

版本:3.5.0
日期:2020年10月29日

概述

利用WEB SDK可以与CC视频直播系统进行对接,灵活调用直播和回放的视频、文档、聊天、问答等模块,在您的网页中实现自定义样式界面展示直播和回放。

浏览器支持

直播SDK

依赖库

直播SDK依赖于jQuery,请自行引入 jQuery 库,版本没有要求。

调用方法

页面引入 jQuery:

页面引入 JS SDK:

视频模块:

文档模块:

初始化:

参数 说明
userid 用户 id,不可为空
roomid 直播间id,不可为空
groupid 分组id,可为空
viewername 用户名称,可为空
viewertoken 需要密码验证方式时,不可为空
viewercustomua 自定义UA参数,配合接口验证使用,可为空
pcH5Live 是否开启h5直播,不支持ie及其内核浏览器
language en,英文版flash播放器,可为空
viewercustominfo json格式字符串,可选,自定义用户信息,该信息会记录在用户访问记录中,用于统计分析使用(长度不能超过1000个字符,若直播间启用接口验证则该参数无效)
fastMode 是否开启极速动画模式,默认是开启极速动画模式,默认参数为true

 

主动调用 API

API 说明
sendPublicChatMsg(msg) 发送公聊,msg:消息内容
sendPrivateChatMsg(touserid,tousername,msg) 发送私聊, touserid:接收者的viewerid,tousername:接收者的viewername,msg:消息内容
sendQuestionMsg(msg) 发送问题,msg:消息内容
barrage(msg, color) 发送弹幕,color为十六进制颜色值(0xffffff),仅支持PC端
getLine() 获取线路
changeLine(num) 切换线路,num: getLine返回的值(0,1)
onlyAudio() 只听音频 (PC端H5播放器暂不支持)
setSound(num) 音量调节,num: 0-1
answerRollcall(rid, pid) 签到,rid:rollcallId,pid:publisherId
replyVote(voteid, option, pid) 答题,voteid:voteId,option:答题选项,pid:publisherId
docBarrage(msg, color) 文档弹幕,color为十六进制颜色值(0xffffff),仅支持PC端
openBarrage(true/false) 弹幕开关,仅支持PC端
showControl(true/false) 控制条显示隐藏
requestInteraction 请求语音互动
hangupInteraction 挂断双向视频
enterInteractionRoom 进入互动房间
sendInteractionMessage 发送互动信息
docAdapt(true/false) 文档自适应,默认为false关闭自适应,仅支持PC端
showMarquee 视频显示跑马灯,仅支持PC端
closeMarquee 视频关闭跑马灯,仅支持PC端
showMarqueeDoc 文档显示跑马灯,仅支持PC端
closeMarqueeDoc 文档关闭跑马灯,仅支持PC端
logout(obj) 退出;obj.success:退出成功回调;obj.error:退出失败回调;
playerBackgroundImageUri 获取播放器自定义背景图片
playerBackgroundHint 获取播放器自定义提示语
liveCountdown 直播倒计时
getPublishingQuestionnaire 直播中获取问卷
changeNickname(name) 修改用户昵称,name:昵称,长度小于20
setDocMode(type) 切换文档模式,参数 type 值为:
DWLive.DocModeType.NormalMode:切换至跟随模式(默认)
DWLive.DocModeType.FreeMode:切换至自由模式
getDocs(roomId,userId,callback) 获取直播间所有文档信息,参数:
roomId:直播间的ID(roomid)
userId:CC账户ID(userid)
callback:获取文档信息后的回调
changePageTo(docId,pageIndex) 跳转到指定文档页,参数:
docId:要跳转到文档id
pageIndex:要跳转到指定文档的页码
submitQuestionnaire(data,callBack) 提交问卷,参数:
data:提交问卷的回答信息
callBack:提交成功后的回调
getPracticeInfomation(pId,callBack) 获取随堂测信息;
参数:
pId:随堂测id(没有则传空字符串)
callBack:响应回调
submitPracticeInfo(pId,opt,callBack) 提交随堂测;
参数:
pId:随堂测Id
opt:选择的选项id(多个选项用空格隔开)
callBack:提交后响应回调
getPracticeStatisInfo(pId, callBack) 获取随堂测统计信息
参数:
pId:随堂测id
callBack:响应回调
getPracticeRanking(pId,callBack) 获取排名数据
参数:
pId:随堂测Id
callBack:响应回调
getHdInquirePunchInformation(callBack) 获取打卡信息
参数:
callBack:响应回调
hdCommitPunch(punchId,callBack) 获取打卡信息
参数:
punchId:打卡Id
callBack:响应回调
clipVideoImage() 截取视频图像
说明:
该方法会截取视频图像,
并且返回base64的视频图像的内容(目前只支持h5播放器,ie和safari不受支持)
destroy() 销毁
说明:
销毁对象意味着之前注册的回调事件监听失效,
再次使用需要重新初始化

 

 

直播响应事件 API

API 说明
onLoginSuccess 登录成功
on_hd_live_player_type 当前播放器是h5还是flash播放器
onLiveStart 开始推流直播
onLiveEnd 停止推流直播
onUserCountMessage 在线人数
onPublicChatMessage 收到公聊
onPublicChatLogManage 收到聊天审核消息
onPrivateChatMessage 收到私聊
onPrivateAnswer 收到私聊回复
onQuestion 收到提问
onAnswer 收到回答
onInformation 直播间禁止聊天或问答时,发送消息的回调通知
onKickOut 踢出
onAnnouncementShow 开始直播后显示公告
onAnnouncementRelease 发布和修改公告
onAnnouncementRemove 删除公告
onLoginError 登录出现错误时的回调
onLiveStarting 移动web端直播中的回调
onStartRollCall 开始签到
onStartLottery 开始抽奖
onWinLottery 中奖
onStopLottery 结束抽奖
onStartVote 开始答题(voteType:0/1; 0为单选题,1为多选题)
onStopVote 结束答题
onVoteResult 答题统计
window.on_cc_live_interaction_accept 讲师接受互动信息
window.on_cc_live_interaction_message 互动信息
window.on_cc_live_interaction_chatusers 已经在聊天的列表信息
window.on_cc_live_interaction_disconnect 挂断互动信息
showUserCount 是否显示在线人数(0为不显示,1为显示)
onLiveDesc 显示简介
onBroadcastMsg 广播消息回调
onQaPublish 发布问题
onRoomSetting 直播间布局配置
onQuestionnairePublish 发布问卷
onQuestionnairePublishStop 结束发布问卷
onQuestionnairePublishStatis 发布问卷统计
onOnlineTeachers 获取讲师列表
window.on_cc_swf_loading_completed PC端直播播放器加载完成
window._onStart PC端直播中的回调
onExternalQuestionnairePublish 第三方问卷调查
onPageChange 翻页信息回调
onChangeNickname 修改用户昵称回调
onLiveTime 获取开始直播时间和直播时间(未开始直播返回 {liveStartTime: "", liveDuration: -1})
onSwitchSource 获取当前播放(数据源)场景
onSwitchVideoDoc(main) 布局切换;main(false: 文档为主; true: 视频为主;)
onSilenceUserChatMessage(toJson(data)) 用户禁言后发送聊天的消息回调; data:禁言时发送信息回调数据
onPracticePublish(data) 随堂测发布消息回调; data:发送信息回调数据
onPracticePublishStop(data) 随堂测停止答题消息回调; data:回调数据
onPracticeClose(data) 关闭随堂测; data:回调数据
onHdLiveStartPunch(data) 开启打卡功能; data:回调数据
onHdLiveStopPunch(data) 停止打卡功能; data:回调数据
onBanChat(data) 禁言
onUnBanChat(data) 解除禁言
onBanDeleteChat(data) 禁言并删除聊天记录
HDBanChatBroadcastWithData(data) 用户禁言后群发消息通知; data:回调数据
HDUserRemindWithAction(data) 用户进出直播间消息通知; data:回调数据
window.onSocketConnect() socket链接成功回调;
window.onSocketDisconnect() socket链接失败回调;

 

 

返回值参数说明

登录成功

接收公共聊天

接收聊天审核消息

接收私聊消息

接收提问消息

接收回答消息

接收私人回答

提交问卷

获取随堂测

提交随堂测

打卡功能消息

接收翻页消息

接收广播消息

获取当前直播中所有文档数据

获取直播源

监听是否被踢出

用户进出直播间消息通知

用户禁言群发消息通知

其他

关键代码示例

备注与说明

响应事件返回的默认都为字符串格式,请自行按需求转化为JSON对象。

附录1. 图片、表情、a链接解析处理方法

需要发送图片时,格式如下:[img_http://www.xxx.com]

需要发送带链接的a标签时,格式如下:[uri_http://www.xxx.com] (注意:前后都需要加空格)

在收发消息的时候,用showEm('消息内容')处理一下消息内容即可,原理就是匹配[img_url]和[em2_*],让它变为对应的图片或者表情图片,匹配[uri _ *],让它变为可点击的a链接。

 

 

回放SDK

依赖库

回放SDK依赖于 jQuery,请自行引入 jQuery 库,版本没有要求。

调用方法

页面引入 jQuery:

页面引入 JS SDK:

视频模块:

文档模块:

初始化:

参数 说明
userId 用户id,不可为空,必选参数
roomId 直播间id,不可为空,必选参数
recordId 回放id,不可为空为必选(取消不传recordId,传入liveId可播放,如果该参数不存在会抛出异常)
groupId 分组id,可为空,可选参数
viewername 观看者名字,可为空,接口验证时必填
viewertoken 观看密码,可为空,接口验证时必填
isH5play PC端是否启用H5播放器,可选参数,默认true启用h5播放器,false为启用flash播放器(不支持H5的浏览器,该参数无效,默认使用Flash播放器)
fastMode 可选参数,默认为true开启极速文档,为false时则使用flash文档加载

 

回放响应事件 API

API 说明
on_cc_live_chat_msg 显示全部聊天信息
on_cc_live_chat_msg_sync 同步显示聊天信息
on_cc_live_broadcast_msg 显示全部广播信息
on_cc_live_broadcast_msg_sync 同步显示广播信息
on_cc_live_qa_question 显示提问信息
on_cc_live_qa_answer 显示回答信息
on_cc_callback_pages 返回文档信息对象
on_cc_callback_pagechange 翻页信息回调
on_cc_login_error 登录失败回调
on_cc_live_player_load 播放器加载完成,仅支持pc端
on_player_start 播放开始,仅支持pc端
on_spark_player_pause 播放暂停,仅支持pc端
on_spark_player_resume 恢复播放,仅支持pc端
on_spark_player_end 播放停止,仅支持pc端
on_hdReplay_practice_info 随堂测请求成功后回调

返回值说明

跳转到指定时间播放

获取当前播放时间

获取视频总时长

文档自适应

文档跑马灯

PC端回放播放器API

API 说明
$.DW.isShowBar(0) 隐藏视频播放控制条,0为打开,1为隐藏,默认为打开
$.DW.getBuffer() 获取buffer
$.DW.setVolume() 设置音量,0-1
$.DW.getVolume() 获取音量
$.DW.play() 播放暂停
$.DW.setZScale() 缩放视频画面,number(0-1),仅支持Flash播放器
$.DW.getZScale() 获取视频画面缩放比例,仅支持Flash播放器
$.DW.setScale() 设置视频窗口比例("full", "scale43", "scale169", "original"),仅支持Flash播放器
$.DW.getScale() 获取视频窗口比例,仅支持Flash播放器
$.DW.openSettingPanel() 打开设置面板,仅支持Flash播放器
$.DW.playbackRate() 倍速播放,默认1.0 正常速度,倍速设置范围0.5~2倍速,仅支持H5播放器
$.DW.getReplayPractice() 获取随堂测信息
$.DW.destroy() 销毁
$.DW.clipVideoImage() 截取视频图像
说明:
该方法会截取视频图像,
并且返回base64的视频图像的内容(目前只支持h5播放器)

主动调用API

API 说明
$.DW.showMarqueeDoc(marquee) 文档显示跑马灯,仅支持PC端

 

SDK下载

下载地址:https://dl.csslcloud.net/live/sdk/web/Live_Web_Play_SDK-3.5.0.zip

版本更新记录

 

更新日期版本号更新内容
2020-10-293.5.0PC端直播H5播放器新增以下功能:
-支持弹幕功能
-支持跑马灯功能
-支持暖场视频功能
-支持播放器背景图
-支持播放器提示语
-支持播放器倒计时
-支持双击全屏显示
-播放器英文版适配
-播放器相关按钮样式优化
2020-09-043.4.0直播SDK支持自定义打卡提示语
直播SDK新增用户进出直播间消息通知
直播SDK新增用户禁言群发消息通知
2020-08-213.3.0新增PC端回放文档模块显示跑马灯
新增直播支持广播历史记录删除
回放增加获取文档备注字段docNotes
修复回放PC端H5播放器获取buffer不准确问题
修复回放文档iframe不在playbackPanel内部问题
2020-04-223.2.2新增禁言并删除聊天记录方法
直播回放新增课件水印支持
完善SDK使用说明文档
修复H5直播播放器bug
2020-04-143.2.1修复回放拖动播放文档偶尔不显示问题;
2020-02-263.2.0新增截图功能
直播支持h5播放器
文档优化
2019-12-103.1.0新增随堂测功能
新增打卡功能
新增销毁方法
优化SDK使用文档
2019-10-153.0.0新增版本控制,取消SDK热更新机制
文档默认使用极速模式
回放默认使用H5播放器
回放初始化取消liveId的兼容,必须传入recordId
升级连麦模块,支持新版连麦
优化回放文档画笔数据加载
2019-06-252.9.1新增webpack版demo
2019-01-212.9.0新增登录成功回调
支持敏感词过滤
支持聊天审核
支持直播分组
文档极速动画模式兼容docAdapt方法
2019-01-092.8.1直播socket链接状态回调
新增聊天图片解析说明
2018-12-112.8.0直播新增视频、文档为主布局切换回调
新增用户禁言后聊天回调
退出登录增加状态回调
2018-11-072.7.0文档模式新增切换数据源响应事件
新增学员踢出类型
2018-10-152.6.0直播新增问卷提交方法和问卷统计回调
直播新增获取直播间文档方法
直播新增自由翻页模式
2018-09-122.5.0直播和回放文档支持极速动画模式
直播新增onLiveTime回调,返回直播开始时间和直播时长
优化demo
2018-07-042.4.1直播新增viewercustominfo参数
回放PC端新增H5播放器及倍速播放
回放demo界面美化
2018-06-132.4.0直播和回放新增翻页信息回调
直播支持观看直播时修改昵称
直播支持广播信息补推(最后一条广播)
回放增加直播中发布的广播信息的回调
2018-03-282.3.1新增直播中获取问卷的方法
2018-02-272.3.0支持第三方问卷
支持直播倒计时
支持文档显示模式
优化低延迟模式下文档视频同步性
回放Flash播放器API增加播放回调事件、面板设置、画面缩放、画面比例
2017-11-282.2.0支持聊天记录补推
增加获取播放器背景图及提示语的方法
支持橡皮擦删除画笔
增加聊天自定义参数支持
回放Flash播放器API增加隐藏控制条、音量控制、播放控制、获取buffer
2017-10-102.1.0新增用户退出功能
新增问卷功能
新增广播消息
新增web端布局切换事件
新增聊天获取讲师列表私聊
新增PC端直播中的状态事件
新增获取直播间简介
新增是否显示在线人数
新增跑马灯功能,并支持设置显示在文档还是视频Flash上
直播和回放新增增加自定义ua参数 viewercustomua
直播和回放新增flash播放器加载完成事件
回放登录参数 liveId 修改为recordId
2017-07-262.0.0移动端支持画笔显示
PC和移动端支持ppt动画
PC端增加文档自适应窗口方法
移动端回放支持ppt同步翻页
移动端直播增加文档延迟保持和直播同步
回放增加登录失败回调方法
2017-06-281.8.4支持连麦功能
回放支持获取时长
2017-01-181.8.3支持https
2016-11-221.8.2新增回放聊天同步显示接口
2016-11-181.8.1新增弹幕开关
新增控制条隐藏
新增文档弹幕
直播聊天和问答返回角色信息
回放聊天和问答返回角色、头像信息
2016-11-081.8.0新增签到
新增抽奖
新增答题卡
新增聊天中超链接发送说明
回放新增获取文档图片信息
回放新增获取当前播放时间