maple-rtc 音视频SDK集成文档 - iOS

简介：

maple-rtc 为蓝蘑云推出的实时音视频会议系统，包括了实时音频，视频，变声，美颜等功能，适用于娱乐，游戏，教育等实时音视频场景中；

一：下载SDK

1.1 iOS音视频SDK

maple-rtc iOS sdk 目录结构如下：

1.2 iOS音视频demo源码下载

演示的iOS 音视频maple-rtc-iOS-1v1-sample源码；

二：基本API说明

iOS SDK 主要基于object-c 语言调用，包括以下类：

接口调用流程图

音频调用接口流程图：

视频调用接口流程图：

BMediaKit 接口类

注：调用 BMediaKit 的接口最好在同一个线程进行，不建议在不同的线程同时调用。

• sharedEngineWithAppId
• setParameter
• setChannelProfile
• setVideoConferenceProfile
• setMediaProfile
• setJoinChannelUserId
• getSdkVersion
• joinChannel
• leaveChannel
• startLocalAudio
• stopLocalAudio
• muteLocalAudioStream
• muteRemoteAudioStream
• setEnableSpeakerphone
• adjustPlaybackSignalVolume
• adjustRecordingSignalVolume
• enableAudioVolumeIndication
• setupLocalVideo
• setupRemoteVideo
• startPreview
• stopPreview
• switchCamera
• enableCameraTorchOn
• muteLocalVideoStream
• muteRemoteVideoStream
• muteRemoteVideoStream2
• enableBeautify
• setBeautifyLevel

初始化BMediaKit实例(sharedEngineWithAppId)

+ (instancetype)sharedEngineWithAppId:(NSString * _Nonnull)appId
                         delegate:(id<BMediaDelegate> _Nullable)delegate;

该方法初始化 BMediaKit 为一个单例

注意事项:

• 目前 MAPLE SDK 只支持一个 BMediaKit 实例，每个应用程序仅创建一个 BMediaKit 对象 。 SDK 通过指定的 delegate 通知应用程序引擎运行时的事件。Delegate 中定义的所有方法都是可选实现的。

输入参数:

appId:

• 类型：字符串
• 默认值：无
• 描述：管理后台中的appId

delegate:

• 类型：BMediaDelegate
• 默认值：无
• 描述：通知应用程序引擎运行时的事件

返回值：

• 类型：BMediaKit
• 默认值：无
• 描述：BMediaKit 对象

示例代码

self.mBMediaKit = [BMediaKit sharedEngineWithAppId:"6638******fdd2" delegate:self];

设置参数(setParameter)

- (void) setParameter:(NSString * _Nonnull)key withValue:(NSString * _Nonnull)value;

该方法用于设置SDK特殊的参数；

输入参数：

key:

• 类型：字符串常量(NSString)
• 默认值：无
• 描述：参数名字

value:

• 类型：字符串常量(NSString)
• 默认值：无
• 描述：参数值

返回值：

无

示例代码

[self.mBMediaKit setParameter:@"abc" withValue:@"abc"];

设置频道模式(setChannelProfile)

- (int) setChannelProfile:(NSInteger)profile;

该方法用于设置频道模式(profile).

注意事项:

• 同一频道内只能同时设置一种模式；
• 该方法必须在加入频道前调用和进行设置，进入频道后无法再设置；

输入参数：

profile:

• 类型：NSInteger
• 默认值：CHANNELPROFILEVOICE_ONLY(纯语音模式)
• 描述：频道模式，CHANNELPROFILEVOICEONLY = 0 纯语音模式，CHANNELPROFILEVOICEVIDEO = 1 语音视频模式，CHANNELPROFILELIVE_LOOK = 2 直播观看模式，

返回值：

• 类型：int
• 默认值：无
• 描述：0 失败，1 成功

示例代码

int ret = [self.mBMediaKit setChannelProfile:CHANNEL_PROFILE_VOICE_VIDEO];

设置视频会议属性(setVideoConferenceProfile)

- (int) setVideoConferenceProfile:(NSInteger)profile;

该方法用于设置视频会议属性(profile).

注意事项:

• 同一频道内只能同时设置一种模式；
• 加入房间成功后，默认情况为服务器端转发模式(sfu)；
• 该方法必须在加入频道前调用和进行设置，进入频道后无法再设置；

输入参数:

profile:

• 类型：NSInteger
• 默认值：VIDEOCONFERENCEPROFILE_SFU
• 描述：频道模式，VIDEOCONFERENCEPROFILENORMAL 同时支持sfu和mcu，VIDEOCONFERENCEPROFILESFU 服务器端转发模式(sfu)，VIDEOCONFERENCEPROFILE_MCU 服务器端混屏模式(mcu)，当前默认支持4路窗口混屏；

返回值：

• 类型：int
• 默认值：无
• 描述：0 失败，1 成功

示例代码

int ret = [self.mBMediaKit setVideoConferenceProfile:VIDEO_CONFERENCE_PROFILE_MCU];

设置媒体属性(setMediaProfile)

- (int) setMediaProfile:(NSInteger)audioProfile withVideo:(NSInteger)videoProfile;

该方法用于设置媒体模式.

注意事项:

• 同一频道内只能同时设置一种媒体模式；

params

audioProfile:

• 类型：NSInteger
• 默认值：AUDIOPROFILEVOICE_STANDARD
• 描述：音频模式，AUDIOPROFILEVOICESTANDARD voice标准模式，AUDIOPROFILEVOICEHIGHQUALITY voice高质量模式，AUDIOPROFILEMUSICSTANDARD music标准模式，AUDIOPROFILEMUSICHIGHQUALITY music高质量模式；

videoProfile:

• 类型：NSInteger
• 默认值 : VIDEOPROFILE360P
• 描述：视频模式，VIDEOPROFILE240P 320240分辨率，VIDEOPROFILE360P 640360分辨率，VIDEOPROFILE480P 640*480分辨率，

返回值：

• 类型：int
• 默认值：无
• 描述：0 失败，1 成功

示例代码

int ret = [self.mBMediaKit setMediaProfile:AUDIO_PROFILE_VOICE_STANDARD withVideo: VIDEO_PROFILE_480P];

设置加入频道用户Id(setJoinChannelUserId)

- (int) setJoinChannelUserId:(NSString * _Nonnull)uid;

该方法用于设置加入频道用户Id.

注意事项:

• 加入频道的用户Id必须在整个appId中唯一，相同的用户Id登录会将同Id用户踢下线；
• 用户Id为字符串，长度为小于等于32个字符；
• 该方法必须在加入频道前调用和进行设置，进入频道后无法再设置；

输入参数：

uid:

• 类型：字符串常量(NSString)
• 默认值：无
• 描述：加入频道的用户Id

返回值

• 类型：int
• 默认值：无
• 描述：0 失败，1 成功

示例代码

int ret = [self.mBMediaKit setJoinChannelUserId:@"123"];

查询SDK版本号(getSdkVersion)

+ (NSUInteger)getSdkVersion;

该方法返回SDK版本号。

输入参数：

无

返回值

• 类型：NSUInteger
• 默认值：无
• 描述：SDK编译版本号；

示例代码

NSUInteger version = [BMediaKit getSdkVersion];

加入频道(joinChannel)

- (int)joinChannel:(NSString * _Nonnull)channelId;

该方法允许用户加入频道。如果频道尚未建立，调用该方法可以自动创建频道。 同一个频道内的用户可以互相通话，多个用户加入同一个频道，可以群聊。使用不同 App ID 的应用程序是不能互通的。如果已在通话中，用户必须调用 leaveChannel 退出当前通话，才能进入下一个频道。

注意事项:

• 调用该方法时，系统会随机产生一个用户ID，在onJoinChannelSuccess监听到当前加入频道的uid值；
• 加入频道后，扬声器和麦克风默认打开；摄像头预览默认关闭；
• SDK 在通话中使用 iOS 系统的 AVAudioSession 共享对象进行录音和播放，应用程序对该对象的操作可能会影响 SDK 的音频相关功能。

输入参数：

channelId:

• 类型：字符串常量（NSString）
• 默认值：无
• 描述：加入频道Id

返回值

• 类型：int
• 默认值：无
• 描述：0 失败，1 成功

示例代码

int ret = [self.mBMediaKit joinChannel:@"123"];

带uid加入频道(joinChannel)

- (int)joinChannel:(NSString * _Nonnull)channelId
                uid:(NSString * _Nonnull)uid;

该方法允许用户加入频道。如果频道尚未建立，调用该方法可以自动创建频道。 同一个频道内的用户可以互相通话，多个用户加入同一个频道，可以群聊。使用不同 App ID 的应用程序是不能互通的。如果已在通话中，用户必须调用 leaveChannel 退出当前通话，才能进入下一个频道。

注意事项:

• 该 uid 不能与AppId内现有的其他用户 uid 相同，否则AppId内持有相同 uid 用户的服务将被迫停止。
• uid 属性限制于setJoinChannelUserId参数uid一样。
• 加入频道后，扬声器和麦克风默认打开；摄像头预览默认关闭；
• SDK 在通话中使用 iOS 系统的 AVAudioSession 共享对象进行录音和播放，应用程序对该对象的操作可能会影响 SDK 的音频相关功能。

输入参数：

channelId:

• 类型：字符串常量（NSString）
• 默认值：无
• 描述：加入频道Id

uid:

• 类型：字符串常量（NSString）
• 默认值：无
• 描述：加入频道的用户Id

返回值

• 类型：int
• 默认值：无
• 描述：0 失败，1 成功

示例代码

int ret = [self.mBMediaKit joinChannel:@"123" uid:@"nick"];

离开频道(leaveChannel)

- (int)leaveChannel;

该方法为用户离开频道，即挂断或退出通话。通过调用 joinChannel 加入频道后，必须调用 leaveChannel 以结束通话，否则不能进行下一次通话。 不管当前是否在通话中，都可以调用 leaveChannel，没有副作用。leaveChannel 会把会话相关的所有资源释放掉。

输入参数：

无

返回值

• 类型：int
• 默认值：无
• 描述：0 失败，1 成功

示例代码

int ret = [self.mBMediaKit leaveChannel];

开启本地音频的采集和上行(startLocalAudio)

- (int) startLocalAudio;

开启本地音频的采集和上行。调用该方法后，打开录音设备，在同一频道内的其他用户听到你的声音；

params

无

返回值

• 类型：int
• 默认值：无
• 描述：0 失败，1 成功

示例代码

int ret = [self.mBMediaKit startLocalAudio];

关闭本地音频的采集和上行(stopLocalAudio)

- (int) stopLocalAudio;

开启本地音频的采集和上行。调用该方法后，关闭录音设备，在同一频道内的其他用户将无法听到你的声音，；

params

无

返回值

• 类型：int
• 默认值：无
• 描述：0 失败，1 成功

示例代码

    int ret = [self.mBMediaKit stopLocalAudio];

将自己禁音(muteLocalAudioStream)

- (int)muteLocalAudioStream:(BOOL)muted;

静音/取消静音。调用该方法后，在同一频道内的其他用户将无法听到你的声音；

输入参数：

muted:

• 类型：BOOL
• 默认值：无
• 描述：YES 设置本地静音，即麦克风静音； NO 取消本地静音；

返回值

• 类型：int
• 默认值：无
• 描述：0 失败，1 成功

示例代码

int ret = [self.mBMediaKit muteLocalAudioStream:YES];

静音指定用户音频(muteRemoteAudioStream)

- (int)muteRemoteAudioStream:(NSString * _Nonnull)uid mute:(BOOL)muted;

该方法用于允许/禁止播放远端指定用户的音频流。没有被禁止用户的音频流接受和播放正常；

输入参数：

uid:

• 类型：字符串常量（NSString）
• 默认值：无
• 描述：加入频道的用户Id

muted:

• 类型：BOOL
• 默认值：无
• 描述：YES 停止播放指定用户的音频流； NO 允许播放指定用户的音频流；

返回值

• 类型：int
• 默认值：无
• 描述：0 失败，1 成功

示例代码

[self.mBMediaKit muteRemoteAudioStream:@"nick" mute:YES];

打开外放扬声器模式(setEnableSpeakerphone)

- (int)setEnableSpeakerphone:(BOOL)enableSpeaker;

该方法用于打开/关闭外放扬声器模式，即听筒和扬声器播放的切换；

输入参数：

enableSpeaker:

• 类型：BOOL
• 默认值：无
• 描述：YES 切换至外放扬声器模式； NO 切换至听筒模式；

返回值

• 类型：int
• 默认值：无
• 描述：0 失败，1 成功

示例代码

int ret = [self.mBMediaKit setEnableSpeakerphone:YES]

调节播放信号音量(adjustPlaybackSignalVolume)

- (int)adjustPlaybackSignalVolume:(NSUInteger)volume;

该方法用于调节播放信号音量；软件调节播放信号音量，默认值为100（原始音量），最大调整为200（即原始音量的2倍），如果为小于等于0，即软件级静音，无法听到任何远端音频流；

输入参数：

volume:

• 类型：NSUInteger
• 默认值：100
• 描述：软件调节播放信号音量，默认值为100（原始音量），最大调整为200（即原始音量的2倍），如果为小于等于0，即软件级静音，无法听到任何远端音频流；

返回值

• 类型：int
• 默认值：无
• 描述：0 失败，1 成功

示例代码

int ret = [self.mBMediaKit adjustPlaybackSignalVolume:50]

调节录音信号音量(adjustRecordingSignalVolume)

- (int)adjustRecordingSignalVolume:(NSUInteger)volume;

该方法用于调节录音信号音量；软件调节录音信号音量，默认值为100（原始音量），最大调整为400（即原始音量的4倍）；如果为小于等于0，即软件级静音，对方将听不到你说话声音；

输入参数：

volume:

• 类型：NSUInteger
• 默认值：100
• 描述：软件调节录音信号音量，默认值为100（原始音量），最大调整为400（即原始音量的4倍）；如果为小于等于0，即软件级静音，对方将听不到你说话声音；

返回值

• 类型：int
• 默认值：无
• 描述：0 失败，1 成功

示例代码

int ret = [self.mBMediaKit adjustRecordingSignalVolume:50];

启用用户说话音量提示(enableAudioVolumeIndication)

- (int)enableAudioVolumeIndication:(NSInteger)interval;

该方法允许 SDK 定期向应用程序反馈当房间里所有用户说话的音量。

注意事项:

• 在onAudioVolumeIndication(int volume) 回调函数中获得相关信息;

输入参数：

interval:

• 类型：int
• 默认值：无
• 描述：指定音量提示的时间间隔。<20: 禁用音量提示功能 >=20: 提示间隔，单位为毫秒。建议设置到大于 500 毫秒

返回值

• 类型：int
• 默认值：无
• 描述：0 失败，1 成功

示例代码

int ret = [self.mBMediaKit enableAudioVolumeIndication:500]

设置本地视频显示属性(setupLocalVideo)

- (int)setupLocalVideo:(BMVideoCanvas* _Nullable)local;

该方法设置本地视频显示信息。应用程序通过调用此接口绑定本地视频流的显示视窗(view)，并设置视频显示模式。

注意事项:

• 加入频道，调用该方法进行本地视频设置，退出频道后，绑定自动解除；
• 如果需要手动解除绑定，可以指定BMVideoCanvas.view 为空(NULL)View 来调用 setupLocalVideo。

输入参数：

local:

• 类型：Class BMVideoCanvas
• 默认值：无
• 描述：设置视频属性。

Class BMVideoCanvas 描述 * view: 视频显示视窗, * renderMode: 视频显示模式, RENDERMODEHIDDEN (1): 如果视频尺寸与显示视窗尺寸不一致，则视频流会按照显示视窗的比例进行周边裁剪或图像拉伸后填满视窗。RENDERMODEFIT(2): 如果视频尺寸与显示视窗尺寸不一致，在保持视频长宽比的前提下，将视频进行缩放后填满视窗。 * uid: 本地用户 ID，与 joinChannel 方法中的 uid 保持一致

返回值

• 类型：int
• 默认值：无
• 描述：0 失败，1 成功

示例代码

int ret = [self.mBMediaKit setupLocalVideo:[[BMVideoCanvas alloc] init:self.localVideo withMode:RENDER_MODE_HIDDEN withUid:@"nick"]];

设置远端视频显示属性(setupRemoteVideo)

- (int)setupRemoteVideo:(BMVideoCanvas* _Nullable)remote;

该方法绑定远程用户和显示视图，即设定 uid 指定的用户用哪个视图显示。调用该接口时需要指定远程视频的 uid；

注意事项:

• 加入频道，调用该方法进行远端视频设置，退出频道后，绑定自动解除；
• 如果应用程序不能事先知道对方的 uid，可以在 APP 收到 onUserJoinedNotice 事件时设置；
• 如果需要手动解除绑定，可以指定BMVideoCanvas.view 为空(NULL)View 来调用 setupRemoteVideo。

输入参数：

remote:

• 类型：Class BMVideoCanvas
• 默认值：无
• 描述：设置视频属性。

Class BMVideoCanvas 描述 * view: 视频显示视窗, * renderMode: 视频显示模式, RENDERMODEHIDDEN (1): 如果视频尺寸与显示视窗尺寸不一致，则视频流会按照显示视窗的比例进行周边裁剪或图像拉伸后填满视窗。RENDERMODEFIT(2): 如果视频尺寸与显示视窗尺寸不一致，在保持视频长宽比的前提下，将视频进行缩放后填满视窗。 * uid: 远端用户 ID，在 onUserJoinedNotice 事件中获取；

返回值

• 类型：int
• 默认值：无
• 描述：0 失败，1 成功

示例代码

int ret = [self.mBMediaKit setupRemoteVideo:[[BMVideoCanvas alloc] init:self.remoteVideo withMode:RENDER_MODE_HIDDEN withUid:@"nick"]];

开启视频预览(startPreview)

- (int)startPreview;

该方法用于启动本地视频预览。

注意事项:

• 加入频道后，调用该方法进行启动本地视频预览，退出频道后，自动停止视频预览；
• 在开启预览前，必须先调用 setupLocalVideo 设置预览窗口及属性。

输入参数：

无

返回值

• 类型：int
• 默认值：无
• 描述：0 失败，1 成功

示例代码

int ret = [self.mBMediaKit startPreview];

停止视频预览(stopPreview)

- (int)stopPreview;

该方法用于停止本地视频预览。

注意事项:

• 该方法必须在加入频道joinChannel后才可以调用，进入频道前无法调用；
• 在退出频道leaveChannel后，该方法自动调用，无需额外手动操作关闭预览；
• 如果已经调用了muteLocalVideoStream 开始发送本地视频，调用该方法后，视频也将停止发送，再次开始本地预览后，需要手动再次调用发送本地视频；

输入参数：

无

返回值

• 类型：int
• 默认值：无
• 描述：0 失败，1 成功

示例代码

int ret = [self.mBMediaKit stopPreview];

切换前置/后置摄像头 (switchCamera)

- (int)switchCamera;

该方法用于在前置/后置摄像头间切换。

注意事项:

• 必须先调用startPreview后，调用该方法才有效；
• 开启本地预览后，默认为前置摄像头；
• 在退出频道leaveChannel后，自动恢复到默认的前置摄像头；

输入参数：

无

返回值

• 类型：int
• 默认值：无
• 描述：0 失败，1 成功

示例代码

int ret = [self.mBMediaKit switchCamera];

设置是否打开闪光灯(enableCameraTorchOn)

- (int)enableCameraTorchOn:(BOOL)enabled;

该方法用于开关摄像头闪光灯。

注意事项:

• 必须先调用startPreview后，调用该方法才有效；
• 在退出频道leaveChannel后，自动关闭摄像头闪光灯；

输入参数：

enabled:

• 类型：BOOL
• 默认值：关闭
• 描述：YES 打开闪光灯； NO 关闭闪光灯；

返回值

• 类型：int
• 默认值：无
• 描述：0 失败，1 成功

示例代码

int ret = [self.mBMediaKit enableCameraTorchOn:YES];;

暂停/恢复发送本地视频流(muteLocalVideoStream)

- (int)muteLocalVideoStream:(BOOL)muted;

该方法用于允许/禁止往网络发送本地视频流；

注意事项:

• 必须先调用startPreview后，调用该方法才有效；
• 如果已经调用了该方法开始发送本地视频，调用stopPreview后，视频也将停止发送，再次开始本地预览后，需要手动调用该方法来发送本地视频；
• 在退出频道leaveChannel后，该方法自动调用，无需额外手动停止发送本地视频；

输入参数:

muted:

• 类型：BOOL
• 默认值：无
• 描述：YES 停止发送本地视频流； NO 开始发送本地视频流；

返回值:

• 类型：int
• 默认值：无
• 描述：0 失败，1 成功

示例代码

int ret = [self.mBMediaKit muteLocalVideoStream:YES];

暂停/恢复指定远端视频流(muteRemoteVideoStream)

- (int)muteRemoteVideoStream:(NSString * _Nonnull)uid mute:(BOOL)muted;

该方法用于允许/禁止播放指定远端视频流；

注意事项:

• 在退出频道leaveChannel后，自动禁止播放指定远端视频流；

输入参数:

uid:

• 类型：字符串常量(NSString)
• 默认值：无
• 描述：远端用户Id

muted:

• 类型：布尔型(BOOL)
• 默认值：无
• 描述：YES 停止播放指定用户的视频流； NO 允许播放指定用户的视频流；

返回值:

• 类型：int
• 默认值：无
• 描述：0 失败，1 成功

示例代码

int ret = [self.mBMediaKit muteRemoteVideoStream:uid mute:NO];

暂停/恢复指定远端视频流(muteRemoteVideoStream2)

- (int)muteRemoteVideoStream2:(NSString * _Nonnull)uid mute:(BOOL)muted;

该方法用于允许/禁止播放指定远端视频流；

注意事项:

• 在退出频道leaveChannel后，自动禁止播放指定远端视频流；
• 该接口默认为小于等于4人通话视频显示，cpu使用会更低；

输入参数:

uid:

• 类型：字符串常量(NSString)
• 默认值：无
• 描述：远端用户Id

muted:

• 类型：布尔型(BOOL)
• 默认值：无
• 描述：true 停止播放指定用户的视频流； false 允许播放指定用户的视频流；

返回值:

• 类型：int
• 默认值：无
• 描述：0 失败，1 成功

示例代码

int ret = [self.mBMediaKit muteRemoteVideoStream2:uid mute:NO];

开关视频美颜功能(enableBeautify)

- (void)enableBeautify:(BOOL)enabled;

该方法用于打开/关闭视频美颜功能；

注意事项:

• 在退出频道leaveChannel后，自动关闭视频美颜功能；

params

enabled:

• 类型：布尔型(BOOL)
• 默认值：无
• 描述：YES 打开视频美颜； NO 关闭视频美颜；

返回值:

• 类型：int
• 默认值：无
• 描述：0 失败，1 成功

示例代码

int ret = [self.mBMediaKit enableBeautify:YES];

设置美颜等级(setBeautifyLevel)

- (int)setBeautifyLevel:(float)value;

该方法用于设置美颜等级功能；

注意事项:

• 在退出频道leaveChannel后，自动关闭视频美颜功能；

params

value:

• 类型：浮点数(float)
• 默认值：无
• 描述：参数值范围为0.0～1.0，0.0为无美颜；

返回值:

• 类型：int
• 默认值：无
• 描述：0 失败，1 成功

示例代码

int ret = [self.mBMediaKit setBeautifyLevel:0.5];

BMediaDelegate 回调接口类

• onJoinChannelSuccess
• onJoinChannelFailed
• onLeaveChannel
• onForceKickOutChannel
• onUserJoinedNotice
• onUserOfflineNotice
• onWarning
• onError
• onAudioVolumeIndication
• onConnectionLost
• onFirstRemoteVideoFrameSizeChanged

注意:

SDK 会通过代理方法 BMediaDelegate 向应用程序上报一些运行时事件。 必须在加入频道前调用 (instancetype)sharedEngineWithAppId:(NSString * _Nonnull)appId delegate:(id _Nullable)delegate;方法时传入delegate来使能回调产生。

加入频道成功回调 (onJoinChannelSuccess)

- (void)rtcEngine:(BMediaKit * _Nonnull)engine onJoinChannelSuccess:(NSString* _Nonnull)channelId withUid:(NSString* _Nonnull)uid;

表示客户端登入服务器成功，且创建和分配了频道 ID 和用户 ID。频道 ID 的分配是根据 joinChanel API 中指定的频道名称。如果调用 joinChannel 时并未指定用户 ID，服务器就会随机分配一个。

回调参数

channelId:

• 类型：字符串常量（NSString）
• 默认值：无
• 描述：返回加入的频道Id

uid:

• 类型：字符串常量（NSString）
• 默认值：无
• 描述：返回加入频道的用户Id， 如果 joinChannel 中指定了 uid，则此处返回该 ID；否则使用平台服务器会自动分配 ID；

加入频道失败回调 (onJoinChannelFailed)

- (void)rtcEngine:(BMediaKit * _Nonnull)engine onJoinChannelFailed:(MapleRtcJoinChannelFailedReason)reason;

表示客户端登入服务器失败。

回调参数

reason:

• 类型：MapleRtcJoinChannelFailedReason枚举
• 默认值：无
• 描述：登录频道失败状态码

离开频道回调 (onLeaveChannel)

- (void)rtcEngine:(BMediaKit * _Nonnull)engine onLeaveChannel:(MapleRtcLeaveChannelReason)reason;

用程序调用 leaveChannel() 方法时，SDK提示应用程序离开频道成功或者失败。参数reason表示具体原因状态码。

回调参数

reason:

• 类型：MapleRtcLeaveChannelReason枚举
• 默认值：无
• 描述：离开频道状态码

强行踢出频道回调 (onForceKickOutChannel)

- (void)rtcEngine:(BMediaKit * _Nonnull)engine onForceKickOutChannel:(MapleRtcKickedOutReason)reason;

由于某种原因，自己强行被系统踢下线。参数reason表示具体原因状态码。

回调参数

reason:

• 类型：MapleRtcKickedOutReason枚举
• 默认值：无
• 描述：踢出频道状态码

用户加入当前频道回调 (onUserJoinedNotice)

- (void)rtcEngine:(BMediaKit * _Nonnull)engine onUserJoinedNotice:(NSArray * _Nonnull)uids;

提示有用户加入了频道。如果该客户端加入频道时已经有人在频道中，SDK也会向应用程序上报这些已在频道中的全部用户。

回调参数

uids:

• 类型：NSArray
• 默认值：无
• 描述：在频道中的所有用户列表；

用户离开当前频道回调 (onUserOfflineNotice)

- (void)rtcEngine:(BMediaKit * _Nonnull)engine onUserOfflineNotice:(NSArray * _Nonnull)uids;

提示有用户离开了频道（或掉线）。

回调参数

uids:

• 类型：NSArray
• 默认值：无
• 描述：退出当前频道的用户列表；

发生警告回调 (onWarning)

- (void)rtcEngine:(BMediaKit * _Nonnull)engine onWarning:(MapleRtcWarningCode)warningCode;

该回调方法表示 SDK 运行时出现了（网络或媒体相关的）警告。 通常情况下，SDK上报的警告信息应用程序可以忽略，SDK 会自动恢复。

回调参数

reason:

• 类型：MapleRtcWarningCode枚举
• 默认值：无
• 描述：警告状态代码

发生错误回调 (onError)

- (void)rtcEngine:(BMediaKit * _Nonnull)engine onError:(MapleRtcErrorCode)errorCode;

表示 SDK 运行时出现了（网络或媒体相关的）错误。 通常情况下，SDK 上报的错误意味着 SDK 无法自动恢复，需要 APP 干预或提示用户。

回调参数

reason:

• 类型：MapleRtcErrorCode枚举
• 默认值：无
• 描述：错误状态代码

启用用户说话音量提示回调 (onAudioVolumeIndication)

- (void)rtcEngine:(BMediaKit * _Nonnull)engine onAudioVolumeIndication:(NSInteger)volume;

该方法允许 SDK 定期向应用程序反馈当前房间里谁在输入声音的音量。该提示默认为关闭状态，如有需要，调用 enableAudioVolumeIndication 方法触发该提示。

回调参数

volume:

• 类型：NSInteger
• 默认值：无
• 描述：所有人说话音量总和(0~255)；

volumeInfo * 类型：NSDictionary * 默认值：无 * 描述：说话者音量信息(0~255)；

连接丢失回调 (onConnectionLost)

- (void)rtcEngine:(BMediaKit * _Nonnull)engine onConnectionLost:(MapleRtcWarningCode)warningCode;

连接丢失监听事件；sdk 和服务器失去了网络连接，并且尝试自动重连一段事件（15s左右）后仍未连上。回调该事件后，sdk将不会再次自动重连，需要用户手动调用leaveChannel，后再次尝试加入频道；

回调参数

无

远端第一帧视频解码成功提示回调 (onFirstRemoteVideoFrameSizeChanged)

- (void)rtcEngine:(BMediaKit * _Nonnull)engine onFirstRemoteVideoFrameSizeChanged:(NSString* _Nonnull)uid size:(CGSize)size;

该方法允许 SDK 向应用程序反馈远端第一帧视频解码成功的回调。当调用muteRemoteVideoStream2或者muteRemoteVideoStream后，该回调会产生；

回调参数

size:

• 类型：CGSize
• 默认值：无
• 描述：解码成功的视频宽高；

uid:

• 类型：字符串常量（NSString）
• 默认值：无
• 描述：远端视频的uid，该用户的视频被解码成功；

回调状态码