# 声网3.4.1与阿里2.1接口对比

# iOS端

  • AliRtcEngine是主类,提供所有可以供App调用的方法
  • AliRtcEngineDelegate里的声明方法是SDK向App发送的回调通知子频道功能:通过方法createChannelWithDelegate可以创建一个子频道,返回的类型和主频道一致,为:AliRtcEngine。
  • 子频道的代理与方法调用和主频道一样,只不过一些接口只在主频道调用有效,子频道调用无效,具体参见:XXXX。
  • 在调用API的过程中,SDK会返回错误码和警告码,详见XXXX。
  • 此文档中声网接口与回调总数为:260个。阿里对齐171个,未对齐89个,对齐比例为:66%

# 频道管理

声网 阿里 描述 对齐
sharedEngineWithAppId (opens new window) sharedInstance (opens new window) 创建 AgoraRtcEngineKit 实例
sharedEngineWithConfig (opens new window) sharedInstance (opens new window) 创建 AgoraRtcEngineKit 实例并指定访问区域
destroy (opens new window) destroy (opens new window) 销毁 AgoraRtcEngineKit 实例
setChannelProfile (opens new window) setChannelProfile (opens new window) 设置频道场景
setClientRole (opens new window)1 setClientRole (opens new window) 设置直播场景下的用户角色
setClientRole (opens new window)2 setClientRole (opens new window) 设置直播场景下的用户角色和级别
joinChannelByToken (opens new window)1 joinChannel (opens new window) 加入频道
joinChannelByToken (opens new window)2 - 加入频道并设置订阅状态
switchChannelByToken (opens new window)1 switchChannel (opens new window) 快速切换直播频道
switchChannelByToken (opens new window)2 switchChannel (opens new window) 快速切换直播频道并设置订阅状态
leaveChannel (opens new window) leaveChannel (opens new window) 离开频道
renewToken (opens new window) - 更新 Token
getConnectionState (opens new window) getCurrentConnectionStatus (opens new window) 获取网络连接状态

# 频道事件

声网 阿里 描述 对齐
didJoinChannel (opens new window) onJoinChannelResult (opens new window) 已加入频道
didRejoinChannel (opens new window) - 已重新加入频道
didLeaveChannelWithStats (opens new window) onLeaveChannelResult (opens new window) 已离开频道
didClientRoleChanged (opens new window) onUpdateRoleNotifyWithOldRole (opens new window) 用户角色已切换
didJoinedOfUid (opens new window) onRemoteUserOnLineNotify (opens new window) 远端用户已加入频道
didOfflineOfUid (opens new window) onRemoteUserOffLineNotify (opens new window) 远端用户已离开频道
connectionChangedToState (opens new window) onConnectionStatusChange (opens new window) 网络连接状态已改变
networkTypeChangedToType (opens new window) - 本地网络类型发生改变
rtcEngineConnectionDidLost (opens new window) onConnectionLost (opens new window) 网络连接中断且 SDK 无法在 10 秒内连接服务器
tokenPrivilegeWillExpire (opens new window) - Token 服务即将过期
rtcEngineRequestToken (opens new window) - Token 已过期

# 音频管理

声网 阿里 描述 对齐
enableAudio (opens new window) - 启用音频模块
disableAudio (opens new window) - 关闭音频模块
setAudioProfile (opens new window) setAudioProfile (opens new window) 设置音频编码配置
adjustRecordingSignalVolume (opens new window) setRecordingVolume (opens new window) 调节音频采集信号音量
adjustLoopbackRecordingSignalVolume (opens new window) - 调节声卡采集信号音量(仅适用于 macOS)
adjustUserPlaybackSignalVolume (opens new window) setRemoteAudioVolume (opens new window) 调节本地播放的指定远端用户的信号音量
adjustPlaybackSignalVolume (opens new window) setPlayoutVolume (opens new window) 调节本地播放的所有远端用户的信号音量
enableLocalAudio (opens new window) startAudioCapture (opens new window)/stopAudioCapture (opens new window) 开关本地音频采集
muteLocalAudioStream (opens new window) publishLocalAudioStream (opens new window) 取消或恢复发布本地音频流
muteRemoteAudioStream (opens new window) subscribeRemoteAudioStream (opens new window) 取消或恢复订阅指定远端用户的音频流
muteAllRemoteAudioStreams (opens new window) subscribeAllRemoteVideoStreams (opens new window) 取消或恢复订阅所有远端用户的音频流

# 视频管理

声网 阿里 描述 对齐
enableVideo (opens new window) - 启用视频模块
disableVideo (opens new window) - 关闭视频模块
setVideoEncoderConfiguration (opens new window) setVideoEncoderConfiguration (opens new window) 设置视频编码配置
setupLocalVideo (opens new window) setLocalViewConfig (opens new window) 初始化本地用户视图
setupRemoteVideo (opens new window) setRemoteViewConfig (opens new window) 初始化远端用户视图
setLocalRenderMode (opens new window) setLocalViewConfig (opens new window) 更新本地视图显示模式
setRemoteRenderMode (opens new window) setRemoteViewConfig (opens new window) 更新远端视图显示模式
startPreview (opens new window) startPreview (opens new window) 开启视频预览
stopPreview (opens new window) stopPreview (opens new window) 停止视频预览
enableLocalVideo (opens new window) enableLocalVideo (opens new window) 开关本地视频采集
muteLocalVideoStream (opens new window) publishLocalVideoStream (opens new window) 取消或恢复发布本地视频流
muteRemoteVideoStream (opens new window) subscribeRemoteVideoStream (opens new window) 取消或恢复订阅指定远端用户的视频流
muteAllRemoteVideoStreams (opens new window) subscribeAllRemoteVideoStreams (opens new window) 取消或恢复订阅所有远端用户的视频流

# 本地媒体事件

声网 阿里 描述 对齐
localAudioStateChange (opens new window) - 本地音频状态发生改变
localVideoStateChange (opens new window) - 本地视频状态发生改变
firstLocalAudioFramePublished (opens new window) onFirstAudioPacketSentWithTimecost (opens new window) 已发布本地音频首帧回调
firstLocalVideoFramePublished (opens new window) onFirstVideoPacketSentWithVideoTrack (opens new window) 已发布本地视频首帧回调
firstLocalVideoFrameWithSize (opens new window) onFirstLocalVideoFrameDrawn (opens new window) 已显示本地视频首帧
didAudioPublishStateChange (opens new window) onAudioPublishStateChanged (opens new window) 音频发布状态改变回调
didVideoPublishStateChange (opens new window) onVideoPublishStateChanged (opens new window) 视频发布状态改变回调

# 远端媒体事件

声网 阿里 描述 对齐
remoteAudioStateChangedOfUid (opens new window) - 远端音频流状态发生改变
remoteVideoStateChangedOfUid (opens new window) - 远端用户视频流状态发生改变
firstRemoteVideoFrameOfUid (opens new window) onFirstRemoteVideoFrameDrawn (opens new window) 已显示远端视频首帧
didAudioSubscribeStateChange (opens new window) onAudioSubscribeStateChanged (opens new window) 音频订阅状态发生改变回调
didVideoSubscribeStateChange (opens new window) onVideoSubscribeStateChanged (opens new window) 视频订阅状态发生改变回调
didAudioMuted (opens new window) onUserAudioMuted (opens new window) 远端用户音频静音回调
didVideoMuted (opens new window) onUserVideoMuted (opens new window) 远端用户暂停发送视频回调
didVideoEnabled (opens new window) - 远端用户启用/关闭视频回调
didLocalVideoEnabled (opens new window) - 远端用户启用/关闭本地视频回调

# 数据统计事件

声网 阿里 描述 对齐
remoteAudioStats (opens new window) onRtcRemoteAudioStats (opens new window) 报告通话中远端音频流的统计信息
reportRtcStats (opens new window) onRtcStats (opens new window) 报告 Rtc Engine 统计信息
networkQuality (opens new window) onNetworkQualityChanged (opens new window) 报告网络上下行质量
localAudioStats (opens new window) onRtcLocalAudioStats (opens new window) 通话中本地音频流的统计信息回调
localVideoStats (opens new window) onRtcLocalVideoStats (opens new window) 报告本地视频统计信息
remoteVideoStats (opens new window) onRtcRemoteVideoStats (opens new window) 报告远端视频统计信息

# 视频前处理及后处理

声网 阿里 描述 对齐
setBeautyEffectOptions (opens new window) setBeautyEffect (opens new window) 设置美颜效果选项

# 多频道管理

声网 阿里 描述 对齐
createRtcChannel (opens new window) createChannelWithDelegate (opens new window) 创建并获取一个 AgoraRtcChannel 对象。通过创建多个对象,用户可以同时加入多个频道。
AgoraRtcChannel (opens new window) AliRtcEngine 该类提供在指定频道内实现实时音视频功能的方法。
AgoraRtcChannelDelegate (opens new window) AliRtcEngineDelegate 该类提供监听指定频道事件和数据的回调。

# 屏幕共享

本组方法仅适用于 macOS,不适用于 iOS。

声网 阿里 描述 对齐
startScreenCaptureByDisplayId (opens new window) startScreenShareWithDesktopId 通过屏幕 ID 共享屏幕
startScreenCaptureByWindowId (opens new window) startScreenShareWithWindowId 通过窗口 ID 共享窗口
setScreenCaptureContentHint (opens new window) -1 设置屏幕共享内容类型
updateScreenCaptureParameters (opens new window) -1 更新屏幕共享的参数配置
updateScreenCaptureRegion (opens new window) updateScreenShareConfig 更新屏幕共享区域
stopScreenCapture (opens new window) stopScreenShare 停止屏幕共享

# 音乐文件播放及混音

声网 阿里 描述 对齐
startAudioMixing (opens new window) startAudioAccompanyWithFile (opens new window) 开始播放音乐文件
stopAudioMixing (opens new window) stopAudioAccompany (opens new window) 停止播放音乐文件
pauseAudioMixing (opens new window) pauseAudioAccompany (opens new window) 暂停播放音乐文件
resumeAudioMixing (opens new window) resumeAudioAccompany (opens new window) 恢复播放音乐文件
adjustAudioMixingVolume (opens new window) setAudioAccompanyVolume (opens new window) 调节音乐文件播放音量
adjustAudioMixingPlayoutVolume (opens new window) setAudioAccompanyPlayoutVolume (opens new window) 调节音乐文件的本地播放音量
adjustAudioMixingPublishVolume (opens new window) setAudioAccompanyPublishVolume (opens new window) 调节音乐文件的远端播放音量
setAudioMixingPitch (opens new window) setAudioEffectPitchValue (opens new window) 调整本地播放的音乐文件的音调
getAudioMixingPlayoutVolume (opens new window) getAudioAccompanyPlayoutVolume (opens new window) 获取音乐文件的本地播放音量
getAudioMixingPublishVolume (opens new window) getAudioAccompanyPublishVolume (opens new window) 获取音乐文件的远端播放音量
getAudioMixingDuration (opens new window) getAudioAccompanyDuration (opens new window) 获取音乐文件播放时长
getAudioMixingCurrentPosition (opens new window) getAudioAccompanyCurrentPosition (opens new window) 获取音乐文件播放进度
setAudioMixingPosition (opens new window) setAudioAccompanyPosition (opens new window) 设置音乐文件的播放位置
声网事件 阿里事件 描述 对齐
localAudioMixingStateDidChanged (opens new window) onAudioPlayingStateChanged (opens new window) 本地音乐文件播放状态改变
rtcEngineRemoteAudioMixingDidStart (opens new window) onRemoteAudioAccompanyStarted (opens new window) 远端音乐文件播放已开始
rtcEngineRemoteAudioMixingDidFinish (opens new window) onRemoteAudioAccompanyFinished (opens new window) 远端音乐文件播放已结束

# 音效文件播放管理

声网 阿里 描述 对齐
getEffectsVolume (opens new window) getAudioEffectPlayoutVolumeWithSoundId (opens new window) 获取音效文件播放音量
setEffectsVolume (opens new window) setAllAudioEffectsPlayoutVolume (opens new window) 设置音效文件播放音量
setVolumeOfEffect (opens new window) setAudioEffectPlayoutVolumeWithSoundId (opens new window) 实时调整音效文件播放音量
playEffect (opens new window) playAudioEffectWithSoundId (opens new window) 播放指定音效文件
stopEffect (opens new window) stopAudioEffectWithSoundId (opens new window) 停止播放指定音效文件
stopAllEffects (opens new window) stopAllAudioEffects (opens new window) 停止播放所有音效文件
preloadEffect (opens new window) preloadAudioEffectWithSoundId (opens new window) 将指定音效文件预加载至内存
unloadEffect (opens new window) unloadAudioEffectWithSoundId (opens new window) 从内存释放某个预加载的音效文件
pauseEffect (opens new window) pauseAudioEffectWithSoundId (opens new window) 暂停音效文件播放
pauseAllEffects (opens new window) pauseAllAudioEffects (opens new window) 暂停所有音效文件播放
resumeEffect (opens new window) resumeAudioEffectWithSoundId (opens new window) 恢复播放指定音效文件
resumeAllEffects (opens new window) resumeAllAudioEffects (opens new window) 恢复播放所有音效文件
getEffectDuration (opens new window) -1 获取指定音效文件总时长
getEffectCurrentPosition (opens new window) -1 获取指定音效文件的播放进度
setEffectPosition (opens new window) -1 设置指定音效文件的播放位置
声网事件 阿里事件 描述 对齐
rtcEngineDidAudioEffectFinish (opens new window) onAudioEffectFinished (opens new window) 本地音效文件播放已结束

# 虚拟节拍器

声网 阿里 描述 对齐
startRhythmPlayer (opens new window) -1 开启虚拟节拍器
configRhythmPlayer (opens new window) -1 配置虚拟节拍器
stopRhythmPlayer (opens new window) -1 关闭虚拟节拍器

# 人声效果

声网 阿里 描述 对齐
setLocalVoicePitch (opens new window) setAudioEffectPitchValue (opens new window) 设置本地语音音调
setLocalVoiceEqualizationOfBandFrequency (opens new window) -1 设置本地语音音效均衡
setLocalVoiceReverbOfType (opens new window) setAudioEffectReverbMode (opens new window) 设置本地音效混响
setVoiceBeautifierPreset (opens new window) setAudioEffectVoiceChangerMode (opens new window) 设置 SDK 预设的美声效果
setVoiceBeautifierParameters (opens new window) setAudioEffectVoiceChangerMode (opens new window) 设置 SDK 预设美声效果的参数
setAudioEffectPreset (opens new window) setAudioEffectVoiceChangerMode (opens new window) 设置 SDK 预设的人声音效
setAudioEffectParameters (opens new window) setAudioEffectVoiceChangerMode (opens new window) 设置 SDK 预设人声音效的参数
setVoiceConversionPreset (opens new window) setAudioEffectVoiceChangerMode (opens new window) 设置 SDK 预设的变声效果

# 听声辨位

声网 阿里 描述 对齐
enableSoundPositionIndication (opens new window) -1 开启/关闭远端用户的语音立体声
setRemoteVoicePosition (opens new window) -1 设置远端用户的语音位置

# CDN 推流

声网 阿里 描述 对齐
setLiveTranscoding (opens new window) startPublishLiveStreamWithURL (opens new window) 设置直播转码
addPublishStreamUrl (opens new window) startPublishLiveStreamWithURL (opens new window) 增加旁路推流地址
removePublishStreamUrl (opens new window) stopPublishLiveStreamWithURL (opens new window) 删除旁路推流地址
声网事件 阿里事件 描述 对齐
rtmpStreamingChangedToState (opens new window) onPublishLiveStreamStateChanged (opens new window) RTMP/RTMPS 推流状态发生改变
rtmpStreamingEventWithUrl (opens new window) onPublishTaskStateChanged (opens new window) RTMP/RTMPS 推流事件回调
rtcEngineTranscodingUpdated (opens new window) onPublishLiveStreamStateChanged (opens new window) 旁路推流设置已被更新

# 跨频道媒体流转发

声网 阿里 描述 对齐
startChannelMediaRelay (opens new window) startChannelRelay (opens new window) 开始跨频道媒体流转发
updateChannelMediaRelay (opens new window) updateChannelRelay (opens new window) 更新媒体流转发的频道
stopChannelMediaRelay (opens new window) stopChannelRelay (opens new window) 停止跨频道媒体流转发
声网事件 阿里事件 描述 对齐
channelMediaRelayStateDidChange (opens new window) onChannelRelayStateChanged (opens new window) 跨频道媒体流转发状态发生改变
didReceiveChannelMediaRelayEvent (opens new window) onChannelRelayEvent (opens new window) 跨频道媒体流转发事件

# 音量提示

声网 阿里 描述 对齐
enableAudioVolumeIndication enableAudioVolumeIndication (opens new window) 启用用户音量提示
声网事件 阿里事件 描述 对齐
reportAudioVolumeIndicationOfSpeakers onAudioVolumeCallback (opens new window) 用户音量提示回调
activeSpeaker onActiveSpeaker (opens new window) 监测到最活跃用户回调

# 人脸检测

声网 阿里 描述 对齐
enableFaceDetection (opens new window) -1 开启/关闭本地人脸检测
声网事件 阿里事件 描述 对齐
facePositionDidChangeWidth (opens new window) -1 报告本地人脸检测结果

# 音频播放路由

声网 阿里 描述 对齐
setDefaultAudioRouteToSpeakerphone (opens new window) - 设置默认的音频播放路由
setEnableSpeakerphone (opens new window) enableSpeakerphone (opens new window) 启用/关闭扬声器播放
isSpeakerphoneEnabled (opens new window) isEnableSpeakerphone (opens new window) 查询扬声器启用状态
声网事件 阿里事件 描述 对齐
didAudioRouteChanged (opens new window) onAudioRouteChanged (opens new window) 语音路由已改变

# 耳返控制

声网 阿里 描述 对齐
enableInEarMonitoring (opens new window) enableEarBack (opens new window) 开启耳返功能
setInEarMonitoringVolume (opens new window) setEarBackVolume (opens new window) 设置耳返音量

# 视频双流模式

声网 阿里 描述 对齐
enableDualStreamMode (opens new window) publishLocalDualStream (opens new window) 开关视频双流模式
setRemoteVideoStream (opens new window) setRemoteVideoStreamType (opens new window) 设置订阅的视频流类型
setRemoteDefaultVideoStreamType (opens new window) setRemoteDefaultVideoStreamType (opens new window) 设置默认订阅的视频流类型

# 音视频流回退

声网 阿里 描述 对齐
setRemoteUserPriority (opens new window) -1 设置远端用户流的优先级
setLocalPublishFallbackOption (opens new window) -1 设置弱网条件下发布的音视频流回退选项
setRemoteSubscribeFallbackOption (opens new window) -1 设置弱网条件下订阅的音视频流回退选项
声网事件 阿里事件 描述 对齐
didLocalPublishFallbackToAudioOnly (opens new window) -1 本地发布流已回退为音频流或恢复为音视频流
didRemoteSubscribeFallbackToAudioOnly (opens new window) -1 远端订阅流已回退为音频流或恢复为音视频流

# 通话前网络测试

声网 阿里 描述 对齐
startEchoTestWithInterval (opens new window) -1 开始语音通话回路测试
stopEchoTest (opens new window) -1 停止语音通话回路测试
enableLastmileTest (opens new window) startLastmileDetect (opens new window) 启用网络测试
disableLastmileTest (opens new window) stopLastmileDetect (opens new window) 关闭网络测试
startLastmileProbeTest (opens new window) -1 开始通话前网络质量探测
stopLastmileProbeTest (opens new window) -1 停止通话前网络质量探测
声网事件 阿里事件 描述 对齐
lastmileQuality (opens new window) onLastmileDetectResultWithQuality (opens new window) 报告本地用户的网络质量
lastmileProbeTestResult (opens new window) -1 报告通话前网络上下行 last mile 质量

# 自定义视频模块

声网 阿里 描述 对齐
setVideoSource (opens new window) -1 设置自定义视频源
setLocalVideoRenderer (opens new window) -1 设置本地自定义视频渲染器
setRemoteVideoRenderer (opens new window) -1 设置远端自定义视频渲染器
videoSource (opens new window) -1 获取当前视频源
localVideoRenderer (opens new window) -1 获取本地视频渲染器
remoteVideoRendererOfUserId (opens new window) -1 获取远端视频渲染器

# 音频自采集

声网 阿里 描述 对齐
enableExternalAudioSourceWithSampleRate (opens new window) setExternalAudioSource (opens new window) 开启外部音频采集
disableExternalAudioSource (opens new window) setExternalAudioSource (opens new window) 关闭外部音频采集
pushExternalAudioFrameRawData (opens new window) pushExternalAudioFrameRawData (opens new window) 推送外部原始音频帧
pushExternalAudioFrameSampleBuffer (opens new window) pushExternalAudioFrameRawData (opens new window) 推送外部 CMSampleBuffer 音频帧

# 音频自渲染

声网 阿里 描述 对齐
enableExternalAudioSink (opens new window) subscribeAudioData (opens new window) 设置外部音频渲染
disableExternalAudioSink (opens new window) unSubscribeAudioData (opens new window) 关闭外部音频渲染
pullPlaybackAudioFrameRawData (opens new window) -1 拉取 RawData 格式的远端音频数据
pullPlaybackAudioFrameSampleBufferByLengthInByte (opens new window) -1 拉取 SampleBuffer 格式的远端音频数据

# 视频自采集

声网 阿里 描述 对齐
setExternalVideoSource (opens new window) setExternalVideoSource (opens new window) 配置外部视频源
pushExternalVideoFrame (opens new window) pushExternalVideoFrame (opens new window) 推送外部视频帧

# 原始音频数据

声网 阿里 描述 对齐
setRecordingAudioFrameParametersWithSampleRate (opens new window) -1 设置采集的音频格式
setPlaybackAudioFrameParametersWithSampleRate (opens new window) -1 设置播放的音频格式
setMixedAudioFrameParametersWithSampleRate (opens new window) -1 设置采集和播放的音频混音后的数据格式
setAudioFrameDelegate (opens new window) -1 设置音频帧 delegate
声网事件 阿里事件 描述 对齐
onRecordAudioFrame (opens new window) onAudioSampleCallback (opens new window) 获得采集的原始音频数据
onPlaybackAudioFrame (opens new window) -1 获得播放的原始音频数据
onMixedAudioFrame (opens new window) onAudioSampleCallback (opens new window) 获取本地用户和所有远端用户混音后的原始音频数据
onPlaybackAudioFrameBeforeMixing (opens new window) onPlaybackAudioFrameBeforeMixing (opens new window) 获取单个远端用户混音前的原始音频数据

# 媒体附属信息

声网 阿里 描述 对齐
setMediaMetadataDataSource (opens new window) -1 设置媒体附属信息的 Data source
setMediaMetadataDataDelegate (opens new window) -1 设置媒体附属信息的 Delegate
声网事件 阿里事件 描述 对齐
metadataMaxSize (opens new window) -1 请求媒体附属信息的最大数据大小
readyToSendMetadataAtTimestamp (opens new window) -1 发送端已准备好发送媒体附属信息
receiveMetadata (opens new window) onMediaExtensionMsgReceived (opens new window) 接收端已收到媒体附属信息

# 直播视频水印

声网 阿里 描述 对齐
addVideoWatermark (opens new window) addVideoWatermark (opens new window) 添加本地视频水印
clearVideoWatermarks (opens new window) clearVideoWatermark (opens new window) 删除已添加的视频水印

# 加密

声网 阿里 描述 对齐
enableEncryption (opens new window) -1 开启或关闭内置加密

# 音频录制

声网 阿里 描述 对齐
startAudioRecordingWithConfig (opens new window) startRecord (opens new window) 开始客户端录音
stopAudioRecording (opens new window) stopRecord (opens new window) 停止客户端录音

# 摄像头控制

声网 阿里 描述 对齐
switchCamera (opens new window) switchCamera (opens new window) 切换前置/后置摄像头
isCameraZoomSupported (opens new window) -1 检测设备是否支持摄像头缩放功能
isCameraTorchSupported (opens new window) -1 检测设备是否支持闪光灯常开
isCameraFocusPositionInPreviewSupported (opens new window) isCameraFocusPointSupported (opens new window) 检测设备是否支持手动对焦功能
isCameraExposurePositionSupported (opens new window) isCameraExposurePointSupported (opens new window) 检测设备是否支持手动曝光功能
isCameraAutoFocusFaceModeSupported (opens new window) isCameraAutoFocusFaceModeSupported (opens new window) 检测设备是否支持人脸对焦功能
setCameraZoomFactor (opens new window) setCameraZoom (opens new window) 设置摄像头缩放比例
setCameraFocusPositionInPreview (opens new window) setCameraFocusPoint (opens new window) 设置手动对焦位置,并触发对焦
setCameraExposurePosition (opens new window) setCameraExposurePoint (opens new window) 设置手动曝光位置
setCameraTorchOn (opens new window) setCameraFlash (opens new window) 设置是否打开闪光灯
setCameraAutoFocusFaceModeEnabled (opens new window) setCameraAutoFocusFaceModeEnabled (opens new window) 设置是否开启人脸对焦功能
声网事件 阿里事件 描述 对齐
cameraFocusDidChangedToRect (opens new window) -1 摄像头对焦区域已改变
cameraExposureDidChangedToRect (opens new window) -1 摄像头曝光区域已改变

# 设备管理

声网 阿里 描述 对齐
monitorDeviceChange (opens new window) - 监控设备改变
enumerateDevices (opens new window) getAudioCaptures+getAudioRenderers+getCameraList 获取系统中所有的音视频设备
getDeviceInfo (opens new window) getCurrentAudioCapture+getCurrentAudioRenderer+getCurrentCamera 获取当前设备名称
setDevice (opens new window) setCurrentAudioCaptureWithID+setCurrentAudioRendererWithID+setCurrentCameraWithID 指定设备
getDeviceVolume (opens new window) getRecordingDeviceVolume+getPlayoutDeviceVolume 获取设备音量
setDeviceVolume (opens new window) setRecordingDeviceVolume+setPlayoutDeviceVolume 设置设备音量
startRecordingDeviceTest (opens new window) startTestAudioRecordWithName 启动音频采集设备测试
stopRecordingDeviceTest (opens new window) stopTestAudioRecord 停止测试音频采集设备
startPlaybackDeviceTest (opens new window) startTestAudioPlayoutWithName 启动音频播放设备测试
stopPlaybackDeviceTest (opens new window) stopTestAudioPlayout 停止播放设备测试
startCaptureDeviceTest (opens new window) - 启动视频采集设备测试
stopCaptureDeviceTest (opens new window) - 停止视频采集设备测试
startAudioDeviceLoopbackTest (opens new window) - 开始音频设备回路测试
stopAudioDeviceLoopbackTest (opens new window) - 停止音频设备回路测试
声网事件 阿里事件 描述 对齐
stateChanged (opens new window) onAudioDeviceStateChanged 设备状态改变(仅适用于 macOS)

# 流消息

声网 阿里 描述 对齐
createDataStream (opens new window) -1 创建数据流
sendStreamMessage (opens new window) sendMediaExtensionMsg (opens new window) 发送数据流
声网事件 阿里事件 描述 对齐
receiveStreamMessageFromUid (opens new window) onMediaExtensionMsgReceived (opens new window) 接收到对方数据流消息
didOccurStreamMessageErrorFromUid (opens new window) -1 接收对方数据流消息发生错误

# 其他音频控制

声网 阿里 描述 对齐
enableLoopbackRecording (opens new window) - 开启声卡采集(仅 macOS)
setAudioSessionOperationRestriction (opens new window) setAudioSessionOperationRestriction (opens new window) 设置 SDK 对 Audio Session 的操作权限

# 其他视频控制

声网 阿里 描述 对齐
setCameraCapturerConfiguration (opens new window) setCameraCapturerConfiguration (opens new window) 设置摄像头采集配置

# 其他方法

声网 阿里 描述 对齐
setCloudProxy (opens new window) -1 设置 Agora 云代理服务
enableDeepLearningDenoise (opens new window) startIntelligentDenoise (opens new window)/stopIntelligentDenoise (opens new window) 开启/关闭 AI 降噪模式
sendCustomReportMessage (opens new window) postFeedbackWithUid (opens new window) 自定义数据上报
getCallId (opens new window) -1 获取通话 ID
rate (opens new window) -1 给通话评分
complain (opens new window) -1 投诉通话质量
enableMainQueueDispatch (opens new window) enableDelegateMainQueue (opens new window) 分发/不分发回调至主队列
getSdkVersion (opens new window) getSDKVersion (opens new window) 查询 SDK 版本号
getErrorDescription (opens new window) getErrorDescription (opens new window) 获取警告或错误描述
getNativeHandle (opens new window) -1 获取 SDK 引擎的 C++ 句柄
delegate (opens new window) sharedInstance (opens new window) 设置/获取回调事件

# 其他事件

声网 阿里 描述 对齐
didOccurWarning (opens new window) onOccurWarning (opens new window) 发生警告
didOccurError (opens new window) onOccurError (opens new window) 发生错误
didApiCallExecute (opens new window) -1 API 方法已执行