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

# Windows端

阿里的接口总数247

  1. 声网对齐接口数xxx个:搜"是"剔除说明的文字项188-22 = 166个
  2. 声网和阿里都有的功能,但是阿里端接口和声网不一样,阿里未对齐接口数:11个
  3. 声网没有的接口数:57个

接口对齐率为:(247-11)/265 = 95.5% ​

# 核心方法

声网 阿里 描述 对齐
createAgoraRtcEngine (opens new window) Create (opens new window) 创建 IRtcEngine 对象并返回指针。
initialize (opens new window) -- 初始化 Agora SDK 服务。
release (opens new window) Destroy (opens new window) 销毁 IRtcEngine 对象。
setChannelProfile (opens new window) SetChannelProfile (opens new window) 设置频道场景。
setClientRole[1/2] (opens new window) SetClientRole (opens new window) 设置直播场景下的用户角色。
setClientRole[2/2] (opens new window) -- 设置直播场景下的用户角色和级别。
joinChannel (opens new window) [1/2] JoinChannel (opens new window) 加入频道。
joinChannel (opens new window) [2/2] -- 加入频道并设置订阅状态。
switchChannel (opens new window) [1/2] SwitchChannel (opens new window) 快速切换直播频道。
switchChannel (opens new window) [2/2] -- 快速切换直播频道并设置订阅状态。
leaveChannel (opens new window) LeaveChannel (opens new window) 离开频道。
renewToken (opens new window) -- 更新 Token。
getConnectionState (opens new window) GetCurrentConnectionStatus (opens new window) 获取当前网络连接状态。
事件 描述
onConnectionStateChanged (opens new window) OnConnectionStatusChange (opens new window) 网络连接状态已改变回调。
onJoinChannelSuccess (opens new window) OnJoinChannelResult (opens new window) 加入频道回调。
onRejoinChannelSuccess (opens new window) -- 重新加入频道回调。
onLeaveChannel (opens new window) OnLeaveChannelResult (opens new window) 离开频道回调。
onClientRoleChanged (opens new window) OnUpdateRoleNotify (opens new window) 直播场景下用户角色已切换回调。
onUserJoined (opens new window) OnRemoteUserOnLineNotify (opens new window) 远端用户(通信场景)/主播(直播场景)加入当前频道回调。
onUserOffline (opens new window) OnRemoteUserOffLineNotify (opens new window) 远端用户(通信场景)/主播(直播场景)离开当前频道回调。
onNetworkTypeChanged (opens new window) -- 本地网络类型发生改变回调。
onConnectionLost (opens new window) OnConnectionLost (opens new window) 网络连接丢失回调。
onTokenPrivilegeWillExpire (opens new window) -- Token 服务即将过期回调。
onRequestToken (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) SetSystemAudioRecordingVolume (opens new window) 调节声卡采集信号音量。(仅适用于 Windows 和 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) SubscribeAllRemoteAudioStreams (opens new window) 取消或恢复订阅所有远端用户的音频流。

# 视频管理

声网 阿里 描述 对齐
enableVideo (opens new window) (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) 取消或恢复订阅所有远端用户的视频流。
本地媒体事件
事件 描述
onLocalAudioStateChanged (opens new window) 本地音频状态改变回调。
onLocalVideoStateChanged (opens new window) 本地视频状态发生改变回调。
onFirstLocalAudioFramePublished (opens new window) OnFirstAudioPacketSend (opens new window) 已发布本地音频首帧回调。
onFirstLocalVideoFramePublished (opens new window) OnFirstVideoPacketSend (opens new window) 已发布本地视频首帧回调。
onFirstLocalVideoFrame (opens new window) OnFirstLocalVideoFrameDrawn (opens new window) 已显示本地视频首帧回调。
onAudioPublishStateChanged (opens new window) OnAudioPublishStateChanged (opens new window) 音频发布状态改变回调。
onVideoPublishStateChanged (opens new window) OnVideoPublishStateChanged (opens new window) 视频发布状态改变回调。
远端媒体事件
事件 描述
onRemoteAudioStateChanged (opens new window) OnRemoteTrackAvailableNotify (opens new window) 远端用户音频流状态已变化回调。
onRemoteVideoStateChanged (opens new window) 远端用户视频流状态已变化回调。
onFirstRemoteVideoFrame (opens new window) OnFirstVideoFrameReceived (opens new window) 已显示远端视频首帧回调。
onAudioSubscribeStateChanged (opens new window) OnAudioSubscribeStateChanged (opens new window) 音频订阅状态发生改变回调。
onVideoSubscribeStateChanged (opens new window) OnVideoSubscribeStateChanged (opens new window) 视频订阅状态发生改变回调。
数据统计事件
事件 描述
onRtcStats (opens new window) OnStats (opens new window) 当前通话统计回调。
onNetworkQuality (opens new window) OnNetworkQualityChanged (opens new window) 网络上下行质量报告回调。
onLocalAudioStats (opens new window) OnLocalAudioStats (opens new window) 本地音频流统计信息回调。
onLocalVideoStats (opens new window) OnLocalVideoStats (opens new window) 本地视频流统计信息回调。
onRemoteAudioStats (opens new window) OnRemoteAudioStats (opens new window) 通话中远端音频流的统计信息回调。
onRemoteVideoStats (opens new window) OnRemoteVideoStats (opens new window) 远端视频流统计信息回调。

# 视频前处理及后处理

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

# 多频道管理

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

# 屏幕共享

声网 阿里 描述 对齐
startScreenCaptureByDisplayId (opens new window) StartScreenShareByDesktopId (opens new window) 通过屏幕 ID 共享屏幕(仅适用于 macOS)。
startScreenCaptureByScreenRect (opens new window) StartScreenShareByScreenRegion (opens new window) 通过指定区域共享屏幕。
startScreenCaptureByWindowId (opens new window) StartScreenShareByWindowId (opens new window) 通过窗口 ID 共享窗口。
setScreenCaptureContentHint (opens new window) 设置屏幕共享内容类型。
updateScreenCaptureParameters (opens new window) UpdateScreenShareConfig (opens new window) 更新屏幕共享的参数配置。
updateScreenCaptureRegion (opens new window) 更新屏幕共享区域。
stopScreenCapture (opens new window) StopScreenShare (opens new window) 停止屏幕共享。

# 音乐文件播放及混音

声网 阿里 描述 对齐
startAudioMixing (opens new window) StartAudioAccompany (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) 调节音乐文件播放音调。
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) 设置音乐文件的播放位置。
事件 描述
onAudioMixingStateChanged (opens new window) OnRemoteAudioAccompanyStarted (opens new window) + OnRemoteAudioAccompanyFinished (opens new window) 本地用户的音乐文件播放状态改变回调。
onRemoteAudioMixingBegin (opens new window) 远端音乐文件播放已开始回调。
onRemoteAudioMixingEnd (opens new window) 远端音乐文件播放已结束回调。

# 音效文件播放管理

声网 阿里 描述 对齐
getEffectsVolume (opens new window)(获取全部音效文件音量) GetAudioEffectPlayoutVolume (opens new window) (获取指定音频文件播放音量) 获取音效文件的播放音量。 不一致
setEffectsVolume (opens new window) SetAllAudioEffectsPublishVolume (opens new window) 设置音效文件的播放音量。
setVolumeOfEffect (opens new window) SetAudioEffectPlayoutVolume (opens new window) 实时调整音效文件的播放音量。
playEffect (opens new window) PlayAudioEffect (opens new window) 播放指定音效文件。
stopEffect (opens new window) StopAudioEffect (opens new window) 停止播放指定音效文件。
stopAllEffects (opens new window) StopAllAudioEffects (opens new window) 停止播放所有音效文件。
preloadEffect (opens new window) PreloadAudioEffect (opens new window) 将音效文件加载至内存。
unloadEffect (opens new window) UnloadAudioEffect (opens new window) 从内存释放某个预加载的音效文件。
pauseEffect (opens new window) PauseAudioEffect (opens new window) 暂停音效文件播放。
pauseAllEffects (opens new window) PauseAllAudioEffects (opens new window) 暂停所有音效文件播放。
resumeEffect (opens new window) ResumeAudioEffect (opens new window) 恢复播放指定音效文件。
resumeAllEffects (opens new window) ResumeAllAudioEffects (opens new window) 恢复播放所有音效文件。
getEffectDuration (opens new window) GetAudioAccompanyDuration (opens new window) 获取指定音效文件总时长。
getEffectCurrentPosition (opens new window) GetAudioAccompanyCurrentPosition (opens new window) 获取指定音效文件的播放进度。
setEffectPosition (opens new window) SetAudioAccompanyPosition (opens new window) 设置指定音效文件的播放位置。
事件 描述
onAudioEffectFinished (opens new window) OnAudioEffectFinished (opens new window) 本地音效文件播放已结束回调。

# 人声效果

声网 阿里 描述 对齐
setLocalVoicePitch (opens new window) SetAudioEffectPitchValue (opens new window) 设置本地语音音调。
setLocalVoiceEqualization (opens new window) SetAudioEffectReverbParamType (opens new window) 设置本地语音音效均衡。
setLocalVoiceReverb (opens new window) SetAudioEffectReverbMode (opens new window) 设置本地音效混响。
setVoiceBeautifierPreset (opens new window) 设置 SDK 预设的美声效果。
setVoiceBeautifierParameters (opens new window) 设置 SDK 预设美声效果的参数。
setAudioEffectPreset (opens new window) SetAudioEffectVoiceChangerMode (opens new window) 设置 SDK 预设的人声音效。
setAudioEffectParameters (opens new window) 设置 SDK 预设人声音效的参数。
setVoiceConversionPreset (opens new window) 设置 SDK 预设的变声效果。

# 听声辨位

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

# CDN 推流

声网 阿里 描述 对齐
setLiveTranscoding (opens new window) StartLiveStreaming (opens new window) + UpdatePublishLiveStream (opens new window) 设置直播转码。
addPublishStreamUrl (opens new window) 增加旁路推流地址。
removePublishStreamUrl (opens new window) StopPublishLiveStream (opens new window) 删除旁路推流地址。
事件 描述
onRtmpStreamingStateChanged (opens new window) OnPublishLiveStreamStateChanged (opens new window) RTMP/RTMPS 推流状态发生改变回调。
onRtmpStreamingEvent (opens new window) OnPublishLiveStreamStateChanged (opens new window) RTMP/RTMPS 推流事件回调。
onTranscodingUpdated (opens new window) OnPublishTaskStateChanged (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) 停止跨频道媒体流转发。
事件 描述
onChannelMediaRelayStateChanged (opens new window) OnChannelRelayStateChanged (opens new window) 跨频道媒体流转发状态发生改变回调。
onChannelMediaRelayEvent (opens new window) OnChannelRelayEvent (opens new window) 跨频道媒体流转发事件回调。

# 音量提示

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

# 人脸检测

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

# 音频播放路由

声网 阿里 描述 对齐
setDefaultAudioRouteToSpeakerphone (opens new window) SetDefaultAudioRouteToSpeakerphone (opens new window) 设置默认的音频播放路由(仅适用于 Android 和 iOS)。
setEnableSpeakerphone (opens new window) EnableSpeakerphone (opens new window) 启用/关闭扬声器播放(仅适用于 Android 和 iOS)。
isSpeakerphoneEnabled (opens new window) IsEnableSpeakerphone (opens new window) 查询扬声器启用状态(仅适用于 Android 和 iOS)。
事件 描述
onAudioRouteChanged (opens new window) OnAudioRouteChanged (opens new window) 音频路由已改变回调。(仅适用于 Android、iOS 和 macOS)

# 耳返控制

声网 阿里 描述 对齐
enableInEarMonitoring (opens new window) EnableEarBack (opens new window) 开启耳返功能(仅适用于 Android 和 iOS)。
setInEarMonitoringVolume (opens new window) SetEarBackVolume (opens new window) 设置耳返音量(仅适用于 Android 和 iOS)。

# 视频双流模式

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

# 视频流回退

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

# 通话前网络测试

声网 阿里 描述 对齐
startEchoTest (opens new window) 开始语音通话回路测试。
stopEchoTest (opens new window) 停止语音直播回路测试。
enableLastmileTest (opens new window) 启用网络测试。
disableLastmileTest (opens new window) 关闭网络测试。
startLastmileProbeTest (opens new window) StartLastmileDetect (opens new window) 开始通话前网络质量探测。
stopLastmileProbeTest (opens new window) StopLastmileDetect (opens new window) 停止通话前网络质量探测。
事件 描述
onLastmileQuality (opens new window) 本地网络质量报告回调。
onLastmileProbeResult (opens new window) OnLastmileDetectResultWithQuality (opens new window) 通话前网络质量探测报告回调。

# 自定义视频模块

声网 阿里 描述 对齐
setVideoSource (opens new window) 设置自定义视频源。

# 视频自采集(仅 Push 模式)

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

# 音频自采集(仅 Push 模式)

声网 阿里 描述 对齐
setExternalAudioSource (opens new window) SetExternalAudioSource (opens new window) 设置外部音频采集参数。
pushAudioFrame (opens new window) PushExternalAudioFrameRawData (opens new window) 推送外部音频帧。

# 音频自渲染(仅 Pull 模式)

声网 阿里 描述 对齐
setExternalAudioSink (opens new window) SetExteranlAudioRender (opens new window) 设置外部音频渲染。
pullAudioFrame (opens new window) PushExternalAudioRenderRawData (opens new window) 主动拉取外部音频帧。

# 原始音频数据

声网 阿里 描述 对齐
registerAudioFrameObserver (opens new window) RegisterAudioFrameObserver (opens new window) / UnRegisterAudioFrameObserver (opens new window) 注册语音观测器对象。
setRecordingAudioFrameParameters (opens new window) SetSubscribeAudioNumChannel (opens new window) + SetSubscribeAudioSampleRate (opens new window) + SubscribeAudioData (opens new window) / UnsubscribeAudioData (opens new window) 设置采集的音频格式。
setPlaybackAudioFrameParameters (opens new window) 设置播放的声音格式。
setMixedAudioFrameParameters (opens new window) 设置采集与播放声音混音后的数据格式。
事件 描述
onRecordAudioFrame (opens new window) OnRawDataAudioFrame (opens new window) 获得采集的音频。
onPlaybackAudioFrame (opens new window) OnPublishAudioFrame (opens new window) 获得播放的声音。
onPlaybackAudioFrameBeforeMixing (opens new window) OnPlaybackAudioFrameBeforeMixing (opens new window) 获得混音前的指定用户的声音。
onMixedAudioFrame (opens new window) OnSubscribeAudioFrame (opens new window) + OnRawDataAudioFrame (opens new window) 获取采集和播放语音混音后的数据。

# 原始视频数据

声网 阿里 描述 对齐
registerVideoFrameObserver (opens new window) RegisterVideoSampleObserver (opens new window) / UnRegisterVideoSampleObserver (opens new window)RegisterLocalVideoTextureObserver (opens new window) /UnRegisterLocalVideoTextureObserver (opens new window) 注册视频观测器对象。
事件 描述
getObservedFramePosition (opens new window) GetObservedFramePosition (opens new window) 设置视频观测位置。
onCaptureVideoFrame (opens new window) OnCaptureVideoSample (opens new window) 获取本地摄像头采集到的视频数据。
onPreEncodeVideoFrame (opens new window) OnPreEncodeVideoSample (opens new window) 获取本地编码前的视频数据。
getSmoothRenderingEnabled (opens new window) rtc2.4 适配 设置获取的视频帧是否平滑输出。
onRenderVideoFrame (opens new window) OnRemoteVideoSample (opens new window) 获取远端发送的视频数据。
getVideoFormatPreference (opens new window) GetVideoFormatPreference (opens new window) 请求视频数据格式。
getRotationApplied (opens new window) 设置视频数据旋转。
getMirrorApplied (opens new window) 设置视频数据镜像。

# 媒体附属信息

声网 阿里 描述 对齐
registerMediaMetadataObserver (opens new window) SendMediaExtensionMsg (opens new window)(替代实现) 注册媒体 Metadata 观测器。
事件 描述
getMaxMetadataSize (opens new window) 请求最大的 Metadata 大小回调。
onReadyToSendMetadata (opens new window) 发送端已准备好发送 Metadata 回调。
onMetadataReceived (opens new window) 接收端已收到 Metadata 回调。

# 直播水印

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

# 加密

声网 阿里 描述 对齐
enableEncryption --- 开启/关闭内置加密。
registerPacketObserver -- 注册数据包观测器。

# 音频采集

声网 阿里 描述 对齐
startAudioRecording (opens new window) StartRecord (opens new window) 开始客户端录音。
stopAudioRecording (opens new window) StopRecord (opens new window) 停止客户端录音。

# 摄像头控制

声网 阿里 描述 对齐
switchCamera (opens new window) SwitchCamera (opens new window) 切换前置/后置摄像头(仅适用于 Android 和 iOS)。
事件 描述
onCameraFocusAreaChanged (opens new window) -- 摄像头对焦区域已改变回调。
onCameraExposureAreaChanged (opens new window) -- 摄像头曝光区域已改变回调。

# 设备管理

声网 阿里 描述 对齐
enumeratePlaybackDevices (opens new window) GetAudioPlayerList (opens new window) 获取系统中所有的播放设备。
enumerateRecordingDevices (opens new window) GetAudioCaptureList (opens new window) 获取系统中所有的音频采集设备。
setPlaybackDevice (opens new window) SetCurrentAudioPlayerName (opens new window) / SetCurrentAudioPlayerID (opens new window) 指定播放设备。
setRecordingDevice (opens new window) SetCurrentAudioCaptureName (opens new window) / SetCurrentAudioCaptureID (opens new window) 指定音频采集设备。
startPlaybackDeviceTest (opens new window) StartTestAudioPlayoutByName (opens new window) / StartTestAudioPlayoutById (opens new window) 启动音频播放设备测试(仅适用于 Windows 和 macOS)。
stopPlaybackDeviceTest (opens new window) StopTestAudioPlayout (opens new window) 停止播放设备测试。
startRecordingDeviceTest (opens new window) StartTestAudioRecordByName (opens new window) / StartTestAudioRecordById (opens new window) 启动音频采集设备测试(仅适用于 Windows 和 macOS)。
stopRecordingDeviceTest (opens new window) StopTestAudioRecord (opens new window) 停止音频采集设备测试。
startAudioDeviceLoopbackTest (opens new window) StartTestAudioPlayoutById (opens new window)StartTestAudioRecordById (opens new window) 已包含改逻辑。 开始音频设备回路测试(仅适用于 Windows 和 macOS)。 已有实现,无需对齐
stopAudioDeviceLoopbackTest (opens new window) StopTestAudioPlayout (opens new window)StopTestAudioRecord (opens new window) 停止音频设备回路测试。 已有实现,无需对齐
setPlaybackDeviceVolume (opens new window) SetPlaybackDeviceVolume (opens new window) 设置播放设备音量。
getPlaybackDeviceVolume (opens new window) GetPlaybackDeviceVolume (opens new window) 获取播放设备音量。
setRecordingDeviceVolume (opens new window) SetRecordingDeviceVolume (opens new window) 设置音频采集设备音量。
getRecordingDeviceVolume (opens new window) GetRecordingDeviceVolume (opens new window) 获取音频采集设备音量。
setPlaybackDeviceMute (opens new window) (opens new window) 静音播放设备。
isApplicationMute (opens new window) 获取 App 当前的静音状态。
getPlaybackDeviceMute (opens new window) 获取播放设备静音状态。
setRecordingDeviceMute (opens new window) MuteLocalMic (opens new window) 静音音频采集设备。
getRecordingDeviceMute (opens new window) 获取音频采集设备静音状态。
enumerateVideoDevices (opens new window) GetCameraList (opens new window) 获取系统中所有的视频设备列表。
startDeviceTest (opens new window) SetLocalViewConfig (opens new window) + StartPreview (opens new window) 启动视频采集设备测试。
stopDeviceTest (opens new window) StopPreview (opens new window) 停止视频采集设备测试。
getCount (opens new window) AliEngineDeviceInfoList::GetCount 获取系统中被索引的视频采集或播放设备的总数。
getDevice (opens new window) AliEngineDeviceInfoList::GetDeviceInfo 获取某个被索引的视频采集设备的指定信息。
setDevice (opens new window) SetCurrentCameraName (opens new window) / SetCurrentCameraID (opens new window) 指定设备。
事件 描述
onAudioDeviceStateChanged (opens new window) OnAudioDeviceStateChanged (opens new window) 音频设备变化回调。
onAudioDeviceVolumeChanged (opens new window) OnAudioDeviceRecordLevel (opens new window) / OnAudioDevicePlayoutLevel (opens new window) /
OnAudioDevicePlayoutEnd (opens new window) 回放、音频采集设备或 App 的音量发生改变。
onVideoDeviceStateChanged (opens new window) OnVideoDeviceStateChanged (opens new window) 视频设备变化回调。

# 流消息

声网 阿里 描述 对齐
createDataStream (opens new window) SendMediaExtensionMsg (opens new window) 创建数据流。
sendStreamMessage (opens new window) 发送数据流。
事件 描述
onStreamMessage (opens new window) OnMediaExtensionMsgReceived (opens new window) 接收到对方数据流消息回调。
onStreamMessageError (opens new window) -- 接收对方数据流消息发生错误回调。

# 其他音频控制

声网 阿里 描述 对齐
enableLoopbackRecording (opens new window) 开启声卡采集(仅适用于 macOS 和 Windows)。
setAudioSessionOperationRestriction (opens new window) SetAudioSessionOperationRestriction (opens new window) 设置 SDK 对 Audio Session 的控制权限(仅适用于 iOS)。

# 其他视频控制

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

# 其他方法

声网 阿里 描述 对齐
setCloudProxy (opens new window) -- 设置 Agora 云代理服务。
enableDeepLearningDenoise (opens new window) StartIntelligentDenoise (opens new window) / StopIntelligentDenoise (opens new window) 开启/关闭 AI 降噪模式。
sendCustomReportMessage (opens new window) 自定义数据上报。
getCallId (opens new window) -- 获取通话 ID。
rate (opens new window) -- 给通话评分。
complain (opens new window) PostFeedback (opens new window) 投诉通话质量。
getVersion (opens new window) GetSDKVersion (opens new window) 查询 SDK 版本号。
getErrorDescription (opens new window) GetErrorDescription (opens new window) 获取警告或错误描述。
queryInterface (opens new window) QueryInterface (opens new window) 获取设备管理员对象的指针。
其他事件
事件 描述
onWarning (opens new window) OnOccurWarning (opens new window) 发生警告回调。
onError (opens new window) OnOccurError (opens new window) 发生错误回调。
onApiCallExecuted (opens new window) -- API 方法已执行回调。

剩余的未在文档中出现的阿里接口与回调单独整理成2个表格,

# 剩余阿里接口

对应的声网接口 阿里接口 描述 对齐
setLogFile (opens new window) SetLogDirPath (opens new window) 设置SDK日志文件保存路径。 对齐
- UploadLog (opens new window) 上传日志。 声网未对齐
- GetClientRole (opens new window) 获取用户角色 声网未对齐
- RefreshAuthInfo (opens new window) 刷新鉴权信息。 声网未对齐
muteLocalVideoStream (opens new window) MuteLocalCamera (opens new window) 停止或恢复本地视频数据发送。 -
- SetScreenShareEncoderConfiguration (opens new window) 设置屏幕共享编码属性。 声网未对齐
muteRemoteAudioStream (opens new window) MuteRemoteAudio (opens new window) 停止或恢复远端的音频播放。 -
muteAllRemoteAudioStreams (opens new window) MuteAllRemoteAudio (opens new window) 停止或恢复远端所有的音频播放。 -
- IsLocalVideoStreamPublished (opens new window) 查询当前是否允许发布视频流。 声网未对齐
- IsScreenSharePublished (opens new window) 查询当前是否允许发布屏幕流。 声网未对齐
- IsLocalAudioStreamPublished (opens new window) 查询当前是否允许推音频流。 声网未对齐
- IsDualStreamPublished (opens new window) 查询当前是否允许发布次要视频流。 声网未对齐
- GetOnlineRemoteUsers (opens new window) 获取远端在线用户列表。 声网未对齐
- IsUserOnline (opens new window) 查询用户是否在线。 声网未对齐
- StartAudioPlayer (opens new window) 开启音频播放设备。 声网未对齐
- StopAudioPlayer (opens new window) 关闭音频播放。 声网未对齐
- EnableAudioDTX (opens new window) 开启本地音频流量控制(语音)。 声网未对齐
- EnableAudioAMD (opens new window) 开启本地音频流量控制(麦克风)。 声网未对齐
setLogFilter (opens new window) SetLogLevel (opens new window) 设置日志级别。 -
- IsCameraOn (opens new window) 检查摄像头是否打开。 声网未对齐
- IsInCall (opens new window) 检查当前是否在频道中 声网未对齐
getUserInfoByUid (opens new window) GetUserInfo (opens new window) 查询远端用户信息。 -
- SetH5CompatibleMode (opens new window) 设置H5兼容模式。 声网未对齐
- GetH5CompatibleMode (opens new window) 检查是否设置了H5兼容模式。 声网未对齐
- SetMixedWithMic (opens new window) 设置是否与麦克风采集音频混合。 声网未对齐
- SnapshotVideo (opens new window) 截图。 声网未对齐
- StartLiveStreaming (opens new window) 开始直播拉流。 声网未对齐
- StopLiveStreaming (opens new window) 停止直播拉流。 声网未对齐
- SetLiveStreamingViewConfig (opens new window) 设置直播拉流窗口及渲染参数。 声网未对齐
UpdateLiveStreamingViewConfig (opens new window) 更新直播拉流窗口及渲染参数。 声网未对齐
destroy (opens new window)() DestroyChannel (opens new window) 销毁createChannel (opens new window)创建的子频道。 -
- SetDeviceOrientationMode (opens new window) 设置设备方向。 声网未对齐
- MuteAllRemoteVideo (opens new window) 停止或恢复远端所有的视频渲染。 ​声网未对齐
- SetAudioEffectPublishVolume (opens new window) 设置音效推流音量。 声网未对齐
GetAudioEffectPublishVolume (opens new window) 获取推流音效音量。 声网未对齐
- RegisterLocalVideoTextureObserver (opens new window) 订阅本地视频纹理数据。 声网未对齐
- UnRegisterLocalVideoTextureObserver (opens new window) 取消本地视频纹理数据输出 声网未对齐
disableVideo (opens new window) SetAudioOnlyMode (opens new window) 设置为纯音频模式还是音视频模式。
IsAudioOnlyMode (opens new window) 查询当前是否为纯音频模式。 声网未对齐
GetEncodeParam (opens new window) 获取编码分辨率 声网未对齐

# 剩余阿里事件

对应的声网事件 阿里事件 描述 对齐
OnDualStreamPublishStateChanged (opens new window) 次要流推流变更回调。 声网未对齐
OnScreenSharePublishStateChanged (opens new window) 屏幕分享推流变更回调。 声网未对齐
onScreenShareSubscribeStateChanged (opens new window) 屏幕分享流订阅情况变更回调。 声网未对齐
OnTryToReconnect (opens new window) 尝试网络重连回调。 声网未对齐
OnConnectionRecovery (opens new window) 网络重连成功回调。 声网未对齐
OnBye (opens new window) 被服务器踢出或者频道关闭时回调。 声网未对齐
OnPerformanceLow (opens new window) 当前设备性能不足回调。 声网未对齐
OnPerformanceRecovery (opens new window) 当前设备性能恢复回调。 声网未对齐
OnFirstAudioPacketReceived (opens new window) 音频首包数据接收成功。 声网未对齐
onFirstVideoPacketReceived (opens new window) 视频首包数据接收成功。 声网未对齐
OnFirstRemoteAudioDecoded (opens new window) 已解码远端音频首帧回调。 声网未对齐
OnMediaRecordEvent (opens new window) 文件录制回调事件。 声网未对齐
OnSnapshotComplete (opens new window) 截图回调。 声网未对齐
OnUserVideoEnabled (opens new window) 禁用或重新启用本地视频采集的通知通知。 声网未对齐
OnUserAudioInterruptedBegin (opens new window) 用户audio被中断通知(一般用户打电话等音频被抢占场景) 声网未对齐
OnUserAudioInterruptedEnded (opens new window) 用户audio中断结束通知(对应OnUserAudioInterruptedBegin (opens new window))。 声网未对齐
OnUserWillResignActive (opens new window) 远端用户应用退到后台的回调 声网未对齐
OnUserWillBecomeActive (opens new window) 远端用户应用返回前台的回调。 声网未对齐
OnTextureCreate (opens new window) 订阅本地视频Texture创建回调( 声网未对齐
OnTextureUpdate (opens new window) 订阅本地视频Texture绘制回调。 声网未对齐
OnTextureDestory (opens new window) 订阅本地视频Texture销毁回调。 声网未对齐
OnStartLiveStreamingResult (opens new window) 低延迟互动直播拉流回调。 声网未对齐
OnSubscribeStreamTypeChanged (opens new window) 相机大小流情况变更回调。 声网未对齐
OnFirstAudioPacketSend (opens new window) 音频首包发送回调。 声网未对齐
OnUserAudioMuted (opens new window) 对端用户停止音频数据发送的通知。 声网未对齐
OnUserVideoMuted (opens new window) 对端用户发送视频黑帧数据发送的通知。 声网未对齐