需要访问旧版文档站？前往旧版文档官网首页。 (在新标签页打开)
声网文档中心

API 概览

  • HarmonyOS

更新时间不可用

声网通过全球部署的 SD-RTN™，提供可以灵活搭配的 API 组合，实现质量可靠的实时音视频通信。

初始化相关

方法/回调描述
createEngine创建并初始化 RtcEngine。
create创建并初始化 RtcEngine。
destroy销毁 RtcEngine 对象。
表格内容超出当前宽度，可横向滚动查看更多列。

频道相关

方法/回调描述
setChannelProfile设置频道场景。
joinChannel加入频道。
joinChannelWithOptions设置媒体选项并加入频道。
joinChannelEx加入频道。
updateChannelMediaOptions加入频道后更新频道媒体选项。
updateChannelMediaOptionsEx加入频道后更新频道媒体选项。
leaveChannel设置频道选项并离开频道。
leaveChannelEx设置频道选项并离开频道。
renewToken更新 Token。
setClientRole设置直播场景下的用户角色和观众端延时级别。
onJoinChannelSuccess成功加入频道回调。
onRejoinChannelSuccess成功重新加入频道回调。
onClientRoleChanged用户角色、观众端延时级别已切换回调。
onClientRoleChangeFailed用户角色切换失败回调。
onLeaveChannel离开频道回调。
onUserJoined远端用户（通信场景）/主播（直播场景）加入当前频道回调。
onUserOffline远端用户（通信场景）/主播（直播场景）离开当前频道回调。
onConnectionLost网络连接中断，且 SDK 无法在 10 秒内连接服务器回调。
onConnectionStateChanged网络连接状态已改变回调。
onRequestTokenToken 已过期回调。
onTokenPrivilegeWillExpireToken 即将在 30s 内过期回调。
onError发生错误回调。
表格内容超出当前宽度，可横向滚动查看更多列。

发布和订阅

方法/回调描述
muteLocalAudioStream取消或恢复发布本地音频流。
muteLocalAudioStreamEx取消或恢复发布本地音频流。
muteRemoteAudioStream取消或恢复订阅指定远端用户的音频流。
muteRemoteAudioStreamEx停止/恢复接收指定的音频流。
muteAllRemoteAudioStreams取消或恢复订阅所有远端用户的音频流。
muteAllRemoteAudioStreamsEx取消或恢复订阅所有远端用户的音频流。
muteLocalVideoStream取消或恢复发布本地视频流。
muteLocalVideoStreamEx取消或恢复发布本地视频流。
muteRemoteVideoStream取消或恢复订阅指定远端用户的视频流。
muteRemoteVideoStreamEx停止/恢复接收指定的视频流。
muteAllRemoteVideoStreams取消或恢复订阅所有远端用户的视频流。
muteAllRemoteVideoStreamsEx取消或恢复订阅所有远端用户的视频流。
onAudioPublishStateChanged音频发布状态改变回调。
onAudioSubscribeStateChanged音频订阅状态发生改变回调。
onVideoSubscribeStateChanged视频订阅状态发生改变回调。
表格内容超出当前宽度，可横向滚动查看更多列。

音频基础功能

方法/回调描述
adjustUserPlaybackSignalVolume调节本地播放的指定远端用户信号音量。
adjustUserPlaybackSignalVolumeEx调节本地播放的指定远端用户信号音量。
adjustPlaybackSignalVolume调节本地播放的所有远端用户信号音量。
enableAudio启用音频模块。
disableAudio关闭音频模块。
enableAudioVolumeIndication启用用户音量提示。
enableAudioVolumeIndicationEx

启用用户音量提示。

setAudioProfile设置音频编码属性。
setAudioScenario设置音频场景。
onAudioVolumeIndication用户音量提示回调。
onLocalAudioStateChanged本地音频状态发生改变回调。
onUserMuteAudio远端用户（通信场景）/主播（直播场景）停止或恢复发送音频流回调。
onRemoteAudioStateChanged远端音频流状态发生改变回调。
onLocalAudioStats通话中本地音频流的统计信息回调。
onRemoteAudioStats通话中远端音频流的统计信息回调。
表格内容超出当前宽度，可横向滚动查看更多列。

音频采集

方法/回调描述
enableLocalAudio开启或关闭本地音频采集。
adjustRecordingSignalVolume调节音频采集信号音量。
enableInEarMonitoring开启耳返功能。
setInEarMonitoringVolume设置耳返音量。
表格内容超出当前宽度，可横向滚动查看更多列。

自定义音频采集和渲染

方法/回调描述
createCustomAudioTrack创建一个自定义音频采集轨道。
destroyCustomAudioTrack销毁指定的音频轨道。
表格内容超出当前宽度，可横向滚动查看更多列。

视频基础功能

方法/回调描述
enableVideo启用视频模块。
disableVideo关闭视频模块。
setVideoEncoderConfiguration设置视频编码属性。
setVideoEncoderConfigurationEx设置视频编码属性。
startPreview开启视频预览并指定预览的视频源。
stopPreview停止视频预览。
onLocalVideoStateChanged本地视频状态发生改变回调。
onLocalVideoStats本地视频流统计信息回调。
onVideoPublishStateChanged视频发布状态改变回调。
onVideoSizeChanged本地或远端视频大小和旋转信息发生改变回调。
onRemoteVideoStateChanged远端视频状态发生改变回调。
onRemoteVideoStats通话中远端视频流的统计信息回调。
onFirstLocalVideoFrame已显示本地视频首帧回调。
onUserMuteVideo远端用户取消或恢复发布视频流回调。
onUserEnableVideo远端用户开/关视频模块回调。
表格内容超出当前宽度，可横向滚动查看更多列。

视频采集

方法/回调描述
enableLocalVideo开关本地视频采集。
startCameraCapture开始通过摄像头采集视频。
stopCameraCapture停止通过摄像头采集视频。
表格内容超出当前宽度，可横向滚动查看更多列。

屏幕共享

方法/回调描述
startScreenCapture开始屏幕采集。
updateScreenCaptureParameters更新屏幕采集的参数配置。
stopScreenCapture停止屏幕采集。
表格内容超出当前宽度，可横向滚动查看更多列。

视频前处理和后处理

方法/回调描述
enableContentInspect开启/关闭本地截图上传。
takeSnapshot获取视频截图。
enableVirtualBackground开启虚拟背景并指定媒体源，或关闭虚拟背景。
enableFaceDetection开启/关闭本地人脸检测。
onFacePositionChanged报告本地人脸检测结果。
onSnapshotTaken视频截图结果回调。
表格内容超出当前宽度，可横向滚动查看更多列。

视频编码功能

方法/回调描述
setDualStreamModeEx在发送端设置双流模式。
startLocalVideoTranscoder开启本地合图。
stopLocalVideoTranscoder停止本地合图。
updateLocalTranscoderConfiguration更新本地合图配置。
onLocalVideoTranscoderError本地合图发生错误回调。
表格内容超出当前宽度，可横向滚动查看更多列。

视频渲染

方法/回调描述
setLocalRenderMode更新本地视图显示模式。
setRemoteRenderMode更新远端视图显示模式。
setupLocalVideo初始化本地视图。
setupRemoteVideo初始化远端用户视图。
setupRemoteVideoEx初始化远端用户视图。
表格内容超出当前宽度，可横向滚动查看更多列。

自定义视频采集和渲染

方法/回调描述
createCustomVideoTrack创建一个自定义的视频轨道。
destroyCustomVideoTrack销毁指定的视频轨道。
setExternalVideoSource设置外部视频源。
pushExternalVideoFrameById将外部原始视频帧通过自定义视频轨道发布到频道中。
pushExternalVideoFrame推送外部原始视频帧到 SDK。
表格内容超出当前宽度，可横向滚动查看更多列。

音乐文件播放

方法/回调描述
startAudioMixing开始播放音乐文件。
stopAudioMixing停止播放音乐文件。
pauseAudioMixing暂停播放音乐文件。
resumeAudioMixing恢复播放音乐文件。
adjustAudioMixingVolume调节音乐文件的播放音量。
adjustAudioMixingPlayoutVolume调节音乐文件在本地播放的音量。
getAudioMixingDuration获取音乐文件总时长。
getAudioMixingCurrentPosition获取音乐文件的播放进度。
onAudioMixingStateChanged音乐文件的播放状态已改变回调。
onAudioMixingPositionChanged音乐文件播放进度回调。
表格内容超出当前宽度，可横向滚动查看更多列。

音效文件播放

方法/回调描述
playEffect播放指定的本地或在线音效文件。
stopEffect停止播放指定音效文件。
onAudioEffectFinished本地音效文件播放已结束回调。
表格内容超出当前宽度，可横向滚动查看更多列。

媒体播放器

更多有关媒体播放器的方法，详见内置媒体播放器。

方法/回调描述
createMediaPlayer创建媒体播放器对象。
IMediaPlayer提供媒体播放器功能的类，支持多实例。
IMediaPlayerObserver提供媒体播放器的回调。
表格内容超出当前宽度，可横向滚动查看更多列。

版权音乐

方法/回调描述
initialize初始化 IAgoraMusicContentCenter。
release释放音乐内容中心所占用的所有资源。
createMusicPlayer创建音乐播放器。
destroyMusicPlayer销毁音乐播放器对象。
preload预加载音乐资源。
isPreloaded检测音乐资源是否已被预加载。
open通过音乐资源编号打开音乐资源。
registerEventHandler注册音乐内容中心回调事件。
unregisterEventHandler取消注册音乐内容中心事件回调。
renewToken更新 Token。
getCaches获取已缓存的音乐资源信息。
removeCache删除已缓存的音乐资源。
getMusicCharts获取全部音乐榜单。
getMusicCollectionByMusicChartId通过音乐榜单的 ID 获取指定榜单的音乐资源列表。
searchMusic搜索音乐资源。
setPlayMode设置音乐资源的播放模式。
searchMusic搜索音乐资源。
renewToken更新 Token。
getLyric获取音乐资源的歌词下载地址。
getInternalSongCode创建音乐资源的副歌片段编号。
getSongSimpleInfo获取某一音乐资源的详细信息。
onPreLoadEvent报告预加载音乐资源的事件。
onLyricResult歌词下载地址回调。
onMusicChartsResult获取音乐榜单回调。
onMusicCollectionResult获取音乐资源列表回调。
onSongSimpleInfoResult音乐资源的详细信息回调。
表格内容超出当前宽度，可横向滚动查看更多列。

音视频录制

方法/回调描述
createMediaRecorder创建音视频录制对象。
setMediaRecorderObserver注册 IMediaRecorderCallback 观测器。
startRecording开启音视频流录制。
stopRecording停止音视频流录制。
startAudioRecording开始客户端录音。
startAudioRecordingWithConfiguration开始客户端录音并进行录音配置。
stopAudioRecording停止客户端录音。
destroyMediaRecorder销毁音视频录制对象。
onRecorderStateChanged录制状态发生改变回调。
onRecorderInfoUpdated录制信息更新回调。
表格内容超出当前宽度，可横向滚动查看更多列。

跨频道媒体流转发

方法/回调描述
startOrUpdateChannelMediaRelay开始或更新跨频道媒体流转发。
startOrUpdateChannelMediaRelayEx开始或更新跨频道媒体流转发。
stopChannelMediaRelay停止跨频道媒体流转发。一旦停止，主播会退出所有目标频道。
pauseAllChannelMediaRelay暂停向所有目标频道转发媒体流。
resumeAllChannelMediaRelay恢复向所有目标频道转发媒体流。
表格内容超出当前宽度，可横向滚动查看更多列。

旁路推流

方法/回调描述
startRtmpStreamWithTranscoding开始旁路推流并设置转码属性。
updateRtmpTranscoding更新旁路推流转码属性。
stopRtmpStream结束旁路推流。
onRtmpStreamingEvent旁路推流事件回调。
onRtmpStreamingStateChanged旁路推流状态发生改变回调。
onTranscodingUpdated旁路推流转码设置已被更新回调。
表格内容超出当前宽度，可横向滚动查看更多列。

数据流

方法/回调描述
createDataStream创建数据流。
createDataStreamEx创建数据流。
sendStreamMessage发送数据流。
onStreamMessage接收到对方数据流消息的回调。
onStreamMessageError接收对方数据流消息发生错误的回调。
表格内容超出当前宽度，可横向滚动查看更多列。

音频路由

方法/回调描述
setDefaultAudioRouteToSpeakerphone设置默认的音频路由。
setEnableSpeakerphone开启或关闭扬声器播放。
isSpeakerphoneEnabled检查扬声器状态启用状态。
表格内容超出当前宽度，可横向滚动查看更多列。

视频设备管理

方法/回调描述
switchCamera切换前置/后置摄像头。
setCameraCapturerConfiguration设置摄像头采集配置。
getCameraMaxZoomFactor获取摄像头支持最大缩放比例。
setCameraZoomFactor设置摄像头缩放比例。
isCameraFocusSupported检测设备是否支持手动对焦功能。
setCameraExposureFactor设置当前摄像头的曝光系数。
setCameraFocusPositionInPreview设置手动对焦位置，并触发对焦。
onCameraExposureAreaChanged摄像头曝光区域已改变回调。
表格内容超出当前宽度，可横向滚动查看更多列。

网络及其他

方法/回调描述
startLastmileProbeTest开始通话前网络质量探测。
stopLastmileProbeTest停止通话前网络质量探测。
onLastmileQuality网络上下行 last mile 质量报告回调。
onLastmileProbeResult通话前网络上下行 Last mile 质量探测报告回调。
getCurrentMonotonicTimeInMs获取 SDK 当前的 Monotonic Time。
setParametersSDK 的 JSON 配置信息，用于提供技术预览或特别定制功能。
getCallId获取通话 ID。
getCallIdEx使用连接 ID 获取通话 ID。
enableEncryption开启或关闭内置加密。
onEncryptionError内置加密出错回调。
onNetworkQuality通话中每个用户的网络上下行 last mile 质量报告回调。
onRtcStats当前通话相关的统计信息回调。
onPermissionError获取设备权限出错回调。
表格内容超出当前宽度，可横向滚动查看更多列。

咨询电话

400 632 6626

上海声网科技有限公司

Copyright © 2026 声网保留所有权利