Agora Recording C++ API Reference 文档

  • C++

更新时间不可用

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录制统计信息回调。
表格内容超出当前宽度,可横向滚动查看更多列。