回调

@protocol RTSDelegate <NSObject>

RTSDelegate 协议包含了SDK提供的回调方法，SDK通过代理向应用程序上报一些运行时事件

成员函数

函数说明

rtsEngine:onConnectionStateChanged:

- (void)rtsEngine:(RTS * _Nonnull)engine onConnectionStateChanged:(ByteRTCConnectionState)state;

SDK 与信令服务器连接状态改变回调。连接状态改变时触发。

传入参数

注意
更多信息参见 连接状态提示。

rtsEngine:onNetworkTypeChanged:

- (void)rtsEngine:(RTS * _Nonnull)engine onNetworkTypeChanged:(ByteRTCNetworkType)type;

SDK 当前网络连接类型改变回调。当 SDK 的当前网络连接类型发生改变时回调该事件。

传入参数

rtsEngine:onCreateRoomStateChanged:errorCode:

- (void)rtsEngine:(RTS *_Nonnull)engine onCreateRoomStateChanged:(NSString * _Nonnull)roomId errorCode:(NSInteger)errorCode;

创建房间失败回调。

传入参数

rtsEngine:onLocalProxyStateChanged:withProxyState:withProxyError:

- (void)rtsEngine:(RTS * _Nonnull)engine onLocalProxyStateChanged:(ByteRTCLocalProxyType)type withProxyState:(ByteRTCLocalProxyState)state withProxyError:(ByteRTCLocalProxyError)error;

本地代理状态发生改变回调。调用 setLocalProxy: 设置本地代理后，SDK 会触发此回调，返回代理连接的状态。

传入参数

rtsEngine:onSysStats:

- (void)rtsEngine:(RTS * _Nonnull)engine onSysStats:(const ByteRTCSysStats * _Nonnull)stats;

周期性（2s）地发出回调，报告当前 cpu 与内存的使用率

传入参数

rtsEngine:onLoginResult:errorCode:elapsed:

- (void)rtsEngine:(RTS * _Nonnull)engine onLoginResult:(NSString * _Nonnull)uid errorCode:(ByteRTCLoginErrorCode)errorCode elapsed:(NSInteger)elapsed;

登录 RTS 服务器结果回调。

传入参数

注意
调用 login:uid: 后，会收到此回调。

rtsEngineOnLogout:

- (void)rtsEngineOnLogout:(RTS * _Nonnull)engine;

登出结果回调

传入参数

注意
调用 logout 后，会收到此回调。

rtsEngine:onServerParamsSetResult:

- (void)rtsEngine:(RTS * _Nonnull)engine onServerParamsSetResult:(NSInteger)errorCode;

设置应用服务器参数的返回结果

传入参数

注意
调用 setServerParams:url: 后，会收到此回调。

rtsEngine:onGetPeerOnlineStatus:status:

- (void)rtsEngine:(RTS * _Nonnull)engine onGetPeerOnlineStatus:(NSString * _Nonnull)peerUserId status:(ByteRTCUserOnlineStatus)status;

查询对端或本端用户登录状态的返回结果

传入参数

注意
必须先调用 getPeerOnlineStatus:，才能收到此回调。

rtsEngine:onMessageReceived:message:

- (void)rtsEngine:(RTS * _Nonnull)engine onMessageReceived:(NSString * _Nonnull)uid message:(NSString * _Nonnull)message;

收到远端用户调用 sendMessage:message:config: 发来的文本消息时，会收到此回调。

传入参数

rtsEngine:onBinaryMessageReceived:message:

- (void)rtsEngine:(RTS * _Nonnull)engine onBinaryMessageReceived:(NSString * _Nonnull)uid message:(NSData * _Nonnull)message;

收到房间外用户调用 sendBinaryMessage:message:config: 发来的二进制消息时，会收到此回调。

传入参数

rtsEngine:onMessageSendResult:error:

- (void)rtsEngine:(RTS * _Nonnull)engine onMessageSendResult:(int64_t)msgid error:(ByteRTCUserMessageSendResult)error;

发送 p2p 消息的结果回调。

传入参数

注意
当调用 sendMessage:message:config: 或 sendBinaryMessage:message:config: 发送消息后，会收到此回调。

rtsEngine:onServerMessageSendResult:error:message:

- (void)rtsEngine:(RTS * _Nonnull)engine onServerMessageSendResult:(int64_t)msgid error:(ByteRTCUserMessageSendResult)error message:(NSData * _Nonnull)message;

发送 p2server 消息的结果回调。

传入参数

注意
当调用 sendServerMessage: 或 sendServerBinaryMessage: 接口发送消息后，会收到此回调。

@protocol RTSRoomDelegate <NSObject>

语音房间事件回调接口

成员函数

函数说明

rtsRoom:onRoomStateChanged:withUid:state:extraInfo:

- (void)rtsRoom:(RTSRoom * _Nonnull)rtcRoom onRoomStateChanged:(NSString * _Nonnull)roomId withUid:(nonnull NSString *)uid state:(NSInteger)state extraInfo:(nonnull NSString *)extraInfo;

房间状态改变回调，加入房间、异常退出房间、发生房间相关的警告或错误时会收到此回调。

传入参数

rtsRoomOnLeaveRoom:

- (void)rtsRoomOnLeaveRoom:(RTSRoom *_Nonnull)rtsRoom;

离开房间成功回调。

用户调用 leaveRoom 方法后，SDK 会停止房间内消息的收发，并在释放所有相关资源后，通过此回调通知用户离开房间成功。

传入参数

注意
用户调用 leaveRoom 方法离开房间后，如果立即销毁 RTC 引擎，则将无法收到此回调事件。

rtsRoom:onUserJoined:elapsed:

- (void)rtsRoom:(RTSRoom * _Nonnull)rtcRoom onUserJoined:(NSString * _Nonnull)uid elapsed:(NSInteger)elapsed;

远端用户首次进房，或断网后重新连入房间时，房间内其他用户将收到该事件。

传入参数

rtsRoom:onUserLeave:reason:

- (void)rtsRoom:(RTSRoom * _Nonnull)rtcRoom onUserLeave:(NSString * _Nonnull)uid reason:(ByteRTCUserOfflineReason)reason;

远端用户离开房间时，本地用户会收到此事件

传入参数

rtsRoom:onRoomMessageReceived:message:

- (void)rtsRoom:(RTSRoom * _Nonnull)rtcRoom onRoomMessageReceived:(NSString * _Nonnull)uid message:(NSString * _Nonnull)message;

收到房间中调用 sendRoomMessage: 发送的广播文本消息时，收到此回调。

传入参数

rtsRoom:onRoomBinaryMessageReceived:message:

- (void)rtsRoom:(RTSRoom * _Nonnull)rtcRoom onRoomBinaryMessageReceived:(NSString * _Nonnull)uid message:(NSData * _Nonnull)message;

收到房间中调用 sendRoomBinaryMessage: 发送的广播二进制消息时，收到此回调。

传入参数

rtsRoom:onRoomMessageSendResult:error:

- (void)rtsRoom:(RTSRoom * _Nonnull)rtcRoom onRoomMessageSendResult:(int64_t)msgid error:(ByteRTCRoomMessageSendResult)error;

向房间内所有用户群发文本或二进制消息后，消息发送方会收到该消息发送结果回调。

传入参数

注意

• 你应调用 sendRoomMessage: 向房间内群发文本消息
• 你应调用 sendRoomBinaryMessage: 向房间内群发二进制消息