JS-SDK - API

  • mzsdk直接调用的API,组件的请参考组件API
名称 参数 描述
checkPlayPermission [Object] 检查用户是否有该活动的观看权限(目前支持白名单和F码权限),传入参数{ticketId:活动编号, uniqueId:"用户id", name:"用户昵称", avatar:"用户头像", phone:"用户手机号", permision:{ id: 授权编号, key: 授权密钥 }, isShowLog:"是否打印log,方便调试"}
init [Object] 初始化直播sdk,传入参数{ticketId:活动编号, uniqueId:"用户id", name:"用户昵称", avatar:"用户头像", phone:"用户手机号", permision:{ id: 授权编号, key: 授权密钥 }, isShowLog:"是否打印log,方便调试"}
connect - sdk初始化完成后,调用此方法,连接到当前直播会话中,与其它用户互动。
disconnect - 断开连接,当用户退出时,调用此方法,结束直播会话,此方法会释放SDK内所有组件。
getOnlines [Object] 获取在线观众列表, 传入参数{ticketId:活动编号, offset:偏移,当前已经获取的数据总个数, limit:请求的个数}
getHostInfo [Object] 获取主播信息, 传入参数{ticketId:活动编号}
getWebinarToolsList [Object] 获取活动的详细配置信息, 传入参数{ticketId:活动编号}
useFCode [Object] 若活动需要F码权限观看,调用使用F码, 传入参数{ticketId:活动编号, fCode:F码}
getDiscussList [Object] 获取该活动下所有的问答列表,传入参数{ticketId:活动编号, isNewReplay:是否查询最新未读回复 0:否 1:是, offset:偏移,当前已经获取的数据总个数, limit:请求的个数}
submitDiscussQuestion [Object] 提交问答问题,传入参数{ticketId:活动编号, content:问题, isAnonymous:是否匿名提问,字符串 0否 1是}
getVideoScreenAdvert [Object] 获取启动广告(暖场图), 传入参数{ticketId:活动编号}
getRollingAdvert [Object] 获取滚动广告(支持文字和图片), 传入参数{ticketId:活动编号}
getVideoAdvert [Object] 获取片头视频广告, 传入参数{ticketId:活动编号}