💡

最新版本1.60.117

浏览器要求Chrome内核

接入方式

伯索云直播SDK提供两种接入方式： jssdk接入和url接入，两种接入方式最后的呈现的内容并无区别，区别在于适用于不同的技术场景，客户的技术开发团队可根据具体需要进行选择。

jssdk接入

以下步骤演示如何在一个简单的Web项目中接入和配置SDK，详情参见Demo源码。

1、引入jssdk

2、提供挂载元素

在body标签处添加一个用以挂载SDK的div节点，示例如下：

3、初始化

SDK根据提供的DOM节点，把SDK的UI界面渲染到节点上。

options参数说明

标题	参数类型	是否必填	默认值	参数说明
query	string	是	-	加入实时课堂需要签名后的query。详见生成query字符串
classMembers	Array	否	-	初始化课堂参与人{loginName,name,upimeRole,// "speaker","assistant","listener","superlistener"之一 unique_id, //非必要 displayAvatarUrl, // 非必要。头像图片的url}
hideOtherClient	bool	否	false	classMembers设置后生效，成员列表中只显示classMembers列表中包含的成员
sendMsgByTeacher	bool	否	true	控制老师能否在聊天中发送消息
sendMsgByAssistant	bool	否	true	控制助教能否在聊天中发送消息
enableVideoMark	bool	否	false	可以开启视频标注功能
enableDelay	bool	否	false	允许拖堂
allowLocalPPT	bool	否	true	允许在实时课堂中插入本地ppt
endRemindTime	number	否	-	双减提醒, 用来提供双减提示的时间点,为当天的时间戳, 单位秒; 不传没有提醒;

callbacks参数说明

函数名	函数定义	函数说明	版本
onExit	() => void	当在SDK内部点击退出时触发该函数，SDK用户需要主动调用sdkClient的destroy方法销毁SDK
showResourceCenter	() => void	该回调用于接入SDK用户自己的云盘，详见云盘接入
getExtFileName	(info: Array) => Promise<string>	调用了insertObject方法插入资源后需要提供这个回调，详见云盘接入
getPreParseFileName	(info: Array, option: {suffix:string}) => Promise<string>	调用了insertObject方法插入预解析资源后需要提供这个回调，详见云盘接入	1.60.116

4、sdkClient的API

方法名	说明
insertObject	详见云盘接入
destroy	销毁SDK

url接入

url接入方式由用户自己拼接好直播地址，通过跳转/弹出新页面等方式打开。

直播地址格式如下

所有参数由jssdk中生成query字符串组成的参数以及下方表格中的参数组成，由这些参数生成签名后再组成新的query字符串作为url参数。
特别地：url接入方式生成签名时，url中的所有参数都要参与签名计算，因此与jssdk不同的是，如果传入了下面表格的参数，也要参与签名计算。

参数表格

标题	参数类型	是否必填	默认值	参数说明
sendMsgByTeacher	bool	否	true	控制老师能否在聊天中发送消息
sendMsgByAssistant	bool	否	true	控制助教能否在聊天中发送消息
allowLocalPPT	bool	否	true	允许在实时课堂中插入本地ppt
enableVideoMark	bool	否	false	可以开启视频标注功能
enableDelay	bool	否	false	允许拖堂
endRemindTime	number	否	-	双减提醒, 用来提供双减提示的时间点,为当天的时间戳, 单位秒; 不传没有提醒;

注意：url接入方式暂不支持云盘接入

附录

query参数表格

生成query字符串

1、从query参数表格选择所需的业务参数字段和合适的值

2、生成签名

详见签名示例

3、组装query字符串

将所选字段的key和value用=连接，然后再将每一个key=value对使用&相连，最后再加上signature=签名结果。下面是一个拼接好的query示例。

appId=xxx&appType=liveclassSDK&d_dimension=1280x720&loginName=t_1&mediaType=video&meetingId=test_1755148009&meetingType=public&signature=1315A080E80FC7B674EDEB26BE0E4386DA5D452F&userName=老师1&userType=speaker&validBegin=1755148016&validTime=10800

回调课堂数据

课堂结束后，伯索平台将通过SDK用户提供的回调地址回调课堂数据。如果没有配置回调地址，则不返回数据。具体请参考 历史课堂回调数据接入

查询直播相关数据

直播结束后,伯索侧会统一生成该直播课的历史课堂(可以回看的文件)。
伯索提供了接口可以查询指定的直播课堂产生的数据，包括：直播总人次，总时间和费用信息。

注意：如果上课过程中出现多次所有用户全部离开，就会产生多条课堂的数据；

接口地址如下

https://www.plaso.cn/liveclass/getrecordinfo

请求参数

标题	类型	必填	描述
appId	字符	是	应用id，由伯索分配；
meetingId	字符	是	课堂ID，唯一标识该课堂；使用ASSIIC字符，不得包含/，,空格等；
recordId	字符	否	同一个meetingId有可能会产生多个历史课堂，用此recordId标记；

返回结果
返回值为是一个数组，其中包含了一个或多个record对象。

名称	类型	描述
meetingId	字符	课堂ID
recordId	字符	历史课堂ID
duration	数字	历史课堂时长
userCount	数字	历史课堂参与听众数
userCS	数字	历史课堂参与听众累计时长

播放历史课堂

伯索云SDK提供了播放直播后生成的历史课堂的能力，历史课堂格式为伯索录制的特有格式，需要接入伯索提供的播放器才能播放，接入流程详见Web播放器

快速接入

接入方式#

jssdk接入#

1、引入jssdk#

2、提供挂载元素#

3、初始化#

options参数说明#

callbacks参数说明#

4、sdkClient的API#

url接入#

附录#

query参数表格#

生成query字符串#

1、从query参数表格选择所需的业务参数字段和合适的值#

2、生成签名#

3、组装query字符串#

回调课堂数据#

查询直播相关数据#

播放历史课堂#