API 概览
AgoraService
| API | 描述 |
|---|---|
AgoraService | 创建一个 AgoraService 实例并初始化原生组件。 |
getNativeHandle | 获取与该 AgoraService 实例关联的原生句柄。 |
release | 释放 AgoraService 对象及其相关资源。 |
initialize | 使用指定配置初始化 AgoraService 对象。 |
createAgoraMediaComponentFactory | 创建并返回一个用于创建媒体的 AgoraMediaComponentFactory 对象。 |
getAgoraParameter | 创建并返回用于参数管理的 AgoraParameter 对象。 |
getSdkVersion | 获取 SDK 的版本号。 |
setLogFile | 设置 SDK 日志文件的路径和大小。 |
setLogLevel | 设置 SDK 日志输出级别。 |
setGlobalLocalAccessPoint | 设置本地 AP 模式下的全局本地接入点地址（同时调用本地代理）。 |
AgoraMediaComponentFactory
| API | 描述 |
|---|---|
AgoraMediaComponentFactory | 创建一个 AgoraMediaComponentFactory 实例。 |
createMediaRtcRecorder | 创建一个新的 AgoraMediaRtcRecorder 实例。 |
release | 释放与工厂相关的原生资源。 |
AgoraMediaRtcRecorder
| API | 描述 |
|---|---|
AgoraMediaRtcRecorder | 创建一个 AgoraMediaRtcRecorder 录制器实例。 |
initialize | 初始化录制器实例，并设置服务和是否启用合流模式。 |
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 | 为当前会话续订 。 |
release | 释放与录制器实例关联的原生资源。 |
IAgoraMediaRtcRecorderEventHandler
| API | 描述 |
|---|---|
onConnected | SDK 与声网频道连接状态变为 CONNECTION_STATE_CONNECTED(3) 时触发的回调。 |
onDisconnected | 连接状态变为 CONNECTION_STATE_DISCONNECTED(1) 时触发的回调。 |
onReconnected | 连接状态恢复为 CONNECTION_STATE_CONNECTED(3) 时触发的回调。 |
onConnectionLost | SDK 与声网频道失去连接时触发的回调。 |
onUserJoined | 远端用户加入频道回调。 |
onUserLeft | 远端用户离开频道回调。 |
onFirstRemoteVideoDecoded | 首帧远端视频解码完成回调。 |
onFirstRemoteAudioDecoded | 首帧远端音频解码回调。 |
onAudioVolumeIndication | 报告哪些用户正在说话、说话者的音量以及本地用户是否在说话。 |
onActiveSpeaker | 活跃发言人检测回调。 |
onRemoteVideoStats | 远端视频统计信息回调。 |
onRemoteAudioStats | 远端音频统计信息回调。 |
onRecorderInfoUpdated | 录制信息更新回调。 |
onEncryptionError | 加密错误发生时的回调。 |
onError | 错误信息回调。 |
onTokenPrivilegeWillExpire | 权限即将在 30 秒后过期时触发的回调。 |
onTokenPrivilegeDidExpire | 过期回调。 |