获取直播器启动协议
api名称:course.launch
,SDK对应方法:courseLaunch
- 应用参数说明:
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
course_id | int | Y | 课程id |
返回data参数说明:
启动地址、协议有效期为14天,过期需要重新获取,最好是在主播操作的时候再获取,马上使用
名称 | 类型 | 描述 |
---|---|---|
url | string | 登录页面地址。如果是小班,此URL为小班直播页 |
launchPage | string | 大班互动客户端登录页面地址 |
spUrl | string | 管理员登录页面地址 |
protocol | string | Windows启动协议,链接地址为协议内容,放在网页链接里面,点击可以启动直播器 |
protocolMac | string | Mac启动协议,链接地址为协议内容,放在网页链接里面,点击可以启动直播器 |
download | string | Win直播器下载地址 |
downloadMac | string | Mac直播器下载地址 |
token | string | 登录验证token,主播直播器终端(Windows,Mac,App,网页)验证自动登录用 |
spToken | string | 管理员登录验证token,主播直播器终端(Windows,Mac,App,网页)验证自动登录用 |
获取直播器启动协议
api名称:course.login
,SDK对应方法:courseLogin
此接口只是主播登录,没有带上课程信息。如果短时间内有多节课,可能上错课。所以优先用上面的course.launch
- 应用参数说明:
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
account | string | Y | 欢拓主播ID或合作方主播帐号/ID |
accountType | int | Y | 账户类型,枚举:1欢拓账户 ,2合作方账户 |
options | Object | N | 其它可选项。ssl:是否使用https(true为使用,false为不使用) |
- 返回data参数说明:
同上
发布滚动通知
api名称:course.notice.roll
,SDK对应方法:courseNoticeRoll
- 应用参数说明:
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
course_id | int | Y | 课程ID |
content | string | Y | 滚动通知内容 |
link | string | Y | 滚动通知链接 |
duration | string | Y | 滚动通知显示时长(单位:秒) |
- 返回参数说明:code=0为成功,其他值为失败
根据课程ID发送广播`
api名称:course.broadcast.send
,SDK对应方法:courseBroadcastSend
- 应用参数说明:
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
course_id | int | Y | 课程ID |
cmd | string | Y | 事件名称,最多可传30个字符。以:pb 结束的cmd,会保存到回放数据中,但回放逻辑需要自行处理 |
params | object | N | 广播出去的自定义参数,最多可传512个字符 |
options | object | N | 选项 |
touser 广播发给指定用户,格式: {"uid":['user1','user2']};或 {"xid":[1212,12321]},最大数量为50个用户 | |||
torole 广播发给指定用户组,格式: ['admin','user'] | |||
__auto 还没进直播间的用户,进入直播间时,自动接收此广播 |
客户自定义的广播,欢拓会统一在
事件名称
前面增加third:
作为前缀
- 返回参数data说明:
名称 | 类型 | 描述 |
---|---|---|
cmd | string | 事件名称 |
uniqid | string | 唯一ID |
t | int | 当前时间戳 |
查询课程推流地址
api名称:course.pushRtmpUrl
,SDK对应方法:无
此接口获取到的地址用于第三方工具推流,用第三方工具推流后,主播不用也不要登录直播器上课
- 应用参数说明:
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
course_id | int | Y | 课程id |
width | int | N | 视频宽度,最大值 2000,高宽设置用于指定视频的画面比例 |
height | int | N | 视频高度,最大值 2000 |
- 返回data参数说明:
名称 | 类型 | 描述 |
---|---|---|
wh | string | 视频宽高比。 |
pushAddr | string | 外部推流地址 |
拉流转推
api名称:course.setPullLive
,SDK对应方法:courseSetPullLive
此接口设置把第三方平台的直播流转推到欢拓,设置转推后,主播不用也不要登录直播器上课。
拉流开始结束时间为课程时间。
拉流任务期间(课前2分钟到课程结束时间),修改课程时间对任务无影响,如要修改拉流时间,请修改课程时间后,先停止原来的拉流任务,再重新设置任务
- 应用参数说明:
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
course_id | int | Y | 课程id |
pullUrl | string | Y | 源站拉流地址,为空测停止拉流转推。支持rtmp/flv/hls/mp4 |
获取拉流转推设置
api名称:course.getPullLive
,SDK对应方法:courseGetPullLive
- 应用参数说明:
名称 | 类型 | 必选 | 描述 |
---|---|---|---|
course_id | int | Y | 课程id |
- 返回data参数说明:
名称 | 类型 | 描述 |
---|---|---|
pullUrl | string | 拉流地址 |