API 概览

AgoraService

API	描述
`AgoraService`	构造一个 `AgoraService` 实例并初始化原生组件。
`release`	释放 `AgoraService` 对象及其相关资源。
`initialize`	使用指定的配置初始化 `AgoraService` 对象。
`createMediaRtcRecorder`	创建一个新的 `AgoraMediaRtcRecorder` 实例。
`getAgoraParameter`	创建并返回用于参数管理的 `AgoraParameter` 对象。
`getSdkVersion`	获取 SDK 的版本信息。
`setLogFile`	设置 SDK 日志文件的路径和大小。
`setLogLevel`	设置 SDK 的日志输出等级。
`setGlobalLocalAccessPoint`	在本地 AP 模式下设置全局本地接入点地址。

AgoraMediaRtcRecorder

API	描述
`AgoraMediaRtcRecorder`	构造一个 `AgoraMediaRtcRecorder` 录制器实例。
`initialize[1/2]`	初始化录制器实例，设置服务、是否启用合流模式，以及是否仅录制编码视频。
`initialize[2/2]`	初始化录制器，并设置服务实例和是否启用合流模式。
`joinChannel`	加入一个声网 RTC 频道。
`leaveChannel`	离开当前频道。
`enableEncryption`	启用或禁用内置加密。
`subscribeAllAudio`	订阅频道中所有远端用户的音频流。
`subscribeAllVideo`	订阅频道中所有远端用户的视频流。
`unsubscribeAllAudio`	停止订阅所有远端用户的音频流。
`unsubscribeAllVideo`	停止订阅所有远端用户的视频流。
`subscribeAudio`	订阅指定远端用户的音频流。
`unsubscribeAudio`	停止订阅指定远端用户的音频流。
`subscribeVideo`	订阅指定远端用户的视频流。
`unsubscribeVideo`	停止订阅指定远端用户的视频流。
`setAudioVolumeIndicationParameters`	设置 `onAudioVolumeIndication` 回调的时间间隔。
`setVideoMixingLayout`	设置视频合流布局。
`setRecorderConfig`	配置录制器实例的设置。
`setRecorderConfigByUid`	为指定用户设置录制器实例的配置。
`startRecording`	启动录制过程。
`stopRecording`	停止所有正在进行的录制并保存录制文件。
`startSingleRecordingByUid`	启动指定用户的录制流程。
`stopSingleRecordingByUid`	停止指定用户的录制进程。
`registerRecorderEventHandler`	注册用于录制事件的事件处理器。
`unregisterRecorderEventHandler`	取消注册之前注册的事件处理器。
`enableAndUpdateVideoWatermarks`	为视频流添加水印。
`disableVideoWatermarks`	禁用视频流中的水印。
`enableAndUpdateVideoWatermarksByUid`	为指定用户的视频流添加水印。
`disableVideoWatermarksByUid`	通过用户 ID 禁用其视频流上的水印。
`renewToken`	为当前会话更新 Token。
`enableRecorderVideoFrameCapture`	启用或关闭录制器实例的视频帧采集功能。
`release`	释放与 `Recorder` 实例关联的原生资源。

IAgoraMediaRtcRecorderEventHandler

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

IRecorderVideoFrameObserver

API	描述
`onYuvFrameCaptured`	采集到 YUV 视频帧时触发的回调。
`onEncodedFrameReceived`	接收到编码帧或 JPG 图像缓冲区时触发的回调。
`onJPGFileSaved`	JPG 文件保存到磁盘时触发的回调。

AgoraService

AgoraMediaRtcRecorder

IAgoraMediaRtcRecorderEventHandler

IRecorderVideoFrameObserver

咨询电话

咨询电话

AgoraServiceCopy Anchor Link

AgoraMediaRtcRecorderCopy Anchor Link

IAgoraMediaRtcRecorderEventHandlerCopy Anchor Link

IRecorderVideoFrameObserverCopy Anchor Link

咨询电话

咨询电话

AgoraService

AgoraMediaRtcRecorder

IAgoraMediaRtcRecorderEventHandler

IRecorderVideoFrameObserver