NERtc iOS SDK
构造函数 | 所有成员列表
<NERtcEngineDelegate>协议 参考

NERtcEngine 常用回调 更多...

#import <NERtcEngineDelegate.h>

类 <NERtcEngineDelegate> 继承关系图:
<NERtcEngineDelegateEx>

构造函数

(void) - onNERtcEngineDidError:
 发生错误回调。 更多...
 
(void) - onNERtcEngineDidWarning:msg:
 发生警告回调。 更多...
 
(void) - onNERtcEngineConnectionStateChangeWithState:reason:
 SDK和服务端的连接状态已改变回调。 更多...
 
(void) - onNERtcEngineDidLeaveChannelWithResult:
 退出房间回调。 更多...
 
(void) - onNERtcEngineDidDisconnectWithReason:
 网络连接中断,且 SDK 连续 3 次重连服务器失败。 更多...
 
(void) - onNERtcEngineRejoinChannel:
 重新加入房间回调。 在弱网环境下,若客户端和服务器失去连接,SDK会自动重连。自动重连成功后触发此回调方法。 更多...
 
(void) - onNERtcEngineUserDidJoinWithUserID:userName:
 远端用户加入当前房间回调。 更多...
 
(void) - onNERtcEngineUserDidLeaveWithUserID:reason:
 远端用户离开当前房间回调。 更多...
 
(void) - onNERtcEngineDidClientRoleChanged:newRole:
 直播场景下用户角色已切换回调。 更多...
 
(void) - onNERtcEngineReconnectingStart
 重连开始回调。 更多...
 
(void) - onNERtcEngineUserAudioDidStart:
 远端用户开启音频回调。 更多...
 
(void) - onNERtcEngineUserAudioDidStop:
 远端用户停用音频回调。 更多...
 
(void) - onNERtcEngineUserVideoDidStartWithUserID:videoProfile:
 远端用户开启视频回调。 更多...
 
(void) - onNERtcEngineUserVideoDidStop:
 远端用户停用视频回调。 更多...
 
(void) - onNERtcEngineUserSubStreamDidStartWithUserID:subStreamProfile:
 远端用户开启屏幕共享辅流通道的回调。 更多...
 
(void) - onNERtcEngineUserSubStreamDidStop:
 远端用户停止屏幕共享辅流通道的回调。 更多...
 

详细描述

NERtcEngine 常用回调

函数文档

◆ onNERtcEngineConnectionStateChangeWithState:reason:

- (void) onNERtcEngineConnectionStateChangeWithState: (NERtcConnectionStateType state
reason: (NERtcReasonConnectionChangedType reason 
optional

SDK和服务端的连接状态已改变回调。

该回调在 SDK 和服务端的连接状态发生改变时触发,并告知用户当前的连接状态和引起状态改变的原因。

参数
state当前的连接状态。详细信息请参考 NERtcConnectionStateType
reason引起当前连接状态改变的原因。详细信息请参考 NERtcReasonConnectionChangedType

◆ onNERtcEngineDidClientRoleChanged:newRole:

- (void) onNERtcEngineDidClientRoleChanged: (NERtcClientRole oldRole
newRole: (NERtcClientRole newRole 
optional

直播场景下用户角色已切换回调。

用户加入房间后,通过 setClientRole 切换用户角色后会触发此回调。例如从主播切换为观众、从观众切换为主播。

注解
直播场景下,如果您在加入房间后调用该方法切换用户角色,调用成功后,会触发以下回调:
  • 主播切观众,本端触发 onNERtcEngineDidClientRoleChanged 回调,远端触发 onNERtcEngineUserDidLeaveWithUserID 回调。
  • 观众切主播,本端触发 onNERtcEngineDidClientRoleChanged 回调,远端触发 onNERtcEngineUserDidJoinWithUserID 回调。
参数
oldRole切换前的角色。
newRole切换后的角色。

◆ onNERtcEngineDidDisconnectWithReason:

- (void) onNERtcEngineDidDisconnectWithReason: (NERtcError reason
optional

网络连接中断,且 SDK 连续 3 次重连服务器失败。

注解
  • SDK 在调用 joinChannel 加入房间成功后,如果和服务器失去连接且连续 3 次重连失败,就会触发该回调。
  • 如果 SDK 在断开连接后,连续 3 次重连失败,SDK 会停止尝试重连。
参数
reason网络连接中断原因。详细信息请查看 NERtcEngineErrorCode.NERtcError

◆ onNERtcEngineDidError:

- (void) onNERtcEngineDidError: (NERtcError errCode
optional

发生错误回调。

该回调方法表示 SDK 运行时出现了网络或媒体相关的错误。

通常情况下,SDK上报的错误意味着 SDK 无法自动恢复,需要 App 干预或提示用户。

参数
errCode错误码。详细信息请参考 NERtcEngineErrorCode.NERtcError

◆ onNERtcEngineDidLeaveChannelWithResult:

- (void) onNERtcEngineDidLeaveChannelWithResult: (NERtcError result
optional

退出房间回调。

App 调用 leaveChannel 方法后,SDK 提示 App 退出房间是否成功。

参数
result退出房间结果。详细信息请参考 NERtcEngineErrorCode.NERtcError

◆ onNERtcEngineDidWarning:msg:

- (void) onNERtcEngineDidWarning: (NERtcWarning warnCode
msg: (NSString *)  msg 
optional

发生警告回调。

该回调方法表示 SDK 运行时出现了网络或媒体相关的警告。

通常情况下,SDK上报的警告意味着 SDK 无法自动适配,需要 App 干预或提示用户。

自从
V4.3.0
参数
warnCode错误码。详细信息请参考 NERtcWarning
msg警告描述。

◆ onNERtcEngineReconnectingStart

- (void) onNERtcEngineReconnectingStart
optional

重连开始回调。

客户端和服务器断开连接时,SDK 会进行重连,重连开始时触发此回调。重连结果请参考 onNERtcEngineRejoinChannel 、onNERtcEngineDidDisconnectWithReason。

◆ onNERtcEngineRejoinChannel:

- (void) onNERtcEngineRejoinChannel: (NERtcError result
optional

重新加入房间回调。 在弱网环境下,若客户端和服务器失去连接,SDK会自动重连。自动重连成功后触发此回调方法。

参数
result重连结果。详细信息请参考 NERtcEngineErrorCode.NERtcError

◆ onNERtcEngineUserAudioDidStart:

- (void) onNERtcEngineUserAudioDidStart: (uint64_t)  userID
optional

远端用户开启音频回调。

参数
userID远端用户 ID。

◆ onNERtcEngineUserAudioDidStop:

- (void) onNERtcEngineUserAudioDidStop: (uint64_t)  userID
optional

远端用户停用音频回调。

参数
userID远端用户 ID。

◆ onNERtcEngineUserDidJoinWithUserID:userName:

- (void) onNERtcEngineUserDidJoinWithUserID: (uint64_t)  userID
userName: (NSString *)  userName 
optional

远端用户加入当前房间回调。

该回调提示有远端用户加入了房间,并返回新加入用户的 ID;如果加入之前,已经有其他用户在房间中了,新加入的用户也会收到这些已有用户加入房间的回调。

该回调在如下情况下会被触发:

  • 远端用户调用 joinChannel 方法加入房间。
  • 远端用户网络中断后重新加入房间。
参数
userID新加入房间的远端用户 ID。
userName新加入房间的远端用户名。废弃字段,无需关注。

◆ onNERtcEngineUserDidLeaveWithUserID:reason:

- (void) onNERtcEngineUserDidLeaveWithUserID: (uint64_t)  userID
reason: (NERtcSessionLeaveReason reason 
optional

远端用户离开当前房间回调。

提示有远端用户离开了房间(或掉线)。用户离开房间有两个原因,即正常离开和超时掉线:

  • 正常离开的时候,远端用户会收到相关消息消息,判断用户离开房间。
  • 超时掉线的依据是,在一定时间内(40~50s),用户没有收到对方的任何数据包,则判定为对方掉线。
参数
userID离开房间的远端用户 ID。
reason远端用户离开的原因。详细信息请参考 NERtcSessionLeaveReason

◆ onNERtcEngineUserSubStreamDidStartWithUserID:subStreamProfile:

- (void) onNERtcEngineUserSubStreamDidStartWithUserID: (uint64_t)  userID
subStreamProfile: (NERtcVideoProfileType profile 
optional

远端用户开启屏幕共享辅流通道的回调。

注解
纯音频 SDK 禁用该接口,如需使用请前往云信官网下载并替换成视频 SDK。
参数
userID远端用户 ID。
profile远端视频分辨率等级。详细信息请参考 NERtcVideoProfileType

◆ onNERtcEngineUserSubStreamDidStop:

- (void) onNERtcEngineUserSubStreamDidStop: (uint64_t)  userID
optional

远端用户停止屏幕共享辅流通道的回调。

注解
纯音频 SDK 禁用该接口,如需使用请前往云信官网下载并替换成视频 SDK。
参数
userID远端用户 ID。

◆ onNERtcEngineUserVideoDidStartWithUserID:videoProfile:

- (void) onNERtcEngineUserVideoDidStartWithUserID: (uint64_t)  userID
videoProfile: (NERtcVideoProfileType profile 
optional

远端用户开启视频回调。

注解
纯音频 SDK 禁用该接口,如需使用请前往云信官网下载并替换成视频 SDK。
参数
userID用户 ID,提示是哪个用户的视频流。
profile远端用户的视频 profile 档位。详细信息请参考 NERtcVideoProfileType

◆ onNERtcEngineUserVideoDidStop:

- (void) onNERtcEngineUserVideoDidStop: (uint64_t)  userID
optional

远端用户停用视频回调。

注解
纯音频 SDK 禁用该接口,如需使用请前往云信官网下载并替换成视频 SDK。
参数
userID远端用户 ID。

该协议的文档由以下文件生成: