详情

该回调方法表示 SDK 运行时出现了（网络或媒体相关的）警告。通常情况下，SDK 上报的警告信息 App 可以忽略，SDK 会自动恢复。比如和服务器失去连接时，SDK 可能会上报 AgoraWarningCodeOpenChannelTimeout(106) 警告，同时自动尝试重连。

详细的警告代码，见 AgoraWarningCode。

详情

该回调方法表示 SDK 运行时出现了（网络或媒体相关的）错误。通常情况下，SDK 上报的错误意味着 SDK 无法自动恢复，需要 App 干预或提示用户。 比如启动通话失败时，SDK 会上报 AgoraErrorCodeStartCall = 1002 错误。App 可以提示用户启动通话失败，并调用 leaveChannel 退出频道。

详细的错误代码，见 AgoraErrorCode。

详情

该回调方法表示该客户端成功加入了指定的频道。同joinChannelByToken API 的 joinSuccessBlock 回调。

详情

有时候由于网络原因，客户端可能会和服务器失去连接，SDK 会进行自动重连，自动重连成功后触发此回调方法。

详情

当用户调用 leaveChannel 离开频道后，SDK 会触发该回调。在该回调方法中，App 可以得到此次通话的总通话时长、SDK 收发数据的流量等信息。

详情

直播场景下，当用户角色切换时会触发此回调，即主播切换为观众时，或观众切换为主播时。

详情

同 userJoinedBlock。

• 通信模式下，该回调提示有远端用户加入了频道，并返回新加入用户的 ID；如果加入之前，已经有其他用户在频道中了，新加入的用户也会收到这些已有用户加入频道的回调。
• 直播模式下，该回调提示有主播加入了频道，并返回该主播的 ID。如果在加入之前，已经有主播在频道中了，新加入的用户也会收到已有主播加入频道的回调。Agora 建议连麦主播不超过 17 人。

Note:

直播场景下，

• 主播间能相互收到新主播加入频道的回调，并能获得该主播的 uid
• 观众也能收到新主播加入频道的回调，并能获得该主播的 uid
• 当 Web 端加入直播频道时，只要 Web 端有推流，SDK 会默认该 Web 端为主播，并触发该回调

详情

同 userOfflineBlock。

提示有远端用户/主播离开了频道（或掉线）。用户离开频道有两个原因，即正常离开和超时掉线：

• 正常离开的时候，远端用户/主播会收到类似“再见”的消息，接收此消息后，判断用户离开频道。
• 超时掉线的依据是，在一定时间内（通信场景为 20 秒，直播场景稍有延时），用户没有收到对方的任何数据包，则判定为对方掉线。在网络较差的情况下，有可能会误报。Agora 建议使用信令系统来做可靠的掉线检测。

详情

该回调在网络连接状态发生改变的时候触发，并告知用户当前的网络连接状态，和引起网络状态改变的原因。

详情

SDK 在调用 joinChannelByToken 后无论是否加入成功，只要 10 秒和服务器无法连接就会触发该回调。

与 rtcEngineConnectionDidInterrupted 回调的区别是:

• rtcEngineConnectionDidInterrupted 回调一定是发生在加入频道成功后，且 SDK 刚失去和服务器连接超过 4 秒时触发。
• rtcEngineConnectionDidLost 回调是无论之前加入频道是否连接成功，只要 10 秒内和服务器无法建立连接都会触发。

无论是哪种回调，除非 App 主动调用 leaveChannel，不然 SDK 会一直自动重连。

详情

在调用 joinChannelByToken 时如果指定了 Token，由于 Token 具有一定的时效，在通话过程中如果 Token 即将失效，SDK 会提前 30 秒触发该回调，提醒应用程序更新 Token。 当收到该回调时，用户需要重新在服务端生成新的 Token，然后调用 renewToken 将新生成的 Token 传给 SDK。

详情

在调用 joinChannelByToken 时如果指定了 Token，由于 Token 具有一定的时效，在通话过程中 SDK 可能由于网络原因和服务器失去连接，重连时可能需要新的 Token。 该回调通知 App 需要生成新的 Token，并需调用 renewToken 为 SDK 指定新的 Token。 之前的处理方法是在 didOccurError 回调报告 AgoraErrorCodeTokenExpired = 109, AgoraErrorCodeInvalidToken = 110. 时，App 需要生成新的 Token。 在新版本中，原来的处理仍然有效，但建议把相关逻辑放进该回调里。

详情

与 audioVolumeIndicationBlock 相同。

该回调提示频道内谁在说话以及说话者的音量。默认禁用。可通过 enableAudioVolumeIndication 方法开启；开启后，无论频道内是否有人说话，都会按方法中设置的时间间隔返回提示音量。

在返回的 speakers 数组中：

• 如果返回的 uid 为 0，即当频道内的说话者为本地用户时，说话者的音量 volume 为 totalVolume，即频道内的总音量。
• 如果返回的 uid 不是 0，且 volume 为 0，则默认该 uid 对应的远端用户没有说话。
• 如果有 uid 出现在上次返回的数组中，但不在本次返回的数组中，则默认该 uid 对应的远端用户没有说话。

详情

如果用户开启了 enableAudioVolumeIndication 功能，则当音量检测模块监测到频道内有新的活跃用户说话时，会通过本回调返回该用户的 uid。

Note:

• 你需要开启 enableAudioVolumeIndication 方法才能收到该回调。
• uid 返回的是当前时间段内声音最大的用户 uid，而不是瞬时声音最大的用户 uid。

详情

提示视频功能已停止。 App 如需在停止视频后对 view 做其他处理（比如显示其他画面），可以在这个回调中进行。

详情

第一帧本地视频发送时，触发此回调。

详情

同 firstRemoteVideoDecodedBlock。提示已收到第一帧远端视频流并解码。

详情

同 firstRemoteVideoFrameBlock。提示第一帧远端视频显示在视图上。 App 可在此调用中获知出图时间（elapsed）。

详情

同 userMuteVideoBlock。

Note:

现阶段，当频道内用户数超过 20 人，该回调会失效。

详情

提示有其他用户启用/关闭了视频功能。关闭视频功能是指该用户只能进行语音直播，不能显示、发送自己的视频，也不能接收、显示别人的视频。

详情

提示有其他用户启用/关闭了本地视频功能。

详情

该回调方法表示远端的视频流状态发生了改变。

Note:

该回调在两个视频帧间隔大于等于 600 ms 时才会触发。

详情

Note:

如果本地推流已回退为音频流，远端的 App 上会收到 didVideoMuted 的回调事件。

如果你调用了设置本地推流回退选项 setLocalPublishFallbackOption 接口并将选项设置为 AgoraStreamFallbackOptionAudioOnly，当上行网络环境不理想、本地发布的媒体流回退为音频流时，或当上行网络改善、媒体流恢复为音视频流时，会触发该回调。

详情

如果你调用了 setRemoteSubscribeFallbackOption, 接口并将回退选项设置为 AgoraStreamFallbackOptionAudioOnly，当下行网络环境不理想、仅接收远端音频流时，或当下行网络改善、恢复订阅音视频流时，会触发该回调。

Note:

远端订阅流因弱网环境不能同时满足音视频而回退为小流时，你可以使用 remoteVideoStats 方法来监控远端视频大小流的切换。

详情

详情

当语音路由发生变化时，SDK 会触发此回调。

详情

同 cameraReadyBlock。提示已成功打开摄像头，可以开始捕获视频。

详情

该回调仅适用于 iOS 平台。

该回调表示摄像头的对焦区域发生了改变。

详情

该回调仅适用于 iOS 平台。

详情

该回调描述远端用户在通话中端到端的音频流统计信息，针对每个远端用户/主播每 2 秒触发一次。

如果远端同时存在多个用户/主播，该回调每 2 秒会被触发多次。

和 audioTransportStatsOfUid 回调相比，该回调更贴近用户的主观感受。

比如，当网络发生丢包时，因 FEC（Forward Error Correction，向前纠错码）或重传恢复，最终的音频丢帧率不高，则可以认为整个质量较好。

详情

同 rtcStatsBlock。该回调定期上报 Rtc Engine 的运行时的状态，每 2 秒触发一次。

详情

该回调描述本地用户在加入频道前的 last mile 网络探测的结果，其中 last mile 是指设备到 Agora 边缘服务器的网络状态。

在调用 enableLastmileTest 之后，该回调每 2 秒触发一次。

详情

该回调描述每个用户/主播在通话中的 last mile 网络状态，其中 last mile 是指设备到 Agora 边缘服务器的网络状态。

该回调每 2 秒触发一次。如果远端有多个用户/主播，该回调每 2 秒会被触发多次。

详情

同 localVideoStatBlock。报告更新本地视频统计信息，该回调方法每两秒触发一次。

详情

该回调描述远端用户在通话中端到端的视频流统计信息，针对每个远端用户/主播每 2 秒触发一次。

如果远端同时存在多个用户/主播，该回调每 2 秒会被触发多次。

和 videoTransportStatsOfUid 相比，该回调更贴近用户的主观感受。比如，当网络发生丢包时，因 FEC（Forward Error Correction，向前纠错码）或重传恢复，最终的视频丢帧率不高，则可以认为整个质量较好。

详情

该回调描述远端用户通话中端到端的网络统计信息，通过音频包计算，用客观的数据，如丢包、网络延迟等，展示当前网络状态。

通话中，当用户收到远端用户/主播发送的音频数据包后，会每 2 秒触发一次该回调。

和 remoteAudioStats 回调相比，该回调以数据展示当前网络状态，因此更客观。

详情

该回调描述远端用户通话中端到端的网络统计信息，通过视频包计算，用客观的数据，如丢包、网络延迟等，展示当前网络状态。

通话中，当用户收到远端用户/主播发送的视频数据包后，会每 2 秒触发一次该回调。

和 remoteVideoStats 回调相比，该回调以数据展示当前网络状态，因此更客观。

详情

当调用 startAudioMixing 播放音乐文件音乐结束后，会触发该回调。如果调用 startAudioMixing 失败，会在 didOccurWarning 回调里，返回警告代码 AgoraWarningCodeAudioMixingOpenError。

详情

当远端有用户调用 startAudioMixing 播放音乐文件音乐，会触发该回调。

详情

当调用 playEffect 播放音效结束后，会触发该回调。

详情

提示本地用户已在5秒内收到对方发送的数据包。

详情

提示本地用户没有在 5 秒内收到对方发送的数据包。

详情

DEPRECATED 从 v2.3.2 起废弃

SDK 在和服务器建立连接后，失去了网络连接超过 4 秒，会触发该回调。在触发事件后，SDK 会主动重连服务器，所以该事件可以用于 UI 提示。

与 rtcEngineConnectionDidLost 回调的区别是:

• rtcEngineConnectionDidInterrupted 回调一定是发生在加入频道成功后，且 SDK 刚失去和服务器连接超过 4 秒时触发。
• rtcEngineConnectionDidLost 回调是无论之前加入频道是否连接成功，只要 10 秒内和服务器无法建立连接都会触发。

无论是哪种回调，除非 App 主动调用 leaveChannel，不然 SDK 会一直自动重连。

详情

DEPRECATED 从 v2.3.2 起废弃

当你被服务端禁掉连接的权限时，会触发该回调。

详情

DEPRECATED 从 v2.3.2 起废弃

同 audioQualityBlock。

该回调描述远端用户在通话中的音频质量，针对每个远端用户/主播每 2 秒触发一次。如果远端同时存在多个用户/主播，该回调每 2 秒会被触发多次。