io.agora.recording.RecordingEventHandler接口 参考

成员函数说明Copy Anchor Link

onLeaveChannel()Copy Anchor Link

void io.agora.recording.RecordingEventHandler.onLeaveChannel(int reason)

该回调方法提示离开频道成功。

onError()Copy Anchor Link

void io.agora.recording.RecordingEventHandler.onError(int error, int stat_code)

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

onWarning()Copy Anchor Link

void io.agora.recording.RecordingEventHandler.onWarning(int warn)

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

onJoinChannelSuccess()Copy Anchor Link

void io.agora.recording.RecordingEventHandler.onJoinChannelSuccess(String channelId, long uid)

该回调方法表示录制端成功加入了指定频道。

onRemoteVideoStreamStateChanged()Copy Anchor Link

void io.agora.recording.RecordingEventHandler.onRemoteVideoStreamStateChanged(long uid, REMOTE_STREAM_STATE state, REMOTE_STREAM_STATE_CHANGED_REASON reason)

远端用户视频流状态改变回调。

该回调在远端用户视频流状态发生变化时触发，并报告该用户当前的视频流状态和引起变化的原因。

onRemoteAudioStreamStateChanged()Copy Anchor Link

void io.agora.recording.RecordingEventHandler.onRemoteAudioStreamStateChanged(long uid, REMOTE_STREAM_STATE state, REMOTE_STREAM_STATE_CHANGED_REASON reason)

远端用户音频流状态改变回调。

该回调在远端用户音频流状态发生变化时触发，并报告该用户当前的音频流状态和引起变化的原因。

onUserOffline()Copy Anchor Link

void io.agora.recording.RecordingEventHandler.onUserOffline(long uid, int reason)

该回调方法提示有用户离开了频道（或掉线）。

SDK 判断用户离开频道（或掉线）的依据是：在一定时间内（15 秒）没有收到对方的任何数据包。 在网络较差的情况下，可能会有误报。建议可靠的掉线检测应该由信令来做。

onUserJoined()Copy Anchor Link

void io.agora.recording.RecordingEventHandler.onUserJoined(long uid, String recordingDir)

该回调方法提示有用户加入了频道，并返回新加入用户的 UID。

如果在录制端加入之前，已经有用户在频道中，SDK 也会上报这些已在频道中的用户 UID。频道内有多少用户，该回调就会调用几次。

onActiveSpeaker()Copy Anchor Link

void io.agora.recording.RecordingEventHandler.onActiveSpeaker(long uid)

监测到活跃用户回调。

RecordingConfig 中的 audioIndicationInterval 大于 0 时（建议设置时间间隔大于 200 ms），如果 SDK 监测到频道内有新的活跃用户说话时，会触发该回调，返回当前时间段声音最大的用户的 UID。

audioFrameReceived()Copy Anchor Link

void io.agora.recording.RecordingEventHandler.audioFrameReceived(long uid, AudioFrame frame)

当收到原始音频数据时，会触发该回调。

当你将 RecordingConfig 中的 decodeAudio 设置为 1、2 或 3 时，可通过该回调接收原始音频数据。

videoFrameReceived()Copy Anchor Link

void io.agora.recording.RecordingEventHandler.videoFrameReceived(long uid, int type, VideoFrame frame, int rotation)

当收到视频数据时，会触发该回调。

当你将 RecordingConfig 中的 decodeVideo 设置为 1、2 或 3 时，可通过该回调接收原始视频数据。

当你将 RecordingConfig 中的 decodeVideo 设置为 4 或 5 时，可通过该回调接收 JPG 文件格式的视频数据。

该回调可用于实现高级功能，如鉴黄。这些功能可以通过采集并分析 I 帧实现。

recordingPathCallBack()Copy Anchor Link

void io.agora.recording.RecordingEventHandler.recordingPathCallBack(String path)

该回调方法获取录制文件的存放路径。

onAudioVolumeIndication()Copy Anchor Link

void io.agora.recording.RecordingEventHandler.onAudioVolumeIndication(AudioVolumeInfo[] infos)

该回调提示频道内谁正在说话以及说话者音量。

RecordingConfig 中的 audioIndicationInterval 大于 0 时（建议设置时间间隔大于 200 ms），该回调会返回在时间间隔内所有说话者的 UID 和音量。

onFirstRemoteVideoDecoded()Copy Anchor Link

void io.agora.recording.RecordingEventHandler.onFirstRemoteVideoDecoded(long uid, int width, int height, int elapsed)

该回调提示本地已接收到首帧远端视频并完成解码。

本地收到首帧远端视频流并解码成功时，触发此调用。

onFirstRemoteAudioFrame()Copy Anchor Link

void io.agora.recording.RecordingEventHandler.onFirstRemoteAudioFrame(long uid, int elapsed)

该回调提示本地已接收到首帧远端音频流。

onReceivingStreamStatusChanged()Copy Anchor Link

void io.agora.recording.RecordingEventHandler.onReceivingStreamStatusChanged(boolean receivingAudio, boolean receivingVideo)

该回调提示接收音频流或视频流的状态发生改变。

onConnectionLost()Copy Anchor Link

void io.agora.recording.RecordingEventHandler.onConnectionLost()

网络连接丢失回调。

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

onConnectionInterrupted 与 onConnectionLost 的区别是：

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

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

onConnectionInterrupted()Copy Anchor Link

void io.agora.recording.RecordingEventHandler.onConnectionInterrupted()

网络连接中断回调。

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

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

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

onRejoinChannelSuccess()Copy Anchor Link

void io.agora.recording.RecordingEventHandler.onRejoinChannelSuccess(String channelId, long uid)

重新加入频道回调。

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

onConnectionStateChanged()Copy Anchor Link

void io.agora.recording.RecordingEventHandler.onConnectionStateChanged(CONNECTION_STATE_TYPE state, CONNECTION_CHANGED_REASON_TYPE reason)

网络连接状态已改变回调。

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

onRemoteVideoStats()Copy Anchor Link

void io.agora.recording.RecordingEventHandler.onRemoteVideoStats(long uid, RemoteVideoStats stats)

远端视频流统计信息回调。

该回调报告远端用户端到端的视频流统计信息，针对每个发送视频流的远端用户（通信模式）/主播（直播模式）每 2 秒触发一次。如果远端有多个用户/主播发送视频流，该回调每 2 秒会被触发多次。

onRemoteAudioStats()Copy Anchor Link

void io.agora.recording.RecordingEventHandler.onRemoteAudioStats(long uid, RemoteAudioStats stats)

远端音频流统计信息回调。

该回调描述远端用户端到端的音频流统计信息，针对每个发送音频流的远端用户（通信模式）/主播（直播模式）每 2 秒触发一次。如果远端有多个用户/主播发送音频流，该回调每 2 秒会被触发多次。

onRecordingStats()Copy Anchor Link

void io.agora.recording.RecordingEventHandler.onRecordingStats(RecordingStats stats)

录制统计信息回调。

录制 SDK 定期向录制端报告当前录制的统计信息，每两秒触发一次。

onLocalUserRegistered()Copy Anchor Link

void io.agora.recording.RecordingEventHandler.onLocalUserRegistered(long uid, String userAccount)

该回调表示本地用户已成功注册 User Account。

录制端调用 createChannelWithUserAccount 方法成功注册 User Account 后，SDK 会触发该回调，并报告录制端的 UID 和 User Account。

onUserInfoUpdated()Copy Anchor Link

void io.agora.recording.RecordingEventHandler.onUserInfoUpdated(long uid, String userAccount)

该回调提示远端用户的信息已更新。

远端用户加入频道后， SDK 会获取到该远端用户的 UID 和 User Account，在本地触发 onUserInfoUpdated。