互动直播>客户端 API>iOS

iOS

编辑文档 更新于
概况BLiveBLiveDelegateBRTCDeviceManagerBLiveBeautyManager对象和枚举错误码

BLiveDelegate 接口采用 Delegate 方法用于向 App 发送回调通知。

错误事件和警告事件  
- (void) onErrnor:errMsg:extInfo
房间事件回调  
- (void) onEnterRoom
- (void) onExitRoom
- (void) onSwitchRole
成员事件回调  
- (void) onRemoteUserEnterRoom
- (void) onRemoteUserLeaveRoom:reason
- (void) onUserVideoAvailable:available
- (void) onUserAudioAvailable:available
- (void) onFirstVideoFrame:streamType:width:height
- (void) onFirstAudioFrame
- (void) onSendFirstLocalVideoFrame
- (void) onSendFirstLocalAudioFrame
混流事件回调 描述
- (void) onStartMixStreamTranscode
- (void) onStopMixStreamTranscode
- (void) onMixStreamAdded
- (void) onMixStreamUpdate
- (void) onMixStreamRemoved
统计和质量回调  
- (void) onStatistics
硬件设备事件回调  
- (void) onUserVoiceVolume:totalVolume
服务器事件回调  
- (void) onConnectionLost
- (void) onTryToReconnect
- (void) onConnectionRecovery
自定义消息的接收回调  
- (void) onRecvCustomCmdMsgUserId:seq:message
- (void) onMissCustomCmdMsgUserId:errCode:missed
- (void) onRecvSEIMsg:message
屏幕分享回调  
- (void) onScreenCaptureStarted
- (void) onScreenCapturePaused
- (void) onScreenCaptureResumed
- (void) onScreenCaptureStoped
Log 信息回调  
- (void) onLog

详细信息

错误回调：SDK 不可恢复的错误，一定要监听，并分情况给用户适当的界面提示 

- (void)onError:(int)errCode errMsg:(nullable NSString *)errMsg extInfo:(nullable NSDictionary*)extInfo;

参数

名称 描述
errCode 错误码
errMsg 错误信息

已加入房间的回调 

- (void)onEnterRoom:(NSInteger)result;

参数

名称 描述
result result > 0 时为进房耗时（ms），result < 0 时为进房错误码

返回

详情

  • 调用 BLive 中的 enterRoom() 接口执行进房操作后，会收到来自 SDK 的 onEnterRoom(result) 回调

离开房间的事件回调 

- (void)onExitRoom:(NSInteger)reason;

参数

名称 描述
reason 离开房间原因:
0：主动调用 exitRoom 退房
1：被服务器踢出当前房间
2：当前房间整个被解散

详情

  • 调用 BLive 中的 exitRoom() 接口会执行退出房间的相关逻辑，例如释放音视频设备资源和编解码器资源等
  • 待资源释放完毕，SDK 会通过 onExitRoom() 回调通知到您
  • 如果您要再次调用 enterRoom() 或者切换到其他的音视频 SDK，请等待 onExitRoom() 回调到来之后再执行相关操作，否则可能会遇到例如摄像头、麦克风设备被强占等各种异常问题

切换角色的事件回调 

- (void)onSwitchRole:(BLiveRoleType)role;

参数

名称 描述
role 角色

有用户加入当前房间 

- (void)onRemoteUserEnterRoom:(NSString *)userId;

参数

名称 描述
userId 用户标识

详情

  • onRemoteUserEnterRoom 和 onRemoteUserLeaveRoom 只适用于维护当前房间里的“成员列表”，如果需要显示远程画面，建议使用监听 onUserVideoAvailable() 事件回调

远端用户是否存在可播放的主路画面（一般用于摄像头） 

- (void)onUserVideoAvailable:(NSString *)userId available:(BOOL)available;

参数

名称 描述
userId 用户标识
available 画面是否开启

详情

  • 收到 onUserVideoAvailable(userid, YES) 通知时，表示该路画面已经有可用的视频数据帧到达，此时，您需要调用 startRemoteView(userid) 接口加载该用户的远程画面，然后，您会收到名为 onFirstVideoFrame(userid) 的首帧画面渲染回调。
  • 收到 onUserVideoAvailable(userid, NO) 通知时，表示该路远程画面已被关闭，可能由于该用户调用了 muteLocalVideo() 或 stopLocalPreview()

远端用户是否存在可播放的音频数据 

- (void)onUserAudioAvailable:(NSString *)userId available:(BOOL)available;

参数

名称 描述
userId 用户标识
available 声音是否开启

开始渲染本地或远程用户的首帧画面 

- (void)onFirstVideoFrame:(NSString *)userId streamType:(BLiveVideoStreamType)streamType width:(int)width height:(int)height;

参数

名称 描述
userId 本地或远程用户 ID，如果 userId == nil 代表本地，userId != nil 代表远程
streamType 视频流类型：摄像头或屏幕分享
width 画面宽度
height 画面高度

详情

  • 如果 userId == nil，代表开始渲染本地采集的摄像头画面，需要您先调用 startLocalPreview 触发。
  • 如果 userId != nil，代表开始渲染远程用户的首帧画面，需要您先调用 startRemoteView 触发。
  • 调用 startLocalPreivew()、startRemoteView() 或 startRemoteSubStreamView() 之后，才会触发该回调。

开始播放远程用户的首帧音频（本地声音暂不通知） 

- (void)onFirstAudioFrame:(NSString *)userId;

参数

名称 描述
userId 远程用户 ID

首帧本地视频数据已经被送出 

- (void)onSendFirstLocalVideoFrame:(BLiveVideoStreamType)streamType;

参数

名称 描述
streamType 视频流类型，主画面、小画面或辅流画面（屏幕分享）

详情

  • SDK 会在 enterRoom() 并 startLocalPreview() 成功后开始摄像头采集，并将采集到的画面进行编码
  • 当 SDK 成功向云端送出第一帧视频数据后，会抛出这个回调事件

首帧本地音频数据已经被送出 

- (void)onSendFirstLocalAudioFrame;

详情

  • SDK 会在 enterRoom() 并 startLocalAudio() 成功后开始麦克风采集，并将采集到的声音进行编码
  • 当 SDK 成功向云端送出第一帧音频数据后，会抛出这个回调事件

主播开始混流 

- (void)onStartMixStreamTranscode:(NSString *)mixStreamID;;

参数

名称 描述
mixStreamID 合流流 ID

详情

  • 收到当前用户发起的合流任务开始，仅用于发起者管理自己发起的合流状况

主播停止混流 

- (void)onStopMixStreamTranscode:(NSString *)mixStreamID;;

参数

名称 描述
mixStreamID 合流流 ID

详情

  • 收到当前用户停止合流任务，仅用于发起者管理自己发起的合流状况

观众收到主播开始混流 

- (void)onMixStreamAdded:(NSString *)mixStreamID mixStreamInfo:(nullable NSArray<BLiveMixStreamDefinitionInfo *> *)mixStreamInfo;

详情

  • 观众收到主播开始混流

观众收到主播更新混流 

- (void)onMixStreamUpdate:(NSString *)mixStreamID mixStreamInfo:(nullable NSArray<BLiveMixStreamDefinitionInfo *> *)mixStreamInfo;

详情

  • 合流更新时如果观众已经调用了播放视频，内部会更新视图的内容

观众收到主播停止混流 

- (void)onMixStreamRemoved:(NSString *)mixStreamID mixStreamInfo:(nullable NSArray<BLiveMixStreamDefinitionInfo *> *)mixStreamInfo;

详情

  • 观众收到主播停止混流

技术指标统计回调 

- (void)onStatistics:(BLiveStatistics *_Nonnull)statistics;

参数

名称 描述
statistics 统计数据,包括本地和远程的

详情

  • 每2秒回调一次

用于提示音量大小的回调,包括每个 userId 的音量和远端总音量 

- (void)onUserVoiceVolume:(NSArray<BLiveVolumeInfo *> *)userVolumes totalVolume:(NSInteger)totalVolume;

参数

名称 描述
userVolumes 所有正在说话的房间成员的音量，取值范围0 - 100
totalVolume 所有远端成员的总音量, 取值范围0 - 100

详情

  • userId 为 nil 时表示自己的音量，userVolumes 内仅包含正在说话（音量不为0）的用户音量信息

SDK 跟服务器的连接断开 

- (void)onConnectionLost;

SDK 尝试重新连接到服务器 

- (void)onTryToReconnect;

SDK 跟服务器的连接恢复 

- (void)onConnectionRecovery;

收到自定义消息回调 

- (void)onRecvCustomCmdMsgUserId:(NSString *)userId cmdID:(NSInteger)cmdID seq:(UInt32)seq message:(NSData *)message;

参数

名称 描述
userId 用户标识
cmdID 命令 ID
seq 消息序号
message 消息数据

详情

  • 当房间中的某个用户使用 sendCustomCmdMsg 发送自定义消息时，房间中的其它用户可以通过 onRecvCustomCmdMsg 接口接收消息

自定义消息丢失回调 

- (void)onMissCustomCmdMsgUserId:(NSString *)userId cmdID:(NSInteger)cmdID errCode:(NSInteger)errCode missed:(NSInteger)missed;

参数

名称 描述
userId 用户标识
cmdID 命令 ID
missed 丢失的消息数量

详情

  • 实时音视频使用 UDP 通道，即使设置了可靠传输（reliable），也无法确保100@%不丢失，只是丢消息概率极低，能满足常规可靠性要求
  • 在发送端设置了可靠运输（reliable）后，SDK 都会通过此回调通知过去时间段内（通常为5s）传输途中丢失的自定义消息数量统计信息
  • 只有在发送端设置了可靠传输（reliable），接收方才能收到消息的丢失回调

收到 SEI 消息的回调 

- (void)onRecvSEIMsg:(NSString *)userId message:(NSData *)message;

参数

名称 描述
userId 用户标识
message 数据

详情

  • 当房间中的某个用户使用 sendSEIMsg 发送数据时，房间中的其它用户可以通过 onRecvSEIMsg 接口接收数据

当屏幕分享开始时，SDK 会通过此回调通知 

- (void)onScreenCaptureStarted;

当屏幕分享暂停时，SDK 会通过此回调通知 

- (void)onScreenCapturePaused:(int)reason;

参数

名称 描述
reason 原因，0：用户主动暂停；1：屏幕窗口不可见暂停

当屏幕分享恢复时，SDK 会通过此回调通知 

- (void)onScreenCaptureResumed:(int)reason;

参数

名称 描述
reason 恢复原因，0：用户主动恢复；1：屏幕窗口恢复可见从而恢复分享

当屏幕分享停止时，SDK 会通过此回调通知 

- (void)onScreenCaptureStoped:(int)reason;

参数

名称 描述
reason 停止原因，0：用户主动停止；1：屏幕窗口关闭导致停止 2: 其他异常原因

有日志打印时的回调 

- (void)onLog:(nullable NSString*)log LogLevel:(BLiveLogLevel)level WhichModule:(nullable NSString*)module;

参数

名称 描述
log 日志内容
level 日志等级，参见 BLiveLogLevel
module 值暂无具体意义，目前为固定值 BLiveSDK
{{allComment[version]}} ×
  • 暂无评论
  • {{comment.author}}
    {{ comment.createdAt | date: 'yyyy-MM-dd HH:mm:ss '}}
    {{comment.content}}
您需要 后才能评论