概览
ARtcEngineDelegate 接口类采用 Delegate 方法用于向 App 发送回调通知。
SDK 会通过代理方法 ARtcEngineDelegate 向 App 上报一些运行时的事件。如果同一个回调 Block 和 Delegate 方法都有定义,则 SDK 只回调 Block 方法。
核心事件回调
didOccurWarning
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine didOccurWarning:(ARWarningCode)warningCode;
发生警告回调
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
warningCode | 警告码,详见 ARWarningCode |
didOccurError
- (void)rtcEngine:(ARtcEngineKit *_Nonnull)engine didOccurError:(ARErrorCode)errorCode;
发生错误回调
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
errorCode | 错误码,详见 ARErrorCode |
didJoinChannel
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine didJoinChannel:(NSString * _Nonnull)channel withUid:(NSString * _Nonnull)uid elapsed:(NSInteger)elapsed;
加入频道回调
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
channel | 频道名称 |
uid | 用户ID |
elapsed | 从调用joinChannelByToken开始到发生此事件过去的时间(ms)。 |
didRejoinChannel
- (void)rtcEngine:(ARtcEngineKit *_Nonnull)engine didRejoinChannel:(NSString *_Nonnull)channel withUid:(NSString * _Nonnull)uid elapsed:(NSInteger)elapsed;
重新加入频道回调
有时候由于网络原因,客户端可能会和服务器失去连接,SDK 会进行自动重连,自动重连成功后触发此回调方法。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
channel | 频道名称 |
uid | 用户ID |
elapsed | 从开始重连到重连成功的时间(ms)。 |
didLeaveChannelWithStats
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine didLeaveChannelWithStats:(ARChannelStats * _Nonnull)stats;
已离开频道回调
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
stats | 通话相关的统计信息,详见ARChannelStats |
didClientRoleChanged
- (void)rtcEngine:(ARtcEngineKit *_Nonnull)engine didClientRoleChanged:(ARClientRole)oldRole newRole:(ARClientRole)newRole;
用户角色已切换回调
直播场景下,当本地用户在加入频道后调用 setClientRole切换角色时会触发此回调,即主播切换为观众时,或观众切换为主播时。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
oldRole | 切换前的角色 |
newRole | 切换后的角色 |
didJoinedOfUid
- (void)rtcEngine:(ARtcEngineKit *_Nonnull)engine didJoinedOfUid:(NSString *_Nonnull)uid elapsed:(NSInteger)elapsed;
远端用户/主播加入回调
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
uid | 新加入频道的远端用户/主播 ID。如果 joinChannelByToken 中指定了 uid,则此处返回该 ID;否则使用ar云平台服务器自动分配的 ID。 |
elapsed | 从本地用户加入频道 joinChannelByToken开始到发生此事件过去的时间(ms)。 |
didOfflineOfUid
- (void)rtcEngine:(ARtcEngineKit *_Nonnull)engine didOfflineOfUid:(NSString *_Nonnull)uid reason:(ARUserOfflineReason)reason;
远端用户(通信场景)/主播(直播场景)离开当前频道回调
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
uid | 离线的用户 ID。 |
reason | 离线原因,详见 ARUserOfflineReason。 |
connectionChangedToState
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine connectionChangedToState:(ARConnectionStateType)state reason:(ARConnectionChangedReason)reason;
网络连接状态已改变回调
该回调在网络连接状态发生改变的时候触发,并告知用户当前的网络连接状态,和引起网络状态改变的原因。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
state | 当前的网络连接状态,详见 ARConnectionStateType |
reason | 引起网络连接状态发生改变的原因,详见 ARConnectionChangedReason |
networkTypeChangedToType
- (void)rtcEngine:(ARtcEngineKit *_Nonnull)engine networkTypeChangedToType:(ARNetworkType)type;
本地网络类型发生改变回调
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
type | 网络连接类型,详见 ARNetworkType。 |
rtcEngineConnectionDidLost
- (void)rtcEngineConnectionDidLost:(ARtcEngineKit *_Nonnull)engine;
网络连接中断,且 SDK 无法在 10 秒内连接服务器回调
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
tokenPrivilegeWillExpire
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine tokenPrivilegeWillExpire:(NSString *_Nonnull)token;
Token 服务即将过期回调
在调用 joinChannelByToken 时如果指定了 Token,由于 Token 具有一定的时效,在通话过程中如果 Token 即将失效,SDK 会提前 30 秒触发该回调,提醒应用程序更新 Token。 当收到该回调时,用户需要重新在服务端生成新的 Token,然后调用renewToken 将新生成的 Token 传给 SDK。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
token | 即将服务失效的 Token |
rtcEngineRequestToken
- (void)rtcEngineRequestToken:(ARtcEngineKit * _Nonnull)engine;
Token 过期回调
在调用 joinChannelByToken 时如果指定了 Token,由于 Token 具有一定的时效,在通话过程中 SDK 可能由于网络原因和服务器失去连接,重连时可能需要新的 Token。 该回调通知 App 需要生成新的 Token,并需调用 renewToken 为 SDK 指定新的 Token。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
媒体事件回调
reportAudioVolumeIndicationOfSpeakers
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine reportAudioVolumeIndicationOfSpeakers:(NSArray<ARtcAudioVolumeInfo *> * _Nonnull)speakers totalVolume:(NSInteger)totalVolume;
提示频道内谁正在说话、说话者音量及本地用户是否在说话的回调
与 audioVolumeIndicationBlock 相同。
该回调报告频道内瞬时音量最高的几个用户(最多三个用户)的用户 ID、他们的音量及本地用户是否在说话。
该回调默认禁用。可以通过 enableAudioVolumeIndication 方法开启;开启后,无论频道内是否有人说话,SDK 都会按 enableAudioVolumeIndication 方法中设置的时间间隔触发 reportAudioVolumeIndicationOfSpeakers 回调。每次触发,用户会收到两个独立的 reportAudioVolumeIndicationOfSpeakers 回调,其中一个包含本地用户的音量信息,另一个包含远端所有用户的音量信息,详见下方参数描述。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
speakers | ARtcAudioVolumeInfo数组在本地用户的回调中,此数组中包含以下成员:uid = "0"在远端用户的回调中,此数组中包含以下成员: |
totalVolume | (混音后的)总音量,取值范围为 [0,255]。 |
注意事项:
- 若需使用该回调 speakers 数组中的 vad 参数(即本地人声检测功能),请在 enableAudioVolumeIndication 方法中设置 report_vad 为YES。
- 如果有用户将自己静音(调用了 muteLocalAudioStream),会对该回调的行为产生影响。
- 本地用户静音后 SDK 即不再报告本地用户的音量提示回调。
- 远端说话者静音后 20 秒,远端的音量提示回调中将不再包含该用户;如果远端所有用户都将自己静音,20 秒后 SDK 不再报告远端用户的音量提示回调。
activeSpeaker
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine activeSpeaker:(NSString * _Nonnull)speakerUid;
监测到活跃用户的回调
该回调获取当前时间段内累积音量最大者。如果用户开启了 enableAudioVolumeIndication 功能,则当音量检测模块监测到频道内有新的活跃用户说话时,会通过本回调返回该用户的 uid。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
speakerUid | 当前时间段声音最大的用户的 uid。 |
firstLocalAudioFrame
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine firstLocalAudioFrame:(NSInteger)elapsed;
已发送本地音频首帧的回调
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
elapsed | 从本地用户调用joinChannelByToken开始到发生此事件过去的时间(ms)。 |
firstLocalVideoFrameWithSize
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine firstLocalVideoFrameWithSize:(CGSize)size elapsed:(NSInteger)elapsed;
已显示本地视频首帧的回调
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
size | 本地渲染的视频尺寸(宽度和高度) |
elapsed | 从本地用户调用joinChannelByToken到发生此事件过去的时间(ms)。如果在joinChannelByToken前调用了startPreview,是从startPreview到发生此事件过去的时间。 |
remoteAudioStateChangedOfUid
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine remoteAudioStateChangedOfUid:(NSString *_Nonnull)uid state:(ARAudioRemoteState)state reason:(ARAudioRemoteStateReason)reason elapsed:(NSInteger)elapsed;
远端音频流状态发生改变回调
远端用户/主播音频状态发生改变时,SDK 会触发该回调向本地用户报告当前的远端音频流状态。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
uid | 发生音频状态改变的远端用户 ID。 |
state | 远端音频流状态。详见 ARAudioRemoteState。 |
reason | 远端音频流状态改变的具体原因。详见 ARAudioRemoteStateReason。 |
elapsed | 从本地用户调用 joinChannelByToken 方法到发生本事件经历的时间,单位为 ms。 |
localAudioStateChange
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine localAudioStateChange:(ARAudioLocalState)state error:(ARAudioLocalError)error;
本地音频状态发生改变回调
本地音频的状态发生改变时(包括本地麦克风录制状态和音频编码状态),SDK会触发该回调报告当前的本地音频状态。在本地音频出现故障时,该回调可以帮助你了解当前音频的状态以及出现故障的原因,方便你排查问题。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
state | 当前的本地音频状态。详见 ARAudioLocalState。 |
error | 本地音频出错原因。详见 ARAudioLocalError。 |
videoSizeChangedOfUid
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine videoSizeChangedOfUid:(NSString *_Nonnull)uid size:(CGSize)size rotation:(NSInteger)rotation;
本地或远端视频大小和旋转信息发生改变回调
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
uid | 图像尺寸和旋转信息发生变化的用户的用户 ID |
size | 新的视频尺寸 |
rotation | 旋转信息 (0 到 360) |
remoteVideoStateChangedOfUid
- (void)rtcEngine:(ARtcEngineKit *_Nonnull)engine remoteVideoStateChangedOfUid:(NSString *_Nonnull)uid state:(ARVideoRemoteState)state reason:(ARVideoRemoteStateReason)reason elapsed:(NSInteger)elapsed;
远端视频状态发生改变回调
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
uid | 发生视频状态改变的远端用户 ID。 |
state | 远端视频流状态。详见 ARVideoRemoteState。 |
reason | 远端视频流状态改变的具体原因。详见 ARVideoRemoteStateReason。 |
elapsed | 从本地用户调用 joinChannelByToken 方法到发生本事件经历的时间,单位为 ms。 |
localVideoStateChange
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine localVideoStateChange:(ARLocalVideoStreamState)state error:(ARLocalVideoStreamError)error;
本地视频状态发生改变回调
本地视频的状态发生改变时,SDK 会触发该回调返回当前的本地视频状态。
在本地视频出现故障时,你可以通过该回调了解当前视频的状态以及出现故障的原因,方便排查问题。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
state | 本地视频状态,详见 ARLocalVideoStreamState。当本地视频状态为 ARLocalVideoStreamStateFailed(3) 时,你可以在 error 参数中查看返回的错误原因。 |
error | 本地视频出错原因,详见 ARLocalVideoStreamError。 |
snapshotTaken
- (void)rtcEngine:(ARtcEngineKit* _Nonnull)engine snapshotTaken:(NSString *_Nonnull)uid filePath:(NSString* _Nonnull)filePath width:(NSInteger)width height:(NSInteger)height errCode:(NSInteger)errCode;
视频截图结果回调。
成功调用 takeSnapshot 后,SDK 触发该回调报告截图是否成功和获取截图的详情。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
uid | 用户 ID |
filePath | 截图的本地保存路径。 |
width | 图片宽度(px) |
height | 图片高度(px) |
errCode | 截图成功的提示或失败的原因。0:截图成功。-1:写入文件失败或 JPEG 编码失败。-2:takeSnapshot 方法调用成功后 1 秒内没有发现指定用户的视频流。-3:takeSnapshot 方法调用过于频繁。 |
统计数据事件回调
remoteAudioStats
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine remoteAudioStats:(ARtcRemoteAudioStats * _Nonnull)stats;
通话中远端音频流的统计信息回调,用于取代 audioQualityOfUid
该回调描述远端用户在通话中端到端的音频流统计信息,针对每个远端用户/主播每 2 秒触发一次。
如果远端同时存在多个用户/主播,该回调每 2 秒会被触发多次。
和 audioTransportStatsOfUid 回调相比,该回调更贴近用户的主观感受。
比如,当网络发生丢包时,因 FEC(Forward Error Correction,向前纠错码)或重传恢复,最终的音频丢帧率不高,则可以认为整个质量较好。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
stats | 远端音频统计数据,详细定义见 ARtcRemoteAudioStats。 |
reportRtcStats
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine reportRtcStats:(ARChannelStats * _Nonnull)stats;
当前通话统计回调。 该回调在通话或直播中每两秒触发一次。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
stats | 通话相关的数据统计信息,详见ARChannelStats |
networkQuality
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine networkQuality:(NSString * _Nonnull)uid txQuality:(ARNetworkQuality)txQuality rxQuality:(ARNetworkQuality)rxQuality;
通话中每个用户的网络上下行 last mile 质量报告回调
该回调描述每个用户在通话中的 last mile 网络状态,其中 last mile 是指设备到 ar云平台 边缘服务器的网络状态。
该回调每 2 秒触发一次。如果远端有多个用户,该回调每 2 秒会被触发多次。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
uid | 用户 ID。表示该回调报告的是持有该 ID 的用户的网络质量。 |
txQuality | 该用户的上行网络质量。基于上行视频的发送码率、上行丢包率、平均往返时延和网络抖动计算。该值代表当前的上行网络质量,帮助判断是否可以支持当前设置的视频编码属性。 |
假设上行码率是 500 Kbps,那么支持 480 x 480 的分辨率、30 fps 的帧率没有问题,但是支持 1280 x 720 的分辨率就会有困难。详见 ARNetworkQuality。 | | rxQuality | 该用户的下行网络质量。基于下行网络的丢包率、平均往返延时和网络抖动计算。详见 ARNetworkQuality。 |
localVideoStats
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine localVideoStats:(ARtcLocalVideoStats * _Nonnull)stats;
本地视频流统计信息回调
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
stats | 报告更新本地视频统计信息,该回调方法每两秒触发一次。 |
localAudioStats
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine localAudioStats:(ARtcLocalAudioStats * _Nonnull)stats;
通话中本地音频流的统计信息回调。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
stats | stats 本地音频统计数据。详见 ARtcLocalAudioStats。 |
remoteVideoStats
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine remoteVideoStats:(ARtcRemoteVideoStats * _Nonnull)stats;
通话中远端视频流的统计信息回调
该回调描述远端用户在通话中端到端的视频流统计信息,针对每个远端用户/主播每 2 秒触发一次。
如果远端同时存在多个用户/主播,该回调每 2 秒会被触发多次。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
stats | 远端视频统计数据,详见 ARtcRemoteVideoStats |
音频播放事件回调
rtcEngineLocalAudioMixingDidFinish
- (void)rtcEngineLocalAudioMixingDidFinish:(ARtcEngineKit *_Nonnull)engine;
本地音乐文件播放已结束回调
本地用户调用 startAudioMixing 播放音乐文件音乐结束后,会触发该回调。如果调用 startAudioMixing 失败,会在 didOccurWarning 回调里,返回警告代码 ARWarningCodeAudioMixingOpenError。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
rtcEngineDidAudioEffectFinish
- (void)rtcEngineDidAudioEffectFinish:(ARtcEngineKit * _Nonnull)engine soundId:(NSInteger)soundId;
本地音效文件播放已结束回调
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
soundId | 自行设定的音效 ID,需保证唯一性。 |
直播输入在线媒体流事件回调
streamInjectedStatusOfUrl
- (void)rtcEngine:(ARtcEngineKit *_Nonnull)engine streamInjectedStatusOfUrl:(NSString *_Nonnull)url uid:(NSString * _Nonnull)uid status:(ARInjectStreamStatus)status;
输入外部视频流状态回调
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
url | 输入进直播的外部视频源 URL 地址 |
uid | 用户 ID |
status | 详见 ARInjectStreamStatus |
媒体设备事件回调
didAudioRouteChanged
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine didAudioRouteChanged:(ARAudioOutputRouting)routing;
语音路由已发生变化回调
当语音路由发生变化时,SDK 会触发此回调。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
routing | 设置语音路由,详见 ARAudioOutputRouting |
facePositionDidChangeWidth
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine facePositionDidChangeWidth:(int)width previewHeight:(int)height faces:(NSArray<ARFacePositionInfo *> *_Nullable)faces;
报告本地人脸检测结果
调用 enableFaceDetection(YES) 开启本地人脸检测后,你可以通过该回调实时获取以下人脸检测的信息:
- 摄像头采集的画面大小
- 人脸在画面中的位置
- 人脸距设备屏幕的距离,该值由 SDK 通过摄像头采集的画面大小和人脸在画面中的位置拟合计算得出
注意事项:
- 当检测到摄像头前没有人脸时,该回调触发频率会降低,以节省设备耗能。
- 当人脸距离设备屏幕过近时,SDK 不会触发该回调。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
height | 摄像头采集画面的宽度 (px)。 |
width | 摄像头采集画面的高度 (px)。 |
faces | 检测到的人脸信息,详见 ARFacePositionInfo 。 |
检测到几张人脸,就会报告几个 ARFacePositionInfo 数组。数组长度可以为 0,表示没有检测到摄像头前出现人脸。
跨频道媒体流转发回调
channelMediaRelayStateDidChange
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine channelMediaRelayStateDidChange:(ARChannelMediaRelayState)state error:(ARChannelMediaRelayError)error;
跨频道媒体流转发状态发生改变回调
当跨频道媒体流转发状态发生改变时,SDK 会触发该回调,并报告当前的转发状态以及相关的错误信息。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
state | 跨频道媒体流转发状态, 详见ARChannelMediaRelayState |
error | 跨频道媒体流转发出错的错误码, 详见ARChannelMediaRelayError |
didReceiveChannelMediaRelayEvent
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine didReceiveChannelMediaRelayEvent:(ARChannelMediaRelayEvent)event;
跨频道媒体流转发事件回调
当跨频道媒体流转发状态发生改变时,SDK 会触发该回调,并报告当前的转发状态以及相关的错误信息。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
event | 跨频道媒体流转发事件码 |
CDN 旁路推流事件回调
rtmpStreamingChangedToState
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine rtmpStreamingChangedToState:(NSString * _Nonnull)url state:(ARtmpStreamingState)state errorCode:(ARtmpStreamingErrorCode)errorCode;
RTMP 推流状态发生改变回调
该回调返回本地用户调用 addPublishStreamUrl 或 removePublishStreamUrl 方法的结果。
RTMP 推流状态发生改变时,SDK 会触发该回调,并在回调中明确状态发生改变的 URL 地址及当前推流状态。
该回调方便推流用户了解当前的推流状态;推流出错时,你可以通过返回的错误码了解出错的原因,方便排查问题。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
url | 推流状态发生改变的 URL 地址 |
state | 当前的推流状态,详见 ARtmpStreamingState。当推流状态为 ARtmpStreamingStateFailure(4) 时,你可以在 errorCode 参数中查看返回的错误信息 |
errorCode | 具体的推流错误信息,详见 ARtmpStreamingErrorCode |
rtmpStreamingEventWithUrl
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine rtmpStreamingEventWithUrl:(NSString * _Nonnull)url eventCode:(ARtmpStreamingEvent)eventCode;
RTMP 推流事件回调。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
url | RTMP 推流 URL |
eventCode | RTMP 推流事件码。详见 ARtmpStreamingEvent |
streamPublishedWithUrl
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine streamPublishedWithUrl:(NSString * _Nonnull)url errorCode:(ARErrorCode)errorCode;
开启旁路推流的结果回调
返回 addPublishStreamUrl 方法的调用结果。如果调用不成功,你可以在 errorCode 参数中查看详细的错误信息。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
url | 主播推流地址或输入的外部音视频流地址 |
eventCode | 常见的错误码如下,详情见 ARErrorCode |
streamUnpublishedWithUrl
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine streamUnpublishedWithUrl:(NSString * _Nonnull)url;
停止旁路推流的结果回调
返回 removePublishStreamUrl 方法的调用结果。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
url | 主播停止推流的 RTMP 地址 |
rtcEngineTranscodingUpdated
- (void)rtcEngineTranscodingUpdated:(ARtcEngineKit * _Nonnull)engine;
旁路推流设置被更新回调
setLiveTranscoding 方法中的直播参数 LiveTranscoding rtcEngineTranscodingUpdated 回调会被触发并向主播报告更新信息。 Note:
首次调用 setLiveTranscoding 方法设置转码参数 LiveTranscoding 时,不会触发此回调。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
其它回调方法
firstRemoteVideoFrameOfUid
- (void)rtcEngine:(ARtcEngineKit *_Nonnull)engine firstRemoteVideoFrameOfUid:(NSString *_Nonnull)uid size:(CGSize)size elapsed:(NSInteger)elapsed;
已显示远端视频首帧回调
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
uid | 远端用户 ID |
size | 视频尺寸(宽和高) |
elapsed | 从本地用户调用joinChannelByToken到发生此事件过去的时间(ms)。 |
注意事项: 推荐使用remoteVideoStateChangedOfUid回调。
firstRemoteVideoDecodedOfUid
- (void)rtcEngine:(ARtcEngineKit *_Nonnull)engine firstRemoteVideoDecodedOfUid:(NSString *_Nonnull)uid size:(CGSize)size elapsed:(NSInteger)elapsed;
已完成远端视频首帧解码回调
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
uid | 远端用户 ID |
size | 视频流尺寸(宽度和高度) |
elapsed | 从本地用户调用 joinChannelByToken到发生此事件过去的时间(ms)。 |
注意事项: 收到该回调,可调用setupRemoteVideo方法显示远端视图。推荐使用 remoteVideoStateChangedOfUid 回调的 ARVideoRemoteStateStarting(1) 和 ARVideoRemoteStateDecoding(2)。
firstRemoteAudioFrameOfUid
- (void)rtcEngine:(ARtcEngineKit *_Nonnull)engine firstRemoteAudioFrameOfUid:(NSString *_Nonnull)uid elapsed:(NSInteger)elapsed;
已接收远端音频首帧的回调
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
uid | 远端用户 ID |
elapsed | 从本地用户调用joinChannelByToken到发生此事件的时间(ms)。 |
注意事项: 推荐使用 remoteAudioStateChangedOfUid 回调。
firstRemoteAudioFrameDecodedOfUid
- (void)rtcEngine:(ARtcEngineKit *_Nonnull)engine firstRemoteAudioFrameDecodedOfUid:(NSString *_Nonnull)uid elapsed:(NSInteger)elapsed;
已解码远端音频首帧的回调
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
uid | 远端用户 ID |
elapsed | 从本地用户调用 joinChannelByToken 直至该回调触发的延迟,单位为毫秒。 |
注意事项: 推荐使用 remoteAudioStateChangedOfUid 回调。SDK 完成远端音频首帧解码,并发送给音频模块用以播放时,会触发此回调。有两种情况:
- 远端用户首次上线后发送音频
- 远端用户音频离线再上线发送音频。音频离线指本地在 15 秒内没有收到音频包,可能有如下原因:
- 远端用户离开频道
- 远端用户掉线
- 远端用户停止发送音频流(调用了 muteLocalAudioStream)
- 远端用户关闭音频(调用了 disableAudio)
didVideoMuted
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine didVideoMuted:(BOOL)muted byUid:(NSString *_Nonnull)uid;
muteLocalVideoStream触发 )
远端用户暂停/重新发送视频回调(由参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
muted | 暂停或恢复发送视频流: |
uid | 远端用户 UID |
注意事项: 推荐使用 remoteVideoStateChangedOfUid 回调的:
- ARVideoRemoteStateStopped(0) and ARVideoRemoteStateReasonRemoteMuted(5).
- ARVideoRemoteStateDecoding(2) 和 ARVideoRemoteStateReasonRemoteUnmuted(6)。
- 当频道内的用户或主播数超过 20 人,该回调会失效。
didAudioMuted
- (void)rtcEngine:(ARtcEngineKit *_Nonnull)engine didAudioMuted:(BOOL)muted byUid:(NSString *_Nonnull)uid;
远端用户音频静音回调
该回调是由远端用户调用 muteLocalAudioStream 方法关闭或开启音频发送触发的。当频道内的用户或主播人数超过 20 时,该回调不生效。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
muted | YES: 静音 NO:取消静音 |
uid | 远端用户 ID |
注意事项: 推荐使用 remoteAudioStateChangedOfUid 回调:
- ARAudioRemoteReasonRemoteMuted(5)
- ARAudioRemoteReasonRemoteUnmuted(6)
didVideoEnabled
- (void)rtcEngine:(ARtcEngineKit *_Nonnull)engine didVideoEnabled:(BOOL)enabled byUid:(NSString *_Nonnull)uid;
enableVideo 或 disableVideo触发)
其他用户启用/关闭视频回调(参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
enabled | 是否启用了视频功能: |
uid | 远端用户 ID |
注意事项: 推荐使用 remoteVideoStateChangedOfUid 回调的:
- ARVideoRemoteStateStopped(0) 和 ARVideoRemoteStateReasonRemoteMuted(5)。
- ARVideoRemoteStateDecoding(2) 和 ARVideoRemoteStateReasonRemoteUnmuted(6)。
提示有其他用户启用/关闭了视频功能。关闭视频功能是指该用户只能进行语音直播,不能显示、发送自己的视频,也不能接收、显示别人的视频。 该回调是由远端用户调用 enableVideo 或 disableVideo 方法开启或关闭视频模块触发的。
didLocalVideoEnabled
- (void)rtcEngine:(ARtcEngineKit *_Nonnull)engine didLocalVideoEnabled:(BOOL)enabled byUid:(NSString *_Nonnull)uid;
enableLocalVideo触发)
其他用户启用/关闭本地视频回调(参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
enabled | 是否启用了视频功能 |
uid | 远端用户 ID |
注意事项: 推荐使用 remoteVideoStateChangedOfUid 回调的:
- ARVideoRemoteStateStopped(0) 和 ARVideoRemoteStateReasonRemoteMuted(5)。
- ARVideoRemoteStateDecoding(2) 和 ARVideoRemoteStateReasonRemoteUnmuted(6)。
didMicrophoneEnabled
- (void)rtcEngine:(ARtcEngineKit *_Nonnull)engine didMicrophoneEnabled:(BOOL)enabled;
麦克风状态已改变回调
该回调是由本地用户调用 enableLocalAudio 方法开启或关闭本地音频采集触发的。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
enabled | YES: 麦克风已启用 NO: 麦克风已禁用 |
注意事项: 推荐使用 localAudioStateChange 回调的: ARAudioLocalStateStopped(0) 或 ARAudioLocalStateRecording(1)。
rtcEngineConnectionDidInterrupted
- (void)rtcEngineConnectionDidInterrupted:(ARtcEngineKit *_Nonnull)engine;
网络连接中断回调
SDK 在和服务器建立连接后,失去了网络连接超过 4 秒,会触发该回调。在触发事件后,SDK 会主动重连服务器,所以该事件可以用于 UI 提示。
与 rtcEngineConnectionDidLost 回调的区别是:
rtcEngineConnectionDidInterrupted 回调一定是发生在加入频道成功后,且 SDK 刚失去和服务器连接超过 4 秒时触发。 rtcEngineConnectionDidLost 回调是无论之前加入频道是否连接成功,只要 10 秒内和服务器无法建立连接都会触发。 如果 SDK 在断开连接后,20 分钟内还是没能重新加入频道,SDK 会停止尝试重连。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
注意事项: 推荐使用connectionChangedToState回调。
rtcEngineConnectionDidBanned
- (void)rtcEngineConnectionDidBanned:(ARtcEngineKit *_Nonnull)engine;
连接已被禁止回调
当你被服务端禁掉连接的权限时,会触发该回调。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
注意事项: 推荐使用connectionChangedToState回调。
audioTransportStatsOfUid
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine audioTransportStatsOfUid:(NSString *_Nonnull)uid delay:(NSUInteger)delay lost:(NSUInteger)lost rxKBitRate:(NSUInteger)rxKBitRate;
通话中远端音频流传输的统计信息回调
该回调描述远端用户通话中端到端的网络统计信息,通过音频包计算,用客观的数据,如丢包、网络延迟等,展示当前网络状态。
通话中,当用户收到远端用户/主播发送的音频数据包后,会每 2 秒触发一次该回调。
和 remoteAudioStats 回调相比,该回调以数据展示当前网络状态,因此更客观。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
uid | 用户 ID,指定是哪个用户/主播的音频包 |
delay | 音频包从发送端到接收端的延时(毫秒) |
lost | 音频包从发送端到接收端的丢包率(%) |
rxKBitRate | 远端音频包的接收码率(Kbps) |
注意事项: 推荐使用remoteAudioStats 回调。
videoTransportStatsOfUid
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine videoTransportStatsOfUid:(NSString *_Nonnull)uid delay:(NSUInteger)delay lost:(NSUInteger)lost rxKBitRate:(NSUInteger)rxKBitRate;
通话中远端视频流传输的统计信息回调
该回调描述远端用户通话中端到端的网络统计信息,通过视频包计算,用客观的数据,如丢包、网络延迟等,展示当前网络状态。
通话中,当用户收到远端用户/主播发送的视频数据包后,会每 2 秒触发一次该回调。
和 remoteVideoStats 回调相比,该回调以数据展示当前网络状态,因此更客观。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
uid | 用户 ID,指定是哪个用户/主播的视频包 |
delay | 视频包从发送端到接收端的延时(毫秒) |
lost | 视频包从发送端到接收端 800 ms 内的丢包率(%) |
rxKBitRate | 远端视频包的接收码率(Kbps) |
注意事项: 推荐使用remoteVideoStats回调。
audioQualityOfUid
- (void)rtcEngine:(ARtcEngineKit * _Nonnull)engine audioQualityOfUid:(NSString *_Nonnull)uid quality:(ARNetworkQuality)quality delay:(NSUInteger)delay lost:(NSUInteger)lost;
远端音频质量回调
该回调描述远端用户在通话中的音频质量,针对每个远端用户/主播每 2 秒触发一次。如果远端同时存在多个用户/主播,该回调每 2 秒会被触发多次。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
uid | 用户 ID,指定是谁发的音频流。 |
quality | 语音质量,详见 ARNetworkQuality |
delay | 音频包从发送端到接收端的延迟(毫秒)。包括声音采样前处理、网络传输、网络抖动缓冲引起的延迟。 |
lost | 音频包从发送端到接收端的丢包率(%) |
注意事项: 推荐使用remoteVideoStats回调。
rtcEngineCameraDidReady
- (void)rtcEngineCameraDidReady:(ARtcEngineKit * _Nonnull)engine;
摄像头就绪回调
提示已成功打开摄像头,可以开始捕获视频。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
注意事项: 推荐使用localVideoStateChange回调 state 参数中的 ARLocalVideoStreamStateCapturing(1)。
rtcEngineVideoDidStop
- (void)rtcEngineVideoDidStop:(ARtcEngineKit * _Nonnull)engine;
视频功能停止回调
提示视频功能已停止。 App 如需在停止视频后对 view 做其他处理(比如显示其他画面),可以在这个回调中进行。
参数 | 描述 |
---|---|
engine | ARtcEngineKit对象 |
注意事项: 推荐使用localVideoStateChange回调 state 参数中的 ARLocalVideoStreamStateCapturing(0)。