# API 概览 (/zh-CN/api-reference/rtc/harmonyos/rtc-api-overview)

> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).

<a id="rtc_api_overview__initialize"></a>

## 初始化相关 [#初始化相关]

| 方法/回调 | 描述 |
| --- | --- |
| [createEngine](/zh-CN/api-reference/rtc/harmonyos/initialize#api_irtcengine_create) | 创建并初始化 [RtcEngine](/zh-CN/api-reference/rtc/harmonyos/rtc-interface-class#class_irtcengine)。 |
| [create](/zh-CN/api-reference/rtc/harmonyos/initialize#api_irtcengine_initialize) | 创建并初始化 RtcEngine。 |
| [destroy](/zh-CN/api-reference/rtc/harmonyos/initialize#api_irtcengine_release) | 销毁 RtcEngine 对象。 |

<a id="rtc_api_overview__channel"></a>

## 频道相关 [#频道相关]

| 方法/回调 | 描述 |
| --- | --- |
| [setChannelProfile](/zh-CN/api-reference/rtc/harmonyos/channel#api_irtcengine_setchannelprofile) | 设置频道场景。 |
| [joinChannel](/zh-CN/api-reference/rtc/harmonyos/channel#api_irtcengine_joinchannel) | 加入频道。 |
| [joinChannelWithOptions](/zh-CN/api-reference/rtc/harmonyos/channel#api_irtcengine_joinchannel2) | 设置媒体选项并加入频道。 |
| [joinChannelEx](/zh-CN/api-reference/rtc/harmonyos/channel#api_irtcengineex_joinchannelex) | 加入频道。 |
| [updateChannelMediaOptions](/zh-CN/api-reference/rtc/harmonyos/channel#api_irtcengine_updatechannelmediaoptions) | 加入频道后更新频道媒体选项。 |
| [updateChannelMediaOptionsEx](/zh-CN/api-reference/rtc/harmonyos/channel#api_irtcengineex_updatechannelmediaoptionsex) | 加入频道后更新频道媒体选项。 |
| [leaveChannel](/zh-CN/api-reference/rtc/harmonyos/channel#api_irtcengine_leavechannel2) | 设置频道选项并离开频道。 |
| [leaveChannelEx](/zh-CN/api-reference/rtc/harmonyos/channel#api_irtcengineex_leavechannelex2) | 设置频道选项并离开频道。 |
| [renewToken](/zh-CN/api-reference/rtc/harmonyos/channel#api_irtcengine_renewtoken) | 更新 Token。 |
| [setClientRole](/zh-CN/api-reference/rtc/harmonyos/channel#api_irtcengine_setclientrole2) | 设置直播场景下的用户角色和观众端延时级别。 |
| [onJoinChannelSuccess](/zh-CN/api-reference/rtc/harmonyos/channel#callback_irtcengineeventhandler_onjoinchannelsuccess) | 成功加入频道回调。 |
| [onRejoinChannelSuccess](/zh-CN/api-reference/rtc/harmonyos/channel#callback_irtcengineeventhandler_onrejoinchannelsuccess) | 成功重新加入频道回调。 |
| [onClientRoleChanged](/zh-CN/api-reference/rtc/harmonyos/channel#callback_irtcengineeventhandler_onclientrolechanged) | 用户角色、观众端延时级别已切换回调。 |
| [onClientRoleChangeFailed](/zh-CN/api-reference/rtc/harmonyos/channel#callback_irtcengineeventhandler_onclientrolechangefailed) | 用户角色切换失败回调。 |
| [onLeaveChannel](/zh-CN/api-reference/rtc/harmonyos/channel#callback_irtcengineeventhandler_onleavechannel) | 离开频道回调。 |
| [onUserJoined](/zh-CN/api-reference/rtc/harmonyos/channel#callback_irtcengineeventhandler_onuserjoined) | 远端用户（通信场景）/主播（直播场景）加入当前频道回调。 |
| [onUserOffline](/zh-CN/api-reference/rtc/harmonyos/channel#callback_irtcengineeventhandler_onuseroffline) | 远端用户（通信场景）/主播（直播场景）离开当前频道回调。 |
| [onConnectionLost](/zh-CN/api-reference/rtc/harmonyos/network#callback_irtcengineeventhandler_onconnectionlost) | 网络连接中断，且 SDK 无法在 10 秒内连接服务器回调。 |
| [onConnectionStateChanged](/zh-CN/api-reference/rtc/harmonyos/network#callback_irtcengineeventhandler_onconnectionstatechanged) | 网络连接状态已改变回调。 |
| [onRequestToken](/zh-CN/api-reference/rtc/harmonyos/channel#callback_irtcengineeventhandler_onrequesttoken) | Token 已过期回调。 |
| [onTokenPrivilegeWillExpire](/zh-CN/api-reference/rtc/harmonyos/channel#callback_irtcengineeventhandler_ontokenprivilegewillexpire) | Token 即将在 30s 内过期回调。 |
| [onError](/zh-CN/api-reference/rtc/harmonyos/channel#callback_irtcengineeventhandler_onerror) | 发生错误回调。 |

<a id="rtc_api_overview__publishnsubscribe"></a>

## 发布和订阅 [#发布和订阅]

| 方法/回调 | 描述 |
| --- | --- |
| [muteLocalAudioStream](/zh-CN/api-reference/rtc/harmonyos/publishnsubscribe#api_irtcengine_mutelocalaudiostream) | 取消或恢复发布本地音频流。 |
| [muteLocalAudioStreamEx](/zh-CN/api-reference/rtc/harmonyos/publishnsubscribe#api_irtcengineex_mutelocalaudiostreamex) | 取消或恢复发布本地音频流。 |
| [muteRemoteAudioStream](/zh-CN/api-reference/rtc/harmonyos/publishnsubscribe#api_irtcengine_muteremoteaudiostream) | 取消或恢复订阅指定远端用户的音频流。 |
| [muteRemoteAudioStreamEx](/zh-CN/api-reference/rtc/harmonyos/publishnsubscribe#api_irtcengineex_muteremoteaudiostreamex) | 停止/恢复接收指定的音频流。 |
| [muteAllRemoteAudioStreams](/zh-CN/api-reference/rtc/harmonyos/publishnsubscribe#api_irtcengine_muteallremoteaudiostreams) | 取消或恢复订阅所有远端用户的音频流。 |
| [muteAllRemoteAudioStreamsEx](/zh-CN/api-reference/rtc/harmonyos/publishnsubscribe#api_irtcengineex_muteallremoteaudiostreamsex) | 取消或恢复订阅所有远端用户的音频流。 |
| [muteLocalVideoStream](/zh-CN/api-reference/rtc/harmonyos/publishnsubscribe#api_irtcengine_mutelocalvideostream) | 取消或恢复发布本地视频流。 |
| [muteLocalVideoStreamEx](/zh-CN/api-reference/rtc/harmonyos/publishnsubscribe#api_irtcengineex_mutelocalvideostreamex) | 取消或恢复发布本地视频流。 |
| [muteRemoteVideoStream](/zh-CN/api-reference/rtc/harmonyos/publishnsubscribe#api_irtcengine_muteremotevideostream) | 取消或恢复订阅指定远端用户的视频流。 |
| [muteRemoteVideoStreamEx](/zh-CN/api-reference/rtc/harmonyos/publishnsubscribe#api_irtcengineex_muteremotevideostreamex) | 停止/恢复接收指定的视频流。 |
| [muteAllRemoteVideoStreams](/zh-CN/api-reference/rtc/harmonyos/publishnsubscribe#api_irtcengine_muteallremotevideostreams) | 取消或恢复订阅所有远端用户的视频流。 |
| [muteAllRemoteVideoStreamsEx](/zh-CN/api-reference/rtc/harmonyos/publishnsubscribe#api_irtcengineex_muteallremotevideostreamsex) | 取消或恢复订阅所有远端用户的视频流。 |
| [onAudioPublishStateChanged](/zh-CN/api-reference/rtc/harmonyos/publishnsubscribe#callback_irtcengineeventhandler_onaudiopublishstatechanged) | 音频发布状态改变回调。 |
| [onAudioSubscribeStateChanged](/zh-CN/api-reference/rtc/harmonyos/publishnsubscribe#callback_irtcengineeventhandler_onaudiosubscribestatechanged) | 音频订阅状态发生改变回调。 |
| [onVideoSubscribeStateChanged](/zh-CN/api-reference/rtc/harmonyos/publishnsubscribe#callback_irtcengineeventhandler_onvideosubscribestatechanged) | 视频订阅状态发生改变回调。 |

<a id="rtc_api_overview__audio_basic"></a>

## 音频基础功能 [#音频基础功能]

| 方法/回调 | 描述 |
| --- | --- |
| [adjustUserPlaybackSignalVolume](/zh-CN/api-reference/rtc/harmonyos/audio/audio-basic#api_irtcengine_adjustuserplaybacksignalvolume) | 调节本地播放的指定远端用户信号音量。 |
| [adjustUserPlaybackSignalVolumeEx](/zh-CN/api-reference/rtc/harmonyos/audio/audio-basic#api_irtcengineex_adjustuserplaybacksignalvolumeex) | 调节本地播放的指定远端用户信号音量。 |
| [adjustPlaybackSignalVolume](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#api_irtcengine_adjustplaybacksignalvolume) | 调节本地播放的所有远端用户信号音量。 |
| [enableAudio](/zh-CN/api-reference/rtc/harmonyos/audio/audio-basic#api_irtcengine_enableaudio) | 启用音频模块。 |
| [disableAudio](/zh-CN/api-reference/rtc/harmonyos/audio/audio-basic#api_irtcengine_disableaudio) | 关闭音频模块。 |
| [enableAudioVolumeIndication](/zh-CN/api-reference/rtc/harmonyos/audio/audio-basic#api_irtcengine_enableaudiovolumeindication) | 启用用户音量提示。 |
| [enableAudioVolumeIndicationEx](/zh-CN/api-reference/rtc/harmonyos/audio/audio-basic#api_irtcengineex_enableaudiovolumeindicationex) | [api-center-table-0 details](#table-slot-api-center-table-0) |
| [setAudioProfile](/zh-CN/api-reference/rtc/harmonyos/audio/audio-basic#api_irtcengine_setaudioprofile2) | 设置音频编码属性。 |
| [setAudioScenario](/zh-CN/api-reference/rtc/harmonyos/audio/audio-basic#api_irtcengine_setaudioscenario) | 设置音频场景。 |
| [onAudioVolumeIndication](/zh-CN/api-reference/rtc/harmonyos/audio/audio-basic#callback_irtcengineeventhandler_onaudiovolumeindication) | 用户音量提示回调。 |
| [onLocalAudioStateChanged](/zh-CN/api-reference/rtc/harmonyos/audio/audio-basic#callback_irtcengineeventhandler_onlocalaudiostatechanged) | 本地音频状态发生改变回调。 |
| [onUserMuteAudio](/zh-CN/api-reference/rtc/harmonyos/audio/audio-basic#callback_irtcengineeventhandler_onusermuteaudio) | 远端用户（通信场景）/主播（直播场景）停止或恢复发送音频流回调。 |
| [onRemoteAudioStateChanged](/zh-CN/api-reference/rtc/harmonyos/audio/audio-basic#callback_irtcengineeventhandler_onremoteaudiostatechanged) | 远端音频流状态发生改变回调。 |
| [onLocalAudioStats](/zh-CN/api-reference/rtc/harmonyos/audio/audio-basic#callback_irtcengineeventhandler_onlocalaudiostats) | 通话中本地音频流的统计信息回调。 |
| [onRemoteAudioStats](/zh-CN/api-reference/rtc/harmonyos/audio/audio-basic#callback_irtcengineeventhandler_onremoteaudiostats) | 通话中远端音频流的统计信息回调。 |

<a id="table-slot-api-center-table-0"></a>

**api-center-table-0 details**

启用用户音量提示。

<a id="rtc_api_overview__audio_capture"></a>

## 音频采集 [#音频采集]

| 方法/回调 | 描述 |
| --- | --- |
| [enableLocalAudio](/zh-CN/api-reference/rtc/harmonyos/audio/audio-capture#api_irtcengine_enablelocalaudio) | 开启或关闭本地音频采集。 |
| [adjustRecordingSignalVolume](/zh-CN/api-reference/rtc/harmonyos/audio/audio-capture#api_irtcengine_adjustrecordingsignalvolume) | 调节音频采集信号音量。 |
| [enableInEarMonitoring](/zh-CN/api-reference/rtc/harmonyos/audio/audio-capture#api_irtcengine_enableinearmonitoring2) | 开启耳返功能。 |
| [setInEarMonitoringVolume](/zh-CN/api-reference/rtc/harmonyos/audio/audio-capture#api_irtcengine_setinearmonitoringvolume) | 设置耳返音量。 |

<a id="rtc_api_overview__audio_custom_capturenrendering"></a>

## 自定义音频采集和渲染 [#自定义音频采集和渲染]

| 方法/回调 | 描述 |
| --- | --- |
| [createCustomAudioTrack](/zh-CN/api-reference/rtc/harmonyos/audio/audio-custom-capturenrendering#api_imediaengine_createcustomaudiotrack) | 创建一个自定义音频采集轨道。 |
| [destroyCustomAudioTrack](/zh-CN/api-reference/rtc/harmonyos/audio/audio-custom-capturenrendering#api_imediaengine_destroycustomaudiotrack) | 销毁指定的音频轨道。 |

<a id="rtc_api_overview__video_basic"></a>

## 视频基础功能 [#视频基础功能]

| 方法/回调 | 描述 |
| --- | --- |
| [enableVideo](/zh-CN/api-reference/rtc/harmonyos/video/video-basic#api_irtcengine_enablevideo) | 启用视频模块。 |
| [disableVideo](/zh-CN/api-reference/rtc/harmonyos/video/video-basic#api_irtcengine_disablevideo) | 关闭视频模块。 |
| [setVideoEncoderConfiguration](/zh-CN/api-reference/rtc/harmonyos/video/video-basic#api_irtcengine_setvideoencoderconfiguration) | 设置视频编码属性。 |
| [setVideoEncoderConfigurationEx](/zh-CN/api-reference/rtc/harmonyos/video/video-basic#api_irtcengineex_setvideoencoderconfigurationex) | 设置视频编码属性。 |
| [startPreview](/zh-CN/api-reference/rtc/harmonyos/video/video-basic#api_irtcengine_startpreview2) | 开启视频预览并指定预览的视频源。 |
| [stopPreview](/zh-CN/api-reference/rtc/harmonyos/video/video-basic#api_irtcengine_stoppreview2) | 停止视频预览。 |
| [onLocalVideoStateChanged](/zh-CN/api-reference/rtc/harmonyos/video/video-basic#callback_irtcengineeventhandler_onlocalvideostatechanged) | 本地视频状态发生改变回调。 |
| [onLocalVideoStats](/zh-CN/api-reference/rtc/harmonyos/video/video-basic#callback_irtcengineeventhandler_onlocalvideostats) | 本地视频流统计信息回调。 |
| [onVideoPublishStateChanged](/zh-CN/api-reference/rtc/harmonyos/video/video-basic#callback_irtcengineeventhandler_onvideopublishstatechanged) | 视频发布状态改变回调。 |
| [onVideoSizeChanged](/zh-CN/api-reference/rtc/harmonyos/video/video-basic#callback_irtcengineeventhandler_onvideosizechanged) | 本地或远端视频大小和旋转信息发生改变回调。 |
| [onRemoteVideoStateChanged](/zh-CN/api-reference/rtc/harmonyos/video/video-basic#callback_irtcengineeventhandler_onremotevideostatechanged) | 远端视频状态发生改变回调。 |
| [onRemoteVideoStats](/zh-CN/api-reference/rtc/harmonyos/video/video-basic#callback_irtcengineeventhandler_onremotevideostats) | 通话中远端视频流的统计信息回调。 |
| [onFirstLocalVideoFrame](/zh-CN/api-reference/rtc/harmonyos/video/video-basic#callback_irtcengineeventhandler_onfirstlocalvideoframe) | 已显示本地视频首帧回调。 |
| [onUserMuteVideo](/zh-CN/api-reference/rtc/harmonyos/video/video-basic#callback_irtcengineeventhandler_onusermutevideo) | 远端用户取消或恢复发布视频流回调。 |
| [onUserEnableVideo](/zh-CN/api-reference/rtc/harmonyos/video/video-basic#callback_irtcengineeventhandler_onuserenablevideo) | 远端用户开/关视频模块回调。 |

<a id="rtc_api_overview__video_capturing"></a>

## 视频采集 [#视频采集]

| 方法/回调 | 描述 |
| --- | --- |
| [enableLocalVideo](/zh-CN/api-reference/rtc/harmonyos/video/video-basic#api_irtcengine_enablelocalvideo) | 开关本地视频采集。 |
| [startCameraCapture](/zh-CN/api-reference/rtc/harmonyos/video/camera-capture#api_irtcengine_startcameracapture) | 开始通过摄像头采集视频。 |
| [stopCameraCapture](/zh-CN/api-reference/rtc/harmonyos/video/camera-capture#api_irtcengine_stopcameracapture) | 停止通过摄像头采集视频。 |

<a id="rtc_api_overview__screen_share"></a>

## 屏幕共享 [#屏幕共享]

| 方法/回调 | 描述 |
| --- | --- |
| [startScreenCapture](/zh-CN/api-reference/rtc/harmonyos/video/screencapture#api_irtcengine_startscreencapture) | 开始屏幕采集。 |
| [updateScreenCaptureParameters](/zh-CN/api-reference/rtc/harmonyos/video/screencapture#api_irtcengine_updatescreencaptureparameters) | 更新屏幕采集的参数配置。 |
| [stopScreenCapture](/zh-CN/api-reference/rtc/harmonyos/video/screencapture#api_irtcengine_stopscreencapture) | 停止屏幕采集。 |

<a id="rtc_api_overview__video_prenpost"></a>

## 视频前处理和后处理 [#视频前处理和后处理]

| 方法/回调 | 描述 |
| --- | --- |
| [enableContentInspect](/zh-CN/api-reference/rtc/harmonyos/video/video-prenpro/snapshot#api_irtcengine_enablecontentinspect) | 开启/关闭本地截图上传。 |
| [takeSnapshot](/zh-CN/api-reference/rtc/harmonyos/video/video-prenpro/snapshot#api_irtcengine_takesnapshot) | 获取视频截图。 |
| [enableVirtualBackground](/zh-CN/api-reference/rtc/harmonyos/video/video-prenpro/virtualbackground#api_irtcengine_enablevirtualbackground2) | 开启虚拟背景并指定媒体源，或关闭虚拟背景。 |
| [enableFaceDetection](/zh-CN/api-reference/rtc/harmonyos/video/video-prenpro/face-detection#api_irtcengine_enablefacedetection) | 开启/关闭本地人脸检测。 |
| [onFacePositionChanged](/zh-CN/api-reference/rtc/harmonyos/video/video-prenpro/face-detection#callback_irtcengineeventhandler_onfacepositionchanged) | 报告本地人脸检测结果。 |
| [onSnapshotTaken](/zh-CN/api-reference/rtc/harmonyos/video/video-prenpro/snapshot#callback_irtcengineeventhandler_onsnapshottaken) | 视频截图结果回调。 |

<a id="rtc_api_overview__video_encoding"></a>

## 视频编码功能 [#视频编码功能]

| 方法/回调 | 描述 |
| --- | --- |
| [setDualStreamModeEx](/zh-CN/api-reference/rtc/harmonyos/video/video-codec/dual-stream#api_irtcengineex_setdualstreammodeex) | 在发送端设置双流模式。 |
| [startLocalVideoTranscoder](/zh-CN/api-reference/rtc/harmonyos/video/video-codec/local-transcoder#api_irtcengine_startlocalvideotranscoder) | 开启本地合图。 |
| [stopLocalVideoTranscoder](/zh-CN/api-reference/rtc/harmonyos/video/video-codec/local-transcoder#api_irtcengine_stoplocalvideotranscoder) | 停止本地合图。 |
| [updateLocalTranscoderConfiguration](/zh-CN/api-reference/rtc/harmonyos/video/video-codec/local-transcoder#api_irtcengine_updatelocaltranscoderconfiguration) | 更新本地合图配置。 |
| [onLocalVideoTranscoderError](/zh-CN/api-reference/rtc/harmonyos/video/video-codec/local-transcoder#callback_irtcengineeventhandler_onlocalvideotranscodererror) | 本地合图发生错误回调。 |

<a id="rtc_api_overview__video_rendering"></a>

## 视频渲染 [#视频渲染]

| 方法/回调 | 描述 |
| --- | --- |
| [setLocalRenderMode](/zh-CN/api-reference/rtc/harmonyos/video/video-rendering#api_irtcengine_setlocalrendermode2) | 更新本地视图显示模式。 |
| [setRemoteRenderMode](/zh-CN/api-reference/rtc/harmonyos/video/video-rendering#api_irtcengine_setremoterendermode2) | 更新远端视图显示模式。 |
| [setupLocalVideo](/zh-CN/api-reference/rtc/harmonyos/video/video-rendering#api_irtcengine_setuplocalvideo) | 初始化本地视图。 |
| [setupRemoteVideo](/zh-CN/api-reference/rtc/harmonyos/video/video-rendering#api_irtcengine_setupremotevideo) | 初始化远端用户视图。 |
| [setupRemoteVideoEx](/zh-CN/api-reference/rtc/harmonyos/video/video-rendering#api_irtcengineex_setupremotevideoex) | 初始化远端用户视图。 |

<a id="rtc_api_overview__video_custom_capturenrendering"></a>

## 自定义视频采集和渲染 [#自定义视频采集和渲染]

| 方法/回调 | 描述 |
| --- | --- |
| [createCustomVideoTrack](/zh-CN/api-reference/rtc/harmonyos/video/video-custom-capturenrendering#api_irtcengine_createcustomvideotrack) | 创建一个自定义的视频轨道。 |
| [destroyCustomVideoTrack](/zh-CN/api-reference/rtc/harmonyos/video/video-custom-capturenrendering#api_irtcengine_destroycustomvideotrack) | 销毁指定的视频轨道。 |
| [setExternalVideoSource](/zh-CN/api-reference/rtc/harmonyos/video/video-custom-capturenrendering#api_imediaengine_setexternalvideosource) | 设置外部视频源。 |
| [pushExternalVideoFrameById](/zh-CN/api-reference/rtc/harmonyos/video/video-custom-capturenrendering#api_irtcengine_pushvideoframe3) | 将外部原始视频帧通过自定义视频轨道发布到频道中。 |
| [pushExternalVideoFrame](/zh-CN/api-reference/rtc/harmonyos/video/video-custom-capturenrendering#api_irtcengine_pushvideoframe4) | 推送外部原始视频帧到 SDK。 |

<a id="rtc_api_overview__audio_file_playback"></a>

## 音乐文件播放 [#音乐文件播放]

| 方法/回调 | 描述 |
| --- | --- |
| [startAudioMixing](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#api_irtcengine_startaudiomixing2) | 开始播放音乐文件。 |
| [stopAudioMixing](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#api_irtcengine_stopaudiomixing) | 停止播放音乐文件。 |
| [pauseAudioMixing](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#api_irtcengine_pauseaudiomixing) | 暂停播放音乐文件。 |
| [resumeAudioMixing](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#api_irtcengine_resumeaudiomixing) | 恢复播放音乐文件。 |
| [adjustAudioMixingVolume](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#api_irtcengine_adjustaudiomixingvolume) | 调节音乐文件的播放音量。 |
| [adjustAudioMixingPlayoutVolume](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#api_irtcengine_adjustaudiomixingplayoutvolume) | 调节音乐文件在本地播放的音量。 |
| [getAudioMixingDuration](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#api_irtcengine_getaudiomixingduration) | 获取音乐文件总时长。 |
| [getAudioMixingCurrentPosition](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#api_irtcengine_getaudiomixingcurrentposition) | 获取音乐文件的播放进度。 |
| [onAudioMixingStateChanged](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#callback_irtcengineeventhandler_onaudiomixingstatechanged) | 音乐文件的播放状态已改变回调。 |
| [onAudioMixingPositionChanged](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#callback_irtcengineeventhandler_onaudiomixingpositionchanged) | 音乐文件播放进度回调。 |

<a id="rtc_api_overview__audio_effect_playback"></a>

## 音效文件播放 [#音效文件播放]

| 方法/回调 | 描述 |
| --- | --- |
| [playEffect](/zh-CN/api-reference/rtc/harmonyos/play/audio-effect-file#api_irtcengine_playeffect3) | 播放指定的本地或在线音效文件。 |
| [stopEffect](/zh-CN/api-reference/rtc/harmonyos/play/audio-effect-file#api_irtcengine_stopeffect) | 停止播放指定音效文件。 |
| [onAudioEffectFinished](/zh-CN/api-reference/rtc/harmonyos/play/audio-effect-file#callback_irtcengineeventhandler_onaudioeffectfinished) | 本地音效文件播放已结束回调。 |

<a id="rtc_api_overview__media_player"></a>

## 媒体播放器 [#媒体播放器]

更多有关媒体播放器的方法，详见[内置媒体播放器](/zh-CN/api-reference/rtc/harmonyos/play/mediaplayer/mediaplayer-initialize)。

| 方法/回调 | 描述 |
| --- | --- |
| [createMediaPlayer](/zh-CN/api-reference/rtc/harmonyos/play/mediaplayer/mediaplayer-initialize#api_irtcengine_createmediaplayer) | 创建媒体播放器对象。 |
| [IMediaPlayer](/zh-CN/api-reference/rtc/harmonyos/rtc-interface-class#class_imediaplayer) | 提供媒体播放器功能的类，支持多实例。 |
| [IMediaPlayerObserver](/zh-CN/api-reference/rtc/harmonyos/rtc-interface-class#class_imediaplayersourceobserver) | 提供媒体播放器的回调。 |

<a id="rtc_api_overview__drm"></a>

## 版权音乐 [#版权音乐]

| 方法/回调 | 描述 |
| --- | --- |
| [initialize](/zh-CN/api-reference/rtc/harmonyos/play/drm#api_imusiccontentcenter_initialize) | 初始化 [IAgoraMusicContentCenter](/zh-CN/api-reference/rtc/harmonyos/rtc-interface-class#class_imusiccontentcenter)。 |
| [release](/zh-CN/api-reference/rtc/harmonyos/play/drm#api_imusiccontentcenter_release) | 释放音乐内容中心所占用的所有资源。 |
| [createMusicPlayer](/zh-CN/api-reference/rtc/harmonyos/play/drm#api_imusiccontentcenter_createmusicplayer) | 创建音乐播放器。 |
| [destroyMusicPlayer](/zh-CN/api-reference/rtc/harmonyos/play/drm#api_imusiccontentcenter_destroymusicplayer) | 销毁音乐播放器对象。 |
| [preload](/zh-CN/api-reference/rtc/harmonyos/play/drm#api_imusicontentcenter_preload2) | 预加载音乐资源。 |
| [isPreloaded](/zh-CN/api-reference/rtc/harmonyos/play/drm#api_imusiccontentcenter_ispreloaded) | 检测音乐资源是否已被预加载。 |
| [open](/zh-CN/api-reference/rtc/harmonyos/play/drm) | 通过音乐资源编号打开音乐资源。 |
| [registerEventHandler](/zh-CN/api-reference/rtc/harmonyos/play/drm#api_imusiccontentcenter_registereventhandler) | 注册音乐内容中心回调事件。 |
| [unregisterEventHandler](/zh-CN/api-reference/rtc/harmonyos/play/drm#api_imusiccontentcenter_unregistereventhandler) | 取消注册音乐内容中心事件回调。 |
| [renewToken](/zh-CN/api-reference/rtc/harmonyos/play/drm#api_imusiccontentcenter_renewtoken) | 更新 Token。 |
| [getCaches](/zh-CN/api-reference/rtc/harmonyos/play/drm#api_imusiccontentcenter_getcaches) | 获取已缓存的音乐资源信息。 |
| [removeCache](/zh-CN/api-reference/rtc/harmonyos/play/drm#api_imusiccontentcenter_removecache) | 删除已缓存的音乐资源。 |
| [getMusicCharts](/zh-CN/api-reference/rtc/harmonyos/play/drm#api_imusiccontentcenter_getmusiccharts) | 获取全部音乐榜单。 |
| [getMusicCollectionByMusicChartId](/zh-CN/api-reference/rtc/harmonyos/play/drm#api_imusiccontentcenter_getmusiccollectionbymusicchartid2) | 通过音乐榜单的 ID 获取指定榜单的音乐资源列表。 |
| [searchMusic](/zh-CN/api-reference/rtc/harmonyos/play/drm#api_imusiccontentcenter_searchmusic2) | 搜索音乐资源。 |
| [setPlayMode](/zh-CN/api-reference/rtc/harmonyos/play/drm#api_imusicplayer_setplaymode) | 设置音乐资源的播放模式。 |
| [searchMusic](/zh-CN/api-reference/rtc/harmonyos/play/drm#api_imusiccontentcenter_searchmusic2) | 搜索音乐资源。 |
| [renewToken](/zh-CN/api-reference/rtc/harmonyos/channel#api_irtcengine_renewtoken) | 更新 Token。 |
| [getLyric](/zh-CN/api-reference/rtc/harmonyos/play/drm#api_imusiccontentcenter_getlyric) | 获取音乐资源的歌词下载地址。 |
| [getInternalSongCode](/zh-CN/api-reference/rtc/harmonyos/play/drm#api_imusiccontentcenter_getinternalsongcode) | 创建音乐资源的副歌片段编号。 |
| [getSongSimpleInfo](/zh-CN/api-reference/rtc/harmonyos/play/drm#api_imusiccontentcenter_getsongsimpleinfo) | 获取某一音乐资源的详细信息。 |
| [onPreLoadEvent](/zh-CN/api-reference/rtc/harmonyos/play/drm#callback_imusiccontentcentereventhandler_onpreloadevent) | 报告预加载音乐资源的事件。 |
| [onLyricResult](/zh-CN/api-reference/rtc/harmonyos/play/drm#callback_imusiccontentcentereventhandler_onlyricresult) | 歌词下载地址回调。 |
| [onMusicChartsResult](/zh-CN/api-reference/rtc/harmonyos/play/drm#callback_imusiccontentcentereventhandler_onmusicchartsresult) | 获取音乐榜单回调。 |
| [onMusicCollectionResult](/zh-CN/api-reference/rtc/harmonyos/play/drm#callback_imusiccontentcentereventhandler_onmusiccollectionresult) | 获取音乐资源列表回调。 |
| [onSongSimpleInfoResult](/zh-CN/api-reference/rtc/harmonyos/play/drm#callback_imusiccontentcentereventhandler_onsongsimpleinforesult) | 音乐资源的详细信息回调。 |

<a id="rtc_api_overview__media_recorder"></a>

## 音视频录制 [#音视频录制]

| 方法/回调 | 描述 |
| --- | --- |
| [createMediaRecorder](/zh-CN/api-reference/rtc/harmonyos/recording#api_irtcengine_createmediarecorder) | 创建音视频录制对象。 |
| [setMediaRecorderObserver](/zh-CN/api-reference/rtc/harmonyos/recording#api_imediarecorder_setmediarecorderobserver) | 注册 [IMediaRecorderCallback](/zh-CN/api-reference/rtc/harmonyos/rtc-interface-class#class_imediarecorderobserver) 观测器。 |
| [startRecording](/zh-CN/api-reference/rtc/harmonyos/recording#api_imediarecorder_startrecording) | 开启音视频流录制。 |
| [stopRecording](/zh-CN/api-reference/rtc/harmonyos/recording#api_imediarecorder_stoprecording) | 停止音视频流录制。 |
| [startAudioRecording](/zh-CN/api-reference/rtc/harmonyos/recording#api_irtcengine_startaudiorecording) | 开始客户端录音。 |
| [startAudioRecordingWithConfiguration](/zh-CN/api-reference/rtc/harmonyos/recording#api_irtcengine_startaudiorecording3) | 开始客户端录音并进行录音配置。 |
| [stopAudioRecording](/zh-CN/api-reference/rtc/harmonyos/recording#api_irtcengine_stopaudiorecording) | 停止客户端录音。 |
| [destroyMediaRecorder](/zh-CN/api-reference/rtc/harmonyos/recording#api_irtcengine_destroymediarecorder) | 销毁音视频录制对象。 |
| [onRecorderStateChanged](/zh-CN/api-reference/rtc/harmonyos/recording#callback_imediarecorderobserver_onrecorderstatechanged) | 录制状态发生改变回调。 |
| [onRecorderInfoUpdated](/zh-CN/api-reference/rtc/harmonyos/recording#callback_imediarecorderobserver_onrecorderinfoupdated) | 录制信息更新回调。 |

<a id="rtc_api_overview__media_stream_relay_across_channels"></a>

## 跨频道媒体流转发 [#跨频道媒体流转发]

| 方法/回调 | 描述 |
| --- | --- |
| [startOrUpdateChannelMediaRelay](/zh-CN/api-reference/rtc/harmonyos/cloud-media-relay/channel-media-relay#api_irtcengine_startorupdatechannelmediarelay) | 开始或更新跨频道媒体流转发。 |
| [startOrUpdateChannelMediaRelayEx](/zh-CN/api-reference/rtc/harmonyos/cloud-media-relay/channel-media-relay#api_irtcengineex_startorupdatechannelmediarelayex) | 开始或更新跨频道媒体流转发。 |
| [stopChannelMediaRelay](/zh-CN/api-reference/rtc/harmonyos/cloud-media-relay/channel-media-relay#api_irtcengine_stopchannelmediarelay) | 停止跨频道媒体流转发。一旦停止，主播会退出所有目标频道。 |
| [pauseAllChannelMediaRelay](/zh-CN/api-reference/rtc/harmonyos/cloud-media-relay/channel-media-relay#api_irtcengine_pauseallchannelmediarelay) | 暂停向所有目标频道转发媒体流。 |
| [resumeAllChannelMediaRelay](/zh-CN/api-reference/rtc/harmonyos/cloud-media-relay/channel-media-relay#api_irtcengine_resumeallchannelmediarelay) | 恢复向所有目标频道转发媒体流。 |

<a id="rtc_api_overview__media_push"></a>

## 旁路推流 [#旁路推流]

| 方法/回调 | 描述 |
| --- | --- |
| [startRtmpStreamWithTranscoding](/zh-CN/api-reference/rtc/harmonyos/cloud-media-relay/media-push#api_irtcengine_startrtmpstreamwithtranscoding) | 开始旁路推流并设置转码属性。 |
| [updateRtmpTranscoding](/zh-CN/api-reference/rtc/harmonyos/cloud-media-relay/media-push#api_irtcengine_updatertmptranscoding) | 更新旁路推流转码属性。 |
| [stopRtmpStream](/zh-CN/api-reference/rtc/harmonyos/cloud-media-relay/media-push#api_irtcengine_stoprtmpstream) | 结束旁路推流。 |
| [onRtmpStreamingEvent](/zh-CN/api-reference/rtc/harmonyos/cloud-media-relay/media-push#callback_irtcengineeventhandler_onrtmpstreamingevent) | 旁路推流事件回调。 |
| [onRtmpStreamingStateChanged](/zh-CN/api-reference/rtc/harmonyos/cloud-media-relay/media-push#callback_irtcengineeventhandler_onrtmpstreamingstatechanged) | 旁路推流状态发生改变回调。 |
| [onTranscodingUpdated](/zh-CN/api-reference/rtc/harmonyos/cloud-media-relay/media-push#callback_irtcengineeventhandler_ontranscodingupdated) | 旁路推流转码设置已被更新回调。 |

<a id="rtc_api_overview__stream_message"></a>

## 数据流 [#数据流]

| 方法/回调 | 描述 |
| --- | --- |
| [createDataStream](/zh-CN/api-reference/rtc/harmonyos/metadata/datastream#api_irtcengine_createdatastream2) | 创建数据流。 |
| [createDataStreamEx](/zh-CN/api-reference/rtc/harmonyos/metadata/datastream#api_irtcengineex_createdatastreamex2) | 创建数据流。 |
| [sendStreamMessage](/zh-CN/api-reference/rtc/harmonyos/metadata/datastream#api_irtcengine_sendstreammessage) | 发送数据流。 |
| [onStreamMessage](/zh-CN/api-reference/rtc/harmonyos/metadata/datastream#callback_irtcengineeventhandler_onstreammessage) | 接收到对方数据流消息的回调。 |
| [onStreamMessageError](/zh-CN/api-reference/rtc/harmonyos/metadata/datastream#callback_irtcengineeventhandler_onstreammessageerror) | 接收对方数据流消息发生错误的回调。 |

<a id="rtc_api_overview__audio_route"></a>

## 音频路由 [#音频路由]

| 方法/回调 | 描述 |
| --- | --- |
| [setDefaultAudioRouteToSpeakerphone](/zh-CN/api-reference/rtc/harmonyos/device-management/audio-route#api_irtcengine_setdefaultaudioroutetospeakerphone) | 设置默认的音频路由。 |
| [setEnableSpeakerphone](/zh-CN/api-reference/rtc/harmonyos/device-management/audio-route#api_irtcengine_setenablespeakerphone) | 开启或关闭扬声器播放。 |
| [isSpeakerphoneEnabled](/zh-CN/api-reference/rtc/harmonyos/device-management/audio-route#api_irtcengine_isspeakerphoneenabled) | 检查扬声器状态启用状态。 |

## 视频设备管理 [#视频设备管理]

| 方法/回调 | 描述 |
| --- | --- |
| [switchCamera](/zh-CN/api-reference/rtc/harmonyos/device-management/video-device#api_irtcengine_switchcamera) | 切换前置/后置摄像头。 |
| [setCameraCapturerConfiguration](/zh-CN/api-reference/rtc/harmonyos/device-management/video-device#api_irtcengine_setcameracapturerconfiguration) | 设置摄像头采集配置。 |
| [getCameraMaxZoomFactor](/zh-CN/api-reference/rtc/harmonyos/device-management/video-device#api_irtcengine_getcameramaxzoomfactor) | 获取摄像头支持最大缩放比例。 |
| [setCameraZoomFactor](/zh-CN/api-reference/rtc/harmonyos/device-management/video-device#api_irtcengine_setcamerazoomfactor) | 设置摄像头缩放比例。 |
| [isCameraFocusSupported](/zh-CN/api-reference/rtc/harmonyos/device-management/video-device#api_irtcengine_iscamerafocussupported) | 检测设备是否支持手动对焦功能。 |
| [setCameraExposureFactor](/zh-CN/api-reference/rtc/harmonyos/device-management/video-device#factor) | 设置当前摄像头的曝光系数。 |
| [setCameraFocusPositionInPreview](/zh-CN/api-reference/rtc/harmonyos/device-management/video-device#api_irtcengine_setcamerafocuspositioninpreview) | 设置手动对焦位置，并触发对焦。 |
| [onCameraExposureAreaChanged](/zh-CN/api-reference/rtc/harmonyos/device-management/video-device#callback_irtcengineeventhandler_oncameraexposureareachanged) | 摄像头曝光区域已改变回调。 |

<a id="rtc_api_overview__network_and_others"></a>

## 网络及其他 [#网络及其他]

| 方法/回调 | 描述 |
| --- | --- |
| [startLastmileProbeTest](/zh-CN/api-reference/rtc/harmonyos/network#api_irtcengine_startlastmileprobetest) | 开始通话前网络质量探测。 |
| [stopLastmileProbeTest](/zh-CN/api-reference/rtc/harmonyos/network#api_irtcengine_stoplastmileprobetest) | 停止通话前网络质量探测。 |
| [onLastmileQuality](/zh-CN/api-reference/rtc/harmonyos/network#callback_irtcengineeventhandler_onlastmilequality) | 网络上下行 last mile 质量报告回调。 |
| [onLastmileProbeResult](/zh-CN/api-reference/rtc/harmonyos/network#callback_irtcengineeventhandler_onlastmileproberesult) | 通话前网络上下行 Last mile 质量探测报告回调。 |
| [getCurrentMonotonicTimeInMs](/zh-CN/api-reference/rtc/harmonyos/network#api_irtcengine_getcurrentmonotonictimeinms) | 获取 SDK 当前的 Monotonic Time。 |
| [setParameters](/zh-CN/api-reference/rtc/harmonyos/network#api_irtcengine_setparameters) | SDK 的 JSON 配置信息，用于提供技术预览或特别定制功能。 |
| [getCallId](/zh-CN/api-reference/rtc/harmonyos/network#api_irtcengine_getcallid) | 获取通话 ID。 |
| [getCallIdEx](/zh-CN/api-reference/rtc/harmonyos/network#api_irtcengineex_getcallidex) | 使用连接 ID 获取通话 ID。 |
| [enableEncryption](/zh-CN/api-reference/rtc/harmonyos/network#api_irtcengine_enableencryption) | 开启或关闭内置加密。 |
| [onEncryptionError](/zh-CN/api-reference/rtc/harmonyos/network#callback_irtcengineeventhandler_onencryptionerror) | 内置加密出错回调。 |
| [onNetworkQuality](/zh-CN/api-reference/rtc/harmonyos/network#callback_irtcengineeventhandler_onnetworkquality) | 通话中每个用户的网络上下行 last mile 质量报告回调。 |
| [onRtcStats](/zh-CN/api-reference/rtc/harmonyos/channel#callback_irtcengineeventhandler_onrtcstats) | 当前通话相关的统计信息回调。 |
| [onPermissionError](/zh-CN/api-reference/rtc/harmonyos/network#callback_irtcengineeventhandler_onpermissionerror) | 获取设备权限出错回调。 |