Agora Recording C++ API Reference 文档

• IRecordingEngine接口类包含应用程序调用的主要方法。

• IRecordingEngineEventHandler接口类用于向应用程序发送回调通知。

IRecordingEgnine 接口类

该类包含应用程序调用的主要方法。

方法	描述
createAgoraRecordingEngine	创建IRecordingEngine实例。
joinChannel	录制端加入频道并开始录制。
joinChannelWithUserAccount	录制端使用 User Account 加入频道。
getUserInfoByUserAccount	通过 User Account 获取远端用户信息。
getUserInfoByUid	通过 UID 获取远端用户信息。
setVideoMixingLayout	设置视频合流布局。
updateWatermarkConfigs	添加、更新或删除水印设置。
stoppedOnError	手动停止onError回调。
updateSubscribeVideoUids	只录制指定 UID 的视频。
updateSubscribeAudioUids	只录制指定 UID 的音频。
leaveChannel	录制端退出频道。
release	销毁IRecordingEngine实例。
getProperties	获取录制属性。
startService	手动模式下开始录制。
stopService	手动模式下暂停录制。
setUserBackground	设置指定 UID 用户的背景图片。
setLogLevel	设置生成 log 的等级。

IRecordingEngineEventHandler 接口类

该类用于向应用程序发送回调通知。

回调	描述
onError	发生错误回调。
onWarning	发生警告回调。
onConnectionLost	网络连接丢失回调。
onConnectionInterrupted	网络连接中断回调。
onConnectionStateChanged	网络连接状态已改变回调。
onJoinChannelSuccess	录制端加入频道回调。
onLocalUserRegistered	本地用户成功注册 User Account 回调。
onUserInfoUpdated	用户信息已更新回调。
onRejoinChannelSuccess	重新加入频道回调。
onLeaveChannel	录制端离开频道回调。
onUserJoined	远端用户加入当前频道回调。
onUserOffline	远端用户离开当前频道回调。
audioFrameReceived	收到原始音频数据回调。
videoFrameReceived	收到视频数据回调。
onAudioVolumeIndication	提示频道内谁正在说话及说话者音量回调。
onActiveSpeaker	监测到活跃用户回调。
onFirstRemoteAudioFrame	已接收远端音频首帧回调。
onFirstRemoteVideoDecoded	已完成远端视频首帧解码回调。
onReceivingStreamStatusChanged	流状态变化回调。
onRemoteAudioStreamStateChanged	远端用户音频流状态改变回调。
onRemoteVideoStreamStateChanged	远端用户视频流状态改变回调。
onRemoteVideoStats	远端视频流统计信息回调。
onRemoteAudioStats	远端音频流统计信息回调。
onRecordingStats	录制统计信息回调。