# 声网3.4.1与阿里2.1接口对比
# Android端
- 此文档中声网接口与回调总数为:227个。阿里对齐149个,未对齐78个,对齐比例为:65.6%
# 核心方法
# 核心事件
# 音频管理
# 视频管理
# 本地媒体事件
# 远端媒体事件
声网回调 | 阿里回调 | 描述 | 对齐 |
---|---|---|---|
onRemoteAudioStateChanged (opens new window) | 远端用户音频状态已改变回调 | 否 | |
onRemoteVideoStateChanged (opens new window) | 远端用户视频状态已变化回调 | 否 | |
onFirstRemoteVideoFrame (opens new window) | onFirstRemoteVideoFrameDrawn (opens new window) | 已显示远端视频首帧回调 | 是 |
onAudioSubscribeStateChanged (opens new window) | onAudioSubscribeStateChanged (opens new window) | 音频订阅状态改变回调 | 是 |
onVideoSubscribeStateChanged (opens new window) | onVideoSubscribeStateChanged (opens new window) | 视频订阅状态改变回调 | 是 |
数据统计事件
声网回调 | 阿里回调 | 描述 | 对齐 |
---|---|---|---|
onRtcStats (opens new window) | onAliRtcStats (opens new window) | 当前通话统计回调 | 是 |
onNetworkQuality (opens new window) | onNetworkQualityChanged (opens new window) | 网络上下行质量报告回调 | 是 |
onLocalAudioStats (opens new window) | onRtcLocalAudioStats (opens new window) | 通话中本地音频流统计信息回调 | 是 |
onLocalVideoStats (opens new window) | onRtcLocalVideoStats (opens new window) | 通话中本地视频流统计信息回调 | 是 |
onRemoteAudioStats (opens new window) | onRtcRemoteAudioStats (opens new window) | 通话中远端音频流的统计信息回调 | 是 |
onRemoteVideoStats (opens new window) | onRtcRemoteVideoStats (opens new window) | 通话中远端视频流统计信息回调 | 是 |
# 视频前处理及后处理
声网接口 | 阿里接口 | 描述 | 对齐 |
---|---|---|---|
setBeautyEffectOptions (opens new window) | setBeautyEffect (opens new window) | 设置美颜效果选项 | 是 |
多频道管理
声网接口 | 阿里接口 | 描述 | 对齐 |
---|---|---|---|
createRtcChannel (opens new window) | createChannel (opens new window) | 创建并获取一个 RtcChannel 对象。通过创建多个对象,用户可以同时加入多个频道。 (opens new window) | 是 |
RtcChannel (opens new window) | AliRtcEngine | 提供在指定频道内实现实时音视频功能的方法。 | 是 |
IRtcChannelEventHandler (opens new window) | AliRtcEngineEventListener + AliRtcEngineNotify (opens new window) | 提供监听指定频道事件和数据的回调。 | 是 |
# 音乐文件播放及混音
# 音效文件播放管理
# 人声效果
声网接口 | 阿里接口 | 描述 | 对齐 |
---|---|---|---|
setAudioEffectPreset (opens new window) | 设置 SDK 预设的人声音效 | 否 | |
setVoiceBeautifierPreset (opens new window) | 设置 SDK 预设的美声效果 | 否 | |
setVoiceBeautifierParameters (opens new window) | 设置 SDK 预设美声效果的参数 | 否 | |
setAudioEffectParameters (opens new window) | 设置 SDK 预设人声音效的参数 | 否 | |
setLocalVoicePitch (opens new window) | setAudioEffectPitchValue (opens new window) | 设置本地语音音调 | 是 |
setLocalVoiceEqualization (opens new window) | 设置本地语音音效均衡 | ||
setLocalVoiceReverb (opens new window) | setAudioEffectReverbParamType (opens new window) | 设置本地音效混响 | 是 |
setVoiceConversionPreset (opens new window) | setAudioEffectVoiceChangerMode (opens new window) | 设置 SDK 预设的变声效果 | 是 |
# 听声辨位
声网接口 | 阿里接口 | 描述 | 对齐 |
---|---|---|---|
enableSoundPositionIndication (opens new window) | 开启/关闭远端用户的语音立体声 | 否 | |
setRemoteVoicePosition (opens new window) | 设置远端用户的语音位置 | 否 |
# CDN 推流
# 跨频道媒体流转发
声网接口 | 阿里接口 | 描述 | 对齐 |
---|---|---|---|
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) | onAudioVolume (opens new window) | 提示频道内谁正在说话及说话者音量的回调 | 是 |
onActiveSpeaker (opens new window) | onActiveSpeaker (opens new window) | 监测到最活跃用户回调 | 是 |
# 人脸检测
声网接口 | 阿里接口 | 描述 | 对齐 |
---|---|---|---|
enableFaceDetection (opens new window) | 开启/关闭本地人脸检测 | 否 | |
事件 | 描述 | ||
onFacePositionChanged (opens new window) | 报告本地人脸检测结果 | 否 |
# 语音播放路由
声网接口 | 阿里接口 | 描述 | 对齐 |
---|---|---|---|
setDefaultAudioRoutetoSpeakerphone (opens new window) | 设置默认的音频播放路由 | 否 | |
setEnableSpeakerphone (opens new window) | enableSpeakerphone (opens new window) | 启用/关闭扬声器播放 | 是 |
isSpeakerphoneEnabled (opens new window) | isSpeakerOn (opens new window) | 查询扬声器启用状态 | 是 |
事件 | 描述 | ||
onAudioRouteChanged (opens new window) | onAudioRouteChanged (opens new window) | 语音路由已改变回调 | 是 |
# 耳返控制
声网接口 | 阿里接口 | 描述 | 对齐 |
---|---|---|---|
enableInEarMonitoring (opens new window) | enableEarBack (opens new window) | 开启耳返功能 | 是 |
setInEarMonitoringVolume (opens new window) | setEarBackVolume (opens new window) | 设置耳返音量 | 是 |
# 视频双流模式
# 音视频回退
声网接口 | 阿里接口 | 描述 | 对齐 |
---|---|---|---|
setLocalPublishFallbackOption (opens new window) | 设置弱网条件下发布的音视频流回退选项 | 否 | |
setRemoteSubscribeFallbackOption (opens new window) | 设置弱网条件下订阅的音视频流回退选项 | 否 | |
setRemoteUserPriority (opens new window) | 设置用户媒体流优先级 | 否 | |
事件 | 描述 | ||
onLocalPublishFallbackToAudioOnly (opens new window) | 本地发布流已回退为音频流或恢复为音视频流回调 | 否 | |
onRemoteSubscribeFallbackToAudioOnly (opens new window) | 远端订阅流已回退为音频流或恢复为音视频流回调 | 否 |
# 通话前网络测试
声网接口 | 阿里接口 | 描述 | 对齐 |
---|---|---|---|
startEchoTest[1/2] (opens new window) | 开始语音通话回路测试 | 否 | |
stopEchoTest (opens new window) | 停止语音通话回路测试 | 否 | |
enableLastmileTest (opens new window) | startNetworkQualityProbeTest (opens new window) | 启用网络测试 | 是 |
disableLastmileTest (opens new window) | stopNetworkQualityProbeTest (opens new window) | 关闭网络测试 | 是 |
startLastmileProbeTest (opens new window) | 开始通话前网络质量探测 | 否 | |
stopLastmileProbeTest (opens new window) | 停止通话前网络质量探测 | 否 | |
事件 | 描述 | ||
onLastmileQuality (opens new window) | onNetworkQualityProbeTest (opens new window) | 本地网络质量报告回调 | 是 |
onLastmileProbeResult (opens new window) | 本地网络上下行 Last-mile 质量报告回调 | 否 |
# 自定义视频模块
声网接口 | 阿里接口 | 描述 | 对齐 |
---|---|---|---|
setVideoSource (opens new window) | 设置自定义视频源 | 否 | |
setLocalVideoRenderer (opens new window) | 自定义本地视频渲染器 | 否 | |
setRemoteVideoRenderer (opens new window) | 自定义远端视频渲染器 | 否 |
# 视频自采集(仅适用于 Push 模式)
声网接口 | 阿里接口 | 描述 | 对齐 |
---|---|---|---|
setExternalVideoSource (opens new window) | setExternalVideoSource (opens new window) | 配置外部视频源 | 是 |
pushExternalVideoFrame (opens new window) | pushExternalVideoFrame (opens new window) | 推送外部视频帧 | 是 |
isTextureEncodeSupported (opens new window) | 检查视频是否支持 Texture 编码 | 否 |
# 音频自采集(仅适用于 Push 模式)
# 音频自渲染
声网接口 | 阿里接口 | 描述 | 对齐 |
---|---|---|---|
setExternalAudioSink (opens new window) | setExternalAudioSource (opens new window) | 设置外部音频渲染 | 是 |
pullPlaybackAudioFrame (opens new window) | 拉取外部音频数据 | 否 |
# 原始音频数据
声网接口 | 阿里接口 | 描述 | 对齐 |
---|---|---|---|
registerAudioFrameObserver (opens new window) | registerAudioObserver (opens new window) | 注册语音观测器对象 | 是 |
setRecordingAudioFrameParameters (opens new window) | 设置采集的音频格式 | 否 | |
setPlaybackAudioFrameParameters (opens new window) | 设置播放的声音的格式 | 否 | |
setMixedAudioFrameParameters (opens new window) | 设置采集与播放声音混音后的数据格式 | 否 | |
事件 | 描述 | ||
onRecordFrame (opens new window) | onCaptureRawData (opens new window) | 获得采集的原始音频 | 是 |
onPlaybackFrame (opens new window) | 获得播放的原始音频 | 是 | |
onPlaybackFrameBeforeMixing (opens new window) | onCaptureRawData (opens new window) | 获取单个远端用户混音前的音频数据 | 是 |
onMixedFrame (opens new window) | onRenderData (opens new window) | 获取本地用户和所有远端用户混音后的原始音频数据 | |
isMultipleChannelFrameWanted (opens new window) | 设置是否获取多个频道的原始音频数据 | 否 | |
onPlaybackFrameBeforeMixingEx (opens new window) | onPlaybackAudioFrameBeforeMixing (opens new window) | 获取各频道单个远端用户混音前的音频播放数据 | 是 |
# 媒体附属信息
声网接口 | 阿里接口 | 描述 | 对齐 |
---|---|---|---|
registerMediaMetadataObserver (opens new window) | 注册媒体 Metadata 观测器 | 否 | |
事件 | 描述 | ||
getMaxMetadataSize (opens new window) | 请求 Metadata 的最大数据大小 | 否 | |
onReadyToSendMetadata (opens new window) | 发送端已准备好发送 Metadata | 否 | |
onMetadataReceived (opens new window) | 接收端已收到 Metadata | 否 |
# 直播水印
声网接口 | 阿里接口 | 描述 | 对齐 |
---|---|---|---|
addVideoWatermark[1/2] (opens new window) | addVideoWatermark (opens new window) | 添加本地视频水印 | 是 |
clearVideoWatermarks (opens new window) | clearVideoWatermark (opens new window) | 删除已添加的视频水印 | 是 |
# 加密
声网接口 | 阿里接口 | 描述 | 对齐 |
---|---|---|---|
enableEncryption (opens new window) | 开启/关闭内置加密 | 否 |
# 音频录制
声网接口 | 阿里接口 | 描述 | 对齐 |
---|---|---|---|
startAudioRecording[1/3] (opens new window) | startRecord (opens new window) | 开始客户端录音 | 是 |
stopAudioRecording (opens new window) | stopRecord (opens new window) | 停止客户端录音 | 是 |
# 摄像头控制
# 流消息
声网接口 | 阿里接口 | 描述 | 对齐 |
---|---|---|---|
createDataStream[1/2] (opens new window) | 创建数据流 | 否 | |
sendStreamMessage (opens new window) | 发送数据流 | 否 | |
事件 | 描述 | ||
onStreamMessage (opens new window) | 接收到对方数据流消息的回调 | 否 | |
onStreamMessageError (opens new window) | 接收对方数据流消息发生错误的回调 | 否 |
# 其他视频控制
声网接口 | 阿里接口 | 描述 | 对齐 |
---|---|---|---|
setLocalVideoMirrorMode (opens new window) | 设置本地视频镜像模式 | 否 | |
setCameraCapturerConfiguration (opens new window) | setCameraCapturerConfiguration (opens new window) | 设置摄像头的采集配置 | 是 |