抱石云开放API接入文档

iOS直播接入Api【查看完整API目录列表】

直播间API

类:BSYLiveKit

BSYLiveParam参数说明

字段名 类型 描述
tenantId uint64_t 租户ID(必填)
userId NSString 用户UID(必填)
nickName NSString 用户昵称(选填)
avatarUrl NSString 用户头像(选填)
liveId NSString 直播间ID(必填)
enterCode NSString 直播间EnterCode(必填)
customStaticData NSString 直播间静态透传数据,数据长度不大于128字符, 否则无效 (选填)

初始化直播间API

API 描述
initWithParameter: 初始化
loginLive 登录直播间
logoutLive 退出直播间 说明:退出直播间后将停止聊天及直播视频播放
getLiveName 获取直播间名 说明:直播间登录成功后有效
isRtcLive 是否为Rtc直播间 说明:直播间登录成功后有效

初始化直播间回调

API 描述
loginSuccess 登录成功
loginFail:message: 登录失败
onRecvForceOffline 强制被踢下线 说明:强制踢下线后,如需继续使用直播间,则需要重新登录
onRecvUserSigExpired 直播间登录过期 说明:登录过期后,如需继续使用直播间,则需要重新登录
onRecvLiveUserInfo: 直播间登录的用户信息
onRecvLiveRoleList: 角色列表
onRecvLiveOnlineCountDisplay: 是否显示在线人数
onRecvLiveOnlineCount: 在线人数

角色列表说明

字段名 类型 描述
uid NSString 用户uid
buid NSString 抱石云uid,用于IM聊天消息角色类型匹配使用
roleType NSUInteger 角色类型: 1=老师 2=助教 3=班主任 4=管理员,

Live直播API (仅对Live直播类型有效)

API 描述
setMainVideoContainerView: 设置Live直播类型视频画面
getCurrentLiveResolution 获取Live直播类型当前清晰度
getResolutionListWithLineId: 获取Live直播类型当前线路清晰度列表
getCurrentLiveLine 获取Live直播类型当前线路
getLiveLineList 获取Live直播类型当前线路列表
refreshLiveSucc:fail: 刷线直播流
switchResolution:succ:fail: 切换清晰度(线路保持不变)
switchLineWithId:succ:fail: 切换线路(清晰度保持不变)
switchLineWithId:resolution:succ:fail: 切换线路及清晰度

Live直播线路清晰度回调(仅对Live直播类型有效)

API 描述
onRecvCurrentLiveLine:resolution: 回调当前线路及清晰度回调

直播状态回调

API 描述
onRecvLiveStatusChangeStart 主讲开始推流
onRecvLiveStatusChangeEnd: 停止直播及是否为异常停止推流
onRecvLivePreparePlaying 准备播放
onRecvLiveStatusPlaying: 是否在播放
onRecvLiveStatusBuffering: 是否缓冲中

互动直播API

API 描述
setTeacherVideoContainerView: 设置老师的摄像头父View
removeTeacherVideoContainerView 移除老师的摄像头父View
setSelfBroadcastVideoContainerView: 设置自己的摄像头父View
removeSelfBroadcastVideoContainerView 移除自己的摄像头父View
getSelfBroadcastVideoDisable 当前是摄像头被禁用
getSelfBroadcastAudioDisable 当前是否麦克风被禁用
getSelfBroadcastVideoMute 当前摄像头是否关闭
getSelfBroadcastAudioMute 当前麦克风是否关闭
setRemoteUserVideoContainerViewWithUid:containerView: 设置其他连麦用户的摄像头父View
removeRemoteUserVideoContainerViewWithUid: 移除其他连麦用户的摄像头父View
raiseHandRequestSucc:fail: 互动直播举手请求,老师确认后自动上麦互动
cancelRaiseHandSucc:fail: 取消当前举手等待。当老师长时间未响应学生举手请求,学生可以主动取消举手
confirmInvitBroadcast:withTeacherId:succ:fail: 确认是否同意点名,同意后学生将上麦互动。如果老师未点名则调用无效
disConnectBroadcastSucc:fail: 停止连麦互动 如果当前用户未连麦,则设置无效,返回失败
modifyBroadcastMuteVideo: 用户上麦情况下,设置自己摄像头开启状态。如果当前用户未上麦,则设置无效
modifyBroadcastMuteAudio: 用户上麦情况下,设置自己麦克风开启状态。如果当前用户未上麦,则设置无效

BSYLiveInteractiveType互动类型说明

状态 描述
BSYLiveInteractiveType_None 不允许学生互动连麦
BSYLiveInteractiveType_VideoAndAudio 允许音视频连麦
BSYLiveInteractiveType_Audio 允许语音连麦

BSYLiveInteractiveStatusReasonType互动状态原因说明

状态 描述
BSYLiveInteractiveStatusReasonType_None
BSYLiveInteractiveStatusReasonType_SelfConfirm 当前用户自己确认
BSYLiveInteractiveStatusReasonType_TeacherConfirm 老师确认
BSYLiveInteractiveStatusReasonType_Reconnect 用户异常退出席位,重新连接上麦
BSYLiveInteractiveStatusReasonType_SelfCancel 当前用户主动取消
BSYLiveInteractiveStatusReasonType_TeacherCancel 老师取消

互动直播回调

API 描述
onRecvLiveInteractiveType: 互动直播互动类型
onRecvTeacherAudioMute: 老师摄像头关闭状态
onRecvTeacherVideoMute: 老师摄像头关闭状态
onRecvTeacherVolumeChange: 老师麦克风音量变化 音量值:0-100
onRecvInvitBroadcastFromTeacherUid: 收到上麦邀请 收到邀请后需要调用【- (void)confirmInvitBroadcast:(BOOL)isAgree withTeacherId:(NSString )teacherId succ:(BSYLiveKitSuccess nullable)succ fail:(BSYLiveKitFail nullable)fail;】确认是否上麦。如果确定上麦则调用【- (void)setSelfBroadcastVideoContainerView:(UIView )containerView】设置承载自己视频窗口View
onRecvSelfBroadcastConnectChangeStatus:withReasonType: 自己连麦状态变更通知
onRecvSelfRaiseHandChangeStatus:withReasonType: 自己举手状态变更通知
onRecvAllBroadcastAudioDisable: 全员禁用麦克风,由老师端设置
onRecvSelfBroadcastAudioDisable: 用户麦克风被禁用,由老师端设置
onRecvSelfBroadcastVideoDisable: 用户摄像头被禁用,由老师端设置
onRecvSelfBroadcastAudioMute: 麦克风关闭
onRecvSelfBroadcastVideoMute: 摄像头关闭
onRecvSelfBroadcastVolumeChange: 自己麦克风音量变化 音量值:0-100
onRecvRemoteBroadcastAudioMute:withUid: 其他连麦用户麦克风关闭状态
onRecvRemoteBroadcastVideoMute:withUid: 其他连麦用户摄像头关闭
onRecvRemoteBroadcastVolumeChangeWithUid:volumeValue: 其他连麦用户麦克风音量变化 音量值:0-100
onRecvRemoteBroadcastUserListChange: 其他用户连麦列表变更通知 (其他用户:除老师和自己外连麦用户)

白板API

API 描述
setWhiteboardContainer: 设置白板容器 说明:确定传入的 container 已经添加在 ViewController 的视图栈中。否则 iOS 12 开始,无法正确初始化,且不会有任何错误反馈, 且 ViewController 添加if (@available(iOS 11, *)) {} else {self.automaticallyAdjustsScrollViewInsets = NO; }
quitWhiteboard 退出白板

白板回调

API 描述
onRecvWhiteboardMode: 白板模式回调, YES-白板模式 NO-无白板 如果为白板模式可以调用 - (void)setWhiteboardContainer:(UIView *)container; 设置白板窗口

聊天API

API 描述
sendTextMsg:succ:fail: 发送直播聊天文本消息
sendTextMsg:withCustomPaylodData:succ:fail: 发送直播群聊天文本消息和附加自定义透传内容并回调发送成功的消息内容.(透传自定义内容长度不超过128字符)
getLastMessageHistorySucc:fail: 获取聊天历史记录 每次20条

聊天回调

API 描述
onRecvChatMessage: 收到聊天消息,包含图片或文本
onRecvDeleteChatMessage: 删除聊天消息回调
onRecvLiveRoomAllMuteStatus: 全员禁止发消息

群自定消息

API 描述
sendGroupCustomMsg:succ:fail: 发送群组自定义消息 消息体字符串长度不大于2000字符

群自定消息回调

API 描述
onRecvCustomGroupMsg: 接收群组自定义消息
onRecvCustomPersonMsg: 接收单播自定义消息

点赞API

API 描述
addLikeCount: 发送点赞

点赞回调

API 描述
onRecvLikeTotalCount:newAddCount: 点赞总数及新增点赞数

评测API

API 描述
getQuestionListSucc:fail: 获取问答列表
getQuestionTokenSucc:fail: 获取问答Token 仅支持使用抱石云评测

评测回调

API 描述
onRecvExamUrl: 评测URL

口令红包API

API 描述
getActivityListSucc:fail: 获取红包列表

口令回调

API 描述
onRecvRedPacketUrl: 口令红包下发URL

通知回调

API 描述
onRecvCommonUrl: 活动链接地址下发
onRecvEventNotify: 通知下发

货架回调

API 描述
onRecvProductsOnShelf: 显示货架
onRecvProductsOffShelf: 隐藏货架

results matching ""

    No results matching ""