API 概览

IAgoraService

API	描述
createAgoraService	创建一个 IAgoraService 对象并返回指针。
initialize	初始化 IAgoraService 对象。
release	释放 IAgoraService 对象。
setLogFile	设置 SDK 日志文件的路径和大小。
setLogFilter	设置 SDK 日志输出过滤器。
getAgoraParameter	获取 IAgoraParameter 对象。

IAgoraMediaComponentFactory

API	描述
createMediaRtcRecorder	创建一个 IAgoraMediaRtcRecorder 媒体录制器实例。
createAgoraMediaComponentFactory	创建一个 IMediaComponentFactory 对象并返回指针。

IAgoraMediaRtcRecorder

API	描述
initialize	初始化录制器实例。
joinChannel	加入声网 RTC 频道。
leaveChannel	离开声网 RTC 频道。
enableEncryption	启用或禁用内置加密功能。
subscribeAllAudio	订阅并录制频道中所有远端用户的音频。
subscribeAllVideo	订阅频道中所有远端用户的视频。
unsubscribeAllAudio	停止订阅频道中所有远端用户的音频。
unsubscribeAllVideo	停止订阅频道中所有远端用户的视频。
subscribeAudio	订阅并录制频道中指定远端用户的音频。
unsubscribeAudio	停止订阅频道中指定远端用户的音频。
subscribeVideo	订阅频道中指定远端用户的视频。
unsubscribeVideo	停止订阅频道中指定远端用户的视频。
setAudioVolumeIndicationParameters	设置 onAudioVolumeIndication 回调的时间间隔。
setVideoMixingLayout	设置混合视频流的布局。
setRecorderConfig	设置录制器实例配置。
enableAndUpdateVideoWatermarks	为视频流添加水印。
disableVideoWatermarks	禁用视频水印。
startRecording	开始录制。
stopRecording	停止录制。
startSingleRecordingByUid	根据用户 ID 启动录制。
stopSingleRecordingByUid	通过指定用户 ID 停止录制。
setRecorderConfigByUid	根据用户 ID 设置录制配置。
enableAndUpdateVideoWatermarksByUid	为指定用户的视频流添加水印。
disableVideoWatermarksByUid	根据用户 ID 关闭其视频流的水印。
registerRecorderEventHandle	注册录制事件处理器。
unregisterRecorderEventHandle	注销录制事件处理器。
setGlobalLocalAccessPoint	设置本地 AP 模式下的全局本地接入点地址。
renewToken	更新 。

IAgoraMediaRtcRecorderEventHandler

API	描述
onConnected	SDK 与声网频道连接状态变为 CONNECTION_STATE_CONNECTED(3) 时触发的回调。
onDisconnected	当 SDK 与声网频道的连接状态变为 CONNECTION_STATE_DISCONNECTED(1) 时触发的回调。
onReconnected	连接状态再次变为 CONNECTION_STATE_CONNECTED(3) 时触发的回调。
onConnectionLost	当 SDK 与声网频道失去连接时触发的回调。
onUserJoined	远端用户成功加入频道回调。
onUserLeft	远端用户离开频道回调。
onFirstRemoteVideoDecoded	远端视频首帧解码完成回调。
onFirstRemoteAudioDecoded	远端音频首帧解码回调。
onAudioVolumeIndication	报告正在说话的用户、各说话者的音量，以及本地用户是否在说话。
onActiveSpeaker	检测到活跃发言人时触发的回调。
onUserVideoStateChanged	远端视频状态发生改变回调。
onUserAudioStateChanged	远端用户音频状态发生变化回调。
onRemoteVideoStats	报告远端视频统计信息的回调。
onRemoteAudioStats	远端音频统计信息回调。
onRecorderStateChanged	本地录制状态发生变化时的回调。
onRecorderInfoUpdated	录制信息更新回调。
onEncryptionError	报告加密错误类型的回调。
onError	报告错误码和错误信息。
onTokenPrivilegeWillExpire	在 30 秒后即将过期时触发的回调。
onTokenPrivilegeDidExpire	过期回调。