# agora::recording::IRecordingEngineEventHandler类 参考 (/zh-CN/api-reference/local-server-recording/cpp/legacy/classagora-1-1recording-1-1-i-recording-engine-event-handler)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
:::info[Legacy API 适用范围]
本页为本地服务端录制 1.x–3.x SDK 的 Legacy API 参考,不适用于 4.x SDK。使用 4.x SDK,请参阅[当前 API 参考](/zh-CN/api-reference/local-server-recording/cpp/api-overview)。
:::
## 详细描述 [#详细描述]
该类用于为 [IRecordingEngine](/zh-CN/api-reference/local-server-recording/cpp/legacy/classagora-1-1recording-1-1-i-recording-engine) 提供回调。
## 构造及析构函数说明 [#构造及析构函数说明]
### ~IRecordingEngineEventHandler() [#irecordingengineeventhandler]
virtual agora::recording::IRecordingEngineEventHandler::~IRecordingEngineEventHandler()
## 成员函数说明 [#成员函数说明]
### onError() [#onerror]
virtual void agora::recording::IRecordingEngineEventHandler::onError(int *error*, [agora::linuxsdk::STAT_CODE_TYPE](/zh-CN/api-reference/local-server-recording/cpp/legacy/namespaceagora-1-1linuxsdk#a467894afed372a4fe76594a6223869a0) *stat_code*)
该回调表示 SDK 运行时出现了(网络或媒体相关的)错误。
通常情况下,SDK 上报的错误意味着 SDK 无法自动恢复,需要 App 干预或提示用户。
[错误代码](/zh-CN/api-reference/local-server-recording/cpp/legacy/namespaceagora-1-1linuxsdk#a5f37e3fa14fad2982f248d247d76996b)。
[状态代码](/zh-CN/api-reference/local-server-recording/cpp/legacy/namespaceagora-1-1linuxsdk#a467894afed372a4fe76594a6223869a0)。
### onWarning() [#onwarning]
virtual void agora::recording::IRecordingEngineEventHandler::onWarning(int *warn*)
该回调表示 SDK 运行时出现了(网络或媒体相关的)警告。
通常情况下,SDK 上报的警告信息应用程序可以忽略,SDK 会自动恢复。
[警告代码](/zh-CN/api-reference/local-server-recording/cpp/legacy/namespaceagora-1-1linuxsdk#a11cab69078db26c1f166c68e469dcfcf)。
### onJoinChannelSuccess() [#onjoinchannelsuccess]
virtual void agora::recording::IRecordingEngineEventHandler::onJoinChannelSuccess(const char * *channelId*, uid_t *uid*)
该回调表示录制端成功加入了指定的频道。
和调用 [joinChannel](/zh-CN/api-reference/local-server-recording/cpp/legacy/classagora-1-1recording-1-1-i-recording-engine#a011ff5c4a47816050be60b26ba0fb431) 时设置的频道名一致。
用户的 UID。
### onLeaveChannel() [#onleavechannel]
virtual void agora::recording::IRecordingEngineEventHandler::onLeaveChannel([agora::linuxsdk::LEAVE_PATH_CODE](/zh-CN/api-reference/local-server-recording/cpp/legacy/namespaceagora-1-1linuxsdk#a9bed76add2c986c154d0ab761a7a07ac) *code*)
该回调表示录制端成功离开了频道。
录制端离开频道的原因,详见 [LEAVE_PATH_CODE](/zh-CN/api-reference/local-server-recording/cpp/legacy/namespaceagora-1-1linuxsdk#a9bed76add2c986c154d0ab761a7a07ac)。
### onUserJoined() [#onuserjoined]
virtual void agora::recording::IRecordingEngineEventHandler::onUserJoined(uid_t *uid*, [agora::linuxsdk::UserJoinInfos](/zh-CN/api-reference/local-server-recording/cpp/legacy/structagora-1-1linuxsdk-1-1-user-join-infos) & *infos*)
该回调提示有远端用户加入当前频道,并返回新加入用户的 UID。
如果在录制端加入之前,已经有用户在频道中,SDK 也会上报这些已在频道中的用户 UID。频道内有多少用户,该回调就会调用几次。
用户的 UID。
用户加入频道信息。详见 [UserJoinInfos](/zh-CN/api-reference/local-server-recording/cpp/legacy/structagora-1-1linuxsdk-1-1-user-join-infos)。
### onRemoteVideoStreamStateChanged() [#onremotevideostreamstatechanged]
virtual void agora::recording::IRecordingEngineEventHandler::onRemoteVideoStreamStateChanged(uid_t *uid*, [linuxsdk::RemoteStreamState](/zh-CN/api-reference/local-server-recording/cpp/legacy/namespaceagora-1-1linuxsdk#a73d1bdcfa6ead0c7de998c9abf38d5e3) *state*, [linuxsdk::RemoteStreamStateChangedReason](/zh-CN/api-reference/local-server-recording/cpp/legacy/namespaceagora-1-1linuxsdk#ada78417cb7c1ebe12301c07677df2a44) *reason*)
远端用户视频流状态改变回调。
该回调在远端用户视频流状态发生变化时触发,并报告该用户当前的视频流状态和引起变化的原因。
远端用户的 UID。
该用户当前的视频流状态,详见 [RemoteStreamState](/zh-CN/api-reference/local-server-recording/cpp/legacy/namespaceagora-1-1linuxsdk#a73d1bdcfa6ead0c7de998c9abf38d5e3)。
引起远端视频流状态变化的原因,详见 [RemoteStreamStateChangedReason](/zh-CN/api-reference/local-server-recording/cpp/legacy/namespaceagora-1-1linuxsdk#ada78417cb7c1ebe12301c07677df2a44)。
### onRemoteAudioStreamStateChanged() [#onremoteaudiostreamstatechanged]
virtual void agora::recording::IRecordingEngineEventHandler::onRemoteAudioStreamStateChanged(uid_t *uid*, [linuxsdk::RemoteStreamState](/zh-CN/api-reference/local-server-recording/cpp/legacy/namespaceagora-1-1linuxsdk#a73d1bdcfa6ead0c7de998c9abf38d5e3) *state*, [linuxsdk::RemoteStreamStateChangedReason](/zh-CN/api-reference/local-server-recording/cpp/legacy/namespaceagora-1-1linuxsdk#ada78417cb7c1ebe12301c07677df2a44) *reason*)
远端用户音频流状态改变回调。
该回调在远端用户音频流状态发生变化时触发,并报告该用户当前的音频流状态和引起变化的原因。
远端用户的 UID。
该用户当前的音频流状态,详见 [RemoteStreamState](/zh-CN/api-reference/local-server-recording/cpp/legacy/namespaceagora-1-1linuxsdk#a73d1bdcfa6ead0c7de998c9abf38d5e3)。
引起远端音频流状态变化的原因,详见 [RemoteStreamStateChangedReason](/zh-CN/api-reference/local-server-recording/cpp/legacy/namespaceagora-1-1linuxsdk#ada78417cb7c1ebe12301c07677df2a44)。
### onUserOffline() [#onuseroffline]
virtual void agora::recording::IRecordingEngineEventHandler::onUserOffline(uid_t *uid*, [agora::linuxsdk::USER_OFFLINE_REASON_TYPE](/zh-CN/api-reference/local-server-recording/cpp/legacy/namespaceagora-1-1linuxsdk#a0e6e9d00d96e6ae8da87bffa12a675f4) *reason*)
该回调提示有其他用户离开当前频道或掉线。
SDK 判断用户离开频道或掉线的依据是:在一定时间内(15 秒)没有收到对方的任何数据包。在网络较差的情况下,可能会有误报。建议可靠的掉线检测应该由信令来做。
用户的 UID。
用户离开当前频道或掉线的原因,详见 [USER_OFFLINE_REASON_TYPE](/zh-CN/api-reference/local-server-recording/cpp/legacy/namespaceagora-1-1linuxsdk#a0e6e9d00d96e6ae8da87bffa12a675f4)。
### audioFrameReceived() [#audioframereceived]
virtual void agora::recording::IRecordingEngineEventHandler::audioFrameReceived(unsigned int *uid*, const [agora::linuxsdk::AudioFrame](/zh-CN/api-reference/local-server-recording/cpp/legacy/structagora-1-1linuxsdk-1-1-audio-frame) * *frame*) const
当收到原始音频数据时,会触发该回调。
当你将 [RecordingConfig](/zh-CN/api-reference/local-server-recording/cpp/legacy/structagora-1-1recording-1-1-recording-config) 中的 [decodeAudio](/zh-CN/api-reference/local-server-recording/cpp/legacy/structagora-1-1recording-1-1-recording-config#ae33efa98ee00667f2e568612ecfd2a69) 设置为 `1`、`2` 或 `3` 时,可通过该回调接收原始音频数据。
用户的 UID。
收到的原始音频数据,格式为 PCM 或 AAC。详见 [AudioFrame](/zh-CN/api-reference/local-server-recording/cpp/legacy/structagora-1-1linuxsdk-1-1-audio-frame)。
### videoFrameReceived() [#videoframereceived]
virtual void agora::recording::IRecordingEngineEventHandler::videoFrameReceived(unsigned int *uid*, const [agora::linuxsdk::VideoFrame](/zh-CN/api-reference/local-server-recording/cpp/legacy/structagora-1-1linuxsdk-1-1-video-frame) * *frame*) const
当收到视频数据时,会触发该回调。
当你将 [RecordingConfig](/zh-CN/api-reference/local-server-recording/cpp/legacy/structagora-1-1recording-1-1-recording-config) 中的 [decodeVideo](/zh-CN/api-reference/local-server-recording/cpp/legacy/structagora-1-1recording-1-1-recording-config#a723e05b00dc63e2f2fc85e3e7489e051) 设置为 `1`、`2` 或 `3` 时,可通过该回调接收原始视频数据。
当你将 [RecordingConfig](/zh-CN/api-reference/local-server-recording/cpp/legacy/structagora-1-1recording-1-1-recording-config) 中的 [decodeVideo](/zh-CN/api-reference/local-server-recording/cpp/legacy/structagora-1-1recording-1-1-recording-config#a723e05b00dc63e2f2fc85e3e7489e051) 设置为 `4` 或 `5` 时,可通过该回调接收 JPG 文件格式的视频数据。
该回调可用于实现高级功能,如鉴黄。这些功能可以通过采集并分析 I 帧实现。
用户的 UID。
收到的视频帧,格式为 YUV、H.264、H.265、JPG 或 JPG 文件。详见 [VideoFrame](/zh-CN/api-reference/local-server-recording/cpp/legacy/structagora-1-1linuxsdk-1-1-video-frame)。
### onActiveSpeaker() [#onactivespeaker]
virtual void agora::recording::IRecordingEngineEventHandler::onActiveSpeaker(uid_t *uid*)
监测到活跃用户回调。
[`RecordingConfig`](/zh-CN/api-reference/local-server-recording/cpp/legacy/structagora-1-1recording-1-1-recording-config) 中的 [audioIndicationInterval](/zh-CN/api-reference/local-server-recording/cpp/legacy/structagora-1-1recording-1-1-recording-config#a611f4c05d64eafcc5e304b10d58b3477) 大于 0 时(建议设置时间间隔大于 200 ms),如果 SDK 监测到频道内有新的活跃用户说话时,会触发该回调,返回活跃用户的 UID。
当前时间段声音最大的用户的 UID。
### onAudioVolumeIndication() [#onaudiovolumeindication]
virtual void agora::recording::IRecordingEngineEventHandler::onAudioVolumeIndication(const [agora::linuxsdk::AudioVolumeInfo](/zh-CN/api-reference/local-server-recording/cpp/legacy/structagora-1-1linuxsdk-1-1-audio-volume-info) * *speakers*, unsigned int *speakerNum*)
该回调提示频道内谁正在说话以及说话者音量。
`RecordingConfi` 中的 [audioIndicationInterval](/zh-CN/api-reference/local-server-recording/cpp/legacy/structagora-1-1recording-1-1-recording-config#a611f4c05d64eafcc5e304b10d58b3477) 大于 0 时(建议设置时间间隔大于 200 ms),该回调会返回在时间间隔内所有说话者的 UID 和音量。
每个说话者的 UID 和音量信息的数组,详见 [AudioVolumeInfo](/zh-CN/api-reference/local-server-recording/cpp/legacy/structagora-1-1linuxsdk-1-1-audio-volume-info)。
频道内说话者人数。
### onFirstRemoteVideoDecoded() [#onfirstremotevideodecoded]
virtual void agora::recording::IRecordingEngineEventHandler::onFirstRemoteVideoDecoded(uid_t *uid*, int *width*, int *height*, int *elapsed*)
该回调提示本地已接收到首帧远端视频并完成解码。
本地收到首帧远端视频流并解码成功时,触发此回调。
用户的 UID,指定是哪个用户的视频流。
视频流宽(像素)。
视频流高(像素)。
从本地用户调用 [joinChannel](/zh-CN/api-reference/local-server-recording/cpp/legacy/classagora-1-1recording-1-1-i-recording-engine#a011ff5c4a47816050be60b26ba0fb431) 到该回调触发的延迟(毫秒)。
### onFirstRemoteAudioFrame() [#onfirstremoteaudioframe]
virtual void agora::recording::IRecordingEngineEventHandler::onFirstRemoteAudioFrame(uid_t *uid*, int *elapsed*)
该回调提示本地已接收到首帧远端音频流。
发送音频帧的远端用户的 UID。
从本地用户调用 [joinChannel](/zh-CN/api-reference/local-server-recording/cpp/legacy/classagora-1-1recording-1-1-i-recording-engine#a011ff5c4a47816050be60b26ba0fb431) 到该回调触发的延迟(毫秒)。
### onReceivingStreamStatusChanged() [#onreceivingstreamstatuschanged]
virtual void agora::recording::IRecordingEngineEventHandler::onReceivingStreamStatusChanged(bool *receivingAudio*, bool *receivingVideo*)
该回调提示接收音频流或视频流的状态发生改变。
录制端是否在接收音频流。
录制端是否在接收视频流。
### onConnectionLost() [#onconnectionlost]
virtual void agora::recording::IRecordingEngineEventHandler::onConnectionLost()
网络连接丢失回调。
SDK 在调用 [joinChannel](/zh-CN/api-reference/local-server-recording/cpp/legacy/classagora-1-1recording-1-1-i-recording-engine#a011ff5c4a47816050be60b26ba0fb431) 后无论是否加入成功,只要 10 秒和服务器无法连接就会触发该回调。
[onConnectionLost](/zh-CN/api-reference/local-server-recording/cpp/legacy/classagora-1-1recording-1-1-i-recording-engine-event-handler#a0cf0383f0b6f841682a3ec3a588a9b18) 与 [onConnectionInterrupted](/zh-CN/api-reference/local-server-recording/cpp/legacy/classagora-1-1recording-1-1-i-recording-engine-event-handler#ac6a57d0f9721253294f7d1204084e00c) 的区别是:
- [onConnectionInterrupted](/zh-CN/api-reference/local-server-recording/cpp/legacy/classagora-1-1recording-1-1-i-recording-engine-event-handler#ac6a57d0f9721253294f7d1204084e00c) 回调一定是在加入频道成功后,且 SDK 失去和服务器的连接超过 4 秒时触发。
- [onConnectionLost](/zh-CN/api-reference/local-server-recording/cpp/legacy/classagora-1-1recording-1-1-i-recording-engine-event-handler#a0cf0383f0b6f841682a3ec3a588a9b18) 回调是无论之前加入频道是否成功,只要 10 秒内和服务器无法建立连接都会触发。
无论是哪种回调,除非应用程序主动调用 [leaveChannel](/zh-CN/api-reference/local-server-recording/cpp/legacy/classagora-1-1recording-1-1-i-recording-engine#adafb45815ad0f02dc1c8b3cadb7cd2e3),不然 SDK 会一直自动重连。
### onConnectionInterrupted() [#onconnectioninterrupted]
virtual void agora::recording::IRecordingEngineEventHandler::onConnectionInterrupted()
网络连接中断回调。
SDK 在和服务器建立连接后,失去网络连接超过 4 秒,就会触发该回调。在触发事件后,SDK 会主动重连服务器,所以该事件可以用于 UI 提示。
[onConnectionLost](/zh-CN/api-reference/local-server-recording/cpp/legacy/classagora-1-1recording-1-1-i-recording-engine-event-handler#a0cf0383f0b6f841682a3ec3a588a9b18) 与 [onConnectionInterrupted](/zh-CN/api-reference/local-server-recording/cpp/legacy/classagora-1-1recording-1-1-i-recording-engine-event-handler#ac6a57d0f9721253294f7d1204084e00c) 的区别是:
- [onConnectionInterrupted](/zh-CN/api-reference/local-server-recording/cpp/legacy/classagora-1-1recording-1-1-i-recording-engine-event-handler#ac6a57d0f9721253294f7d1204084e00c) 回调一定是在加入频道成功后,且 SDK 失去和服务器的连接超过 4 秒时触发。
- [onConnectionLost](/zh-CN/api-reference/local-server-recording/cpp/legacy/classagora-1-1recording-1-1-i-recording-engine-event-handler#a0cf0383f0b6f841682a3ec3a588a9b18) 回调是无论之前加入频道是否成功,只要 10 秒内和服务器无法建立连接都会触发。
无论是哪种回调,除非应用程序主动调用 [leaveChannel](/zh-CN/api-reference/local-server-recording/cpp/legacy/classagora-1-1recording-1-1-i-recording-engine#adafb45815ad0f02dc1c8b3cadb7cd2e3),不然 SDK 会一直自动重连。
### onRejoinChannelSuccess() [#onrejoinchannelsuccess]
virtual void agora::recording::IRecordingEngineEventHandler::onRejoinChannelSuccess(const char * *channelId*, uid_t *uid*)
重新加入频道回调。
有时由于网络原因,录制客户端可能会和服务器失去连接,SDK 会进行自动重连,自动重连成功后触发此回调方法。
频道名。
录制端的 UID。
### onConnectionStateChanged() [#onconnectionstatechanged]
virtual void agora::recording::IRecordingEngineEventHandler::onConnectionStateChanged([agora::linuxsdk::ConnectionStateType](/zh-CN/api-reference/local-server-recording/cpp/legacy/namespaceagora-1-1linuxsdk#a7bb6c960800fca3b10effe482080f018) *state*, [agora::linuxsdk::ConnectionChangedReasonType](/zh-CN/api-reference/local-server-recording/cpp/legacy/namespaceagora-1-1linuxsdk#a7b099b2f12ca92293f38b7b18c4239c9) *reason*)
网络连接状态已改变回调。
该回调在网络连接状态发生改变的时候触发,并告知用户当前的网络连接状态和网络状态改变的原因。
当前的网络连接状态,详见 [ConnectionStateType](/zh-CN/api-reference/local-server-recording/cpp/legacy/namespaceagora-1-1linuxsdk#a7bb6c960800fca3b10effe482080f018)。
网络连接状态发生改变的原因,详见 [ConnectionChangedReasonType](/zh-CN/api-reference/local-server-recording/cpp/legacy/namespaceagora-1-1linuxsdk#a7b099b2f12ca92293f38b7b18c4239c9)。
### onRemoteVideoStats() [#onremotevideostats]
virtual void agora::recording::IRecordingEngineEventHandler::onRemoteVideoStats([agora::linuxsdk::uid_t](/zh-CN/api-reference/local-server-recording/cpp/legacy/namespaceagora-1-1linuxsdk#a8ec0e86208531827f0014a30bb4ae395) *uid*, const [agora::linuxsdk::RemoteVideoStats](/zh-CN/api-reference/local-server-recording/cpp/legacy/structagora-1-1linuxsdk-1-1-remote-video-stats) & *stats*)
远端视频流统计信息回调。
该回调报告远端用户端到端的视频流统计信息,针对每个发送视频流的远端用户(通信模式)/主播(直播模式)每 2 秒触发一次。如果远端有多个用户/主播发送视频流,该回调每 2 秒会被触发多次。
用户 ID,指定是哪个用户的视频流。
远端视频统计数据。详见 [RemoteVideoStats](/zh-CN/api-reference/local-server-recording/cpp/legacy/structagora-1-1linuxsdk-1-1-remote-video-stats)。
### onRemoteAudioStats() [#onremoteaudiostats]
virtual void agora::recording::IRecordingEngineEventHandler::onRemoteAudioStats([agora::linuxsdk::uid_t](/zh-CN/api-reference/local-server-recording/cpp/legacy/namespaceagora-1-1linuxsdk#a8ec0e86208531827f0014a30bb4ae395) *uid*, const [agora::linuxsdk::RemoteAudioStats](/zh-CN/api-reference/local-server-recording/cpp/legacy/structagora-1-1linuxsdk-1-1-remote-audio-stats) & *stats*)
远端音频流统计信息回调。
该回调描述远端用户端到端的音频流统计信息,针对每个发送音频流的远端用户(通信模式)/主播(直播模式)每 2 秒触发一次。如果远端有多个用户/主播发送音频流,该回调每 2 秒会被触发多次。
用户 ID,指定是哪个用户的音频流。
远端音频统计数据。详见 [RemoteAudioStats](/zh-CN/api-reference/local-server-recording/cpp/legacy/structagora-1-1linuxsdk-1-1-remote-audio-stats)。
### onRecordingStats() [#onrecordingstats]
virtual void agora::recording::IRecordingEngineEventHandler::onRecordingStats(const [agora::linuxsdk::RecordingStats](/zh-CN/api-reference/local-server-recording/cpp/legacy/structagora-1-1linuxsdk-1-1-recording-stats) & *stats*)
录制统计信息回调。
录制 SDK 定期向录制端报告当前录制的统计信息,每两秒触发一次。
详见 [RecordingStats](/zh-CN/api-reference/local-server-recording/cpp/legacy/structagora-1-1linuxsdk-1-1-recording-stats)。
### onLocalUserRegistered() [#onlocaluserregistered]
virtual void agora::recording::IRecordingEngineEventHandler::onLocalUserRegistered(uid_t *uid*, const char * *userAccount*)
该回调表示本地用户已成功注册 User Account。
录制端调用 [joinChannelWithUserAccount](/zh-CN/api-reference/local-server-recording/cpp/legacy/classagora-1-1recording-1-1-i-recording-engine#a1567ba5fbd049cbbbcdf99613cfbc661) 方法成功注册 User Account 后,SDK 会触发该回调,并报告录制端的 UID 和 User Account。
录制端的 UID。
录制端的 User Account。
### onUserInfoUpdated() [#onuserinfoupdated]
virtual void agora::recording::IRecordingEngineEventHandler::onUserInfoUpdated(uid_t *uid*, const [agora::linuxsdk::UserInfo](/zh-CN/api-reference/local-server-recording/cpp/legacy/structagora-1-1linuxsdk-1-1-user-info) & *info*)
该回调提示远端用户的信息已更新。
远端用户加入频道后,SDK 会获取到该远端用户的 UID 和 User Account,然后缓存一个包含了远端用户 UID 和 User Account 的 Mapping 表,并在本地触发 `onUserInfoUpdated`。
远端用户的 UID。
标识用户信息的 [UserInfo](/zh-CN/api-reference/local-server-recording/cpp/legacy/structagora-1-1linuxsdk-1-1-user-info) 对象,包含用户 UID 和 User Account。