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

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

<a id="rtc_api_overview__toc_initialize"></a>

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

| API | 描述 |
| --- | --- |
| [createAgoraRtcEngine](/zh-CN/api-reference/rtc/react-native/initialize#api_irtcengine_createagorartcengine) | 创建 [IRtcEngine](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengine) 对象。 |
| [initialize](/zh-CN/api-reference/rtc/react-native/initialize#api_irtcengine_initialize) | 创建并初始化 [IRtcEngine](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengine)。 |
| [registerEventHandler](/zh-CN/api-reference/rtc/react-native/initialize#api_irtcengine_addhandler) | 添加主回调事件。 |
| [addListener](/zh-CN/api-reference/rtc/react-native/initialize#api_irtcengine_addlistener) | 添加一个 [IRtcEngineEvent](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengineevent) 监听器。 |
| [getMediaEngine](/zh-CN/api-reference/rtc/react-native/initialize#api_irtcengine_getmediaengine) | 获取 [IMediaEngine](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediaengine) 对象。 |
| [release](/zh-CN/api-reference/rtc/react-native/initialize#api_irtcengine_release) | 销毁 [IRtcEngine](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengine) 对象。 |
| [removeAllListeners](/zh-CN/api-reference/rtc/react-native/initialize#api_irtcengine_removealllisteners) | 移除指定事件类型的所有监听器。 |
| [unregisterEventHandler](/zh-CN/api-reference/rtc/react-native/initialize#api_irtcengine_removehandler) | 删除指定的回调事件。 |
| [removeListener](/zh-CN/api-reference/rtc/react-native/initialize#api_irtcengine_removelistener) | 移除指定的 [IRtcEngineEvent](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_irtcengineevent) 监听器。 |

<a id="rtc_api_overview__toc_channel"></a>

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

| API | 描述 |
| --- | --- |
| [setChannelProfile](/zh-CN/api-reference/rtc/react-native/channel#api_irtcengine_setchannelprofile) | 设置频道场景。 |
| [joinChannel](/zh-CN/api-reference/rtc/react-native/channel#api_irtcengine_joinchannel2) | 设置媒体选项并加入频道。 |
| [joinChannelEx](/zh-CN/api-reference/rtc/react-native/channel#api_irtcengineex_joinchannelex) | 加入频道。 |
| [updateChannelMediaOptions](/zh-CN/api-reference/rtc/react-native/channel#api_irtcengine_updatechannelmediaoptions) | 加入频道后更新频道媒体选项。 |
| [updateChannelMediaOptionsEx](/zh-CN/api-reference/rtc/react-native/channel#api_irtcengineex_updatechannelmediaoptionsex) | 加入频道后更新频道媒体选项。 |
| [leaveChannel](/zh-CN/api-reference/rtc/react-native/channel#api_irtcengine_leavechannel2) | 设置频道选项并离开频道。 |
| [leaveChannelEx](/zh-CN/api-reference/rtc/react-native/channel#api_irtcengineex_leavechannelex2) | 设置频道选项并离开频道。 |
| [preloadChannel](/zh-CN/api-reference/rtc/react-native/channel#api_irtcengine_preloadchannel) | 使用 `token`、`channelId`、`uid` 预加载频道。 |
| [updatePreloadChannelToken](/zh-CN/api-reference/rtc/react-native/channel#api_irtcengine_updatepreloadchanneltoken) | 更新预加载频道的通配 Token。 |
| [renewToken](/zh-CN/api-reference/rtc/react-native/channel#api_irtcengine_renewtoken) | 更新 Token。 |
| [setClientRole](/zh-CN/api-reference/rtc/react-native/channel#api_irtcengine_setclientrole2) | 设置直播场景下的用户角色和观众端延时级别。 |
| [onClientRoleChanged](/zh-CN/api-reference/rtc/react-native/channel#callback_irtcengineeventhandler_onclientrolechanged) | 用户角色、观众端延时级别已切换回调。 |
| [onClientRoleChangeFailed](/zh-CN/api-reference/rtc/react-native/channel#callback_irtcengineeventhandler_onclientrolechangefailed) | 用户角色切换失败回调。 |
| [onError](/zh-CN/api-reference/rtc/react-native/channel#callback_irtcengineeventhandler_onerror) | 发生错误回调。 |
| [onJoinChannelSuccess](/zh-CN/api-reference/rtc/react-native/channel#callback_irtcengineeventhandler_onjoinchannelsuccess) | 成功加入频道回调。 |
| [onLeaveChannel](/zh-CN/api-reference/rtc/react-native/channel#callback_irtcengineeventhandler_onleavechannel) | 离开频道回调。 |
| [onRejoinChannelSuccess](/zh-CN/api-reference/rtc/react-native/channel#callback_irtcengineeventhandler_onrejoinchannelsuccess) | 成功重新加入频道回调。 |
| [onRenewTokenResult](/zh-CN/api-reference/rtc/react-native/channel#callback_irtcengineeventhandler_onrenewtokenresult) | [renewToken](/zh-CN/api-reference/rtc/react-native/channel#api_irtcengine_renewtoken) 方法调用结果回调。 |
| [onRequestToken](/zh-CN/api-reference/rtc/react-native/channel#callback_irtcengineeventhandler_onrequesttoken) | Token 已过期回调。 |
| [onRtcStats](/zh-CN/api-reference/rtc/react-native/channel#callback_irtcengineeventhandler_onrtcstats) | 当前通话相关的统计信息回调。 |
| [onTokenPrivilegeWillExpire](/zh-CN/api-reference/rtc/react-native/channel#callback_irtcengineeventhandler_ontokenprivilegewillexpire) | Token 即将在 30s 内过期回调。 |
| [onUserJoined](/zh-CN/api-reference/rtc/react-native/channel#callback_irtcengineeventhandler_onuserjoined) | 远端用户（通信场景）/主播（直播场景）加入当前频道回调。 |
| [onUserOffline](/zh-CN/api-reference/rtc/react-native/channel#callback_irtcengineeventhandler_onuseroffline) | 远端用户（通信场景）/主播（直播场景）离开当前频道回调。 |

<a id="rtc_api_overview__toc_publishnsubscribe"></a>

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

| API | 描述 |
| --- | --- |
| [muteAllRemoteAudioStreams](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengine_muteallremoteaudiostreams) | 取消或恢复订阅所有远端用户的音频流。 |
| [muteAllRemoteAudioStreamsEx](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengineex_muteallremoteaudiostreamsex) | 取消或恢复订阅所有远端用户的音频流。 |
| [muteAllRemoteVideoStreams](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengine_muteallremotevideostreams) | 取消或恢复订阅所有远端用户的视频流。 |
| [muteAllRemoteVideoStreamsEx](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengineex_muteallremotevideostreamsex) | 取消或恢复订阅所有远端用户的视频流。 |
| [muteLocalAudioStream](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengine_mutelocalaudiostream) | 取消或恢复发布本地音频流。 |
| [muteLocalAudioStreamEx](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengineex_mutelocalaudiostreamex) | 取消或恢复发布本地音频流。 |
| [muteLocalVideoStream](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengine_mutelocalvideostream) | 取消或恢复发布本地视频流。 |
| [muteLocalVideoStreamEx](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengineex_mutelocalvideostreamex) | 取消或恢复发布本地视频流。 |
| [muteRemoteAudioStream](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengine_muteremoteaudiostream) | 取消或恢复订阅指定远端用户的音频流。 |
| [muteRemoteAudioStreamEx](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengineex_muteremoteaudiostreamex) | 停止/恢复接收指定的音频流。 |
| [muteRemoteVideoStream](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengine_muteremotevideostream) | 取消或恢复订阅指定远端用户的视频流。 |
| [muteRemoteVideoStreamEx](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengineex_muteremotevideostreamex) | 停止/恢复接收指定的视频流。 |
| [setDualStreamMode](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengine_setdualstreammode2) | 在发送端设置双流模式并设置视频小流。 |
| [setDualStreamModeEx](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengineex_setdualstreammodeex) | 在发送端设置双流模式。 |
| [setRemoteDefaultVideoStreamType](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengine_setremotedefaultvideostreamtype) | 设置默认订阅的视频流类型。 |
| [setRemoteVideoStreamType](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengine_setremotevideostreamtype) | 设置订阅的视频流类型。 |
| [setRemoteVideoStreamTypeEx](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengineex_setremotevideostreamtypeex) | 设置订阅的视频流类型。 |
| [setRemoteVideoSubscriptionOptions](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengine_setremotevideosubscriptionoptions) | 设置远端视频流的订阅选项。 |
| [setRemoteVideoSubscriptionOptionsEx](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengineex_setremotevideosubscriptionoptionsex) | 设置远端视频流的订阅选项。 |
| [setSubscribeAudioAllowlist](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengine_setsubscribeaudioallowlist) | 设置音频订阅白名单。 |
| [setSubscribeAudioAllowlistEx](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengineex_setsubscribeaudioallowlistex) | 设置音频订阅白名单。 |
| [setSubscribeAudioBlocklist](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengine_setsubscribeaudioblocklist) | 设置音频订阅黑名单。 |
| [setSubscribeAudioBlocklistEx](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengineex_setsubscribeaudioblocklistex) | 设置音频订阅黑名单。 |
| [setSubscribeVideoAllowlist](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengine_setsubscribevideoallowlist) | 设置视频订阅白名单。 |
| [setSubscribeVideoAllowlistEx](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengineex_setsubscribevideoallowlistex) | 设置视频订阅白名单。 |
| [setSubscribeVideoBlocklist](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengine_setsubscribevideoblocklist) | 设置视频订阅黑名单。 |
| [setSubscribeVideoBlocklistEx](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#api_irtcengineex_setsubscribevideoblocklistex) | 设置视频订阅黑名单。 |
| [onAudioPublishStateChanged](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#callback_irtcengineeventhandler_onaudiopublishstatechanged) | 音频发布状态改变回调。 |
| [onAudioSubscribeStateChanged](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#callback_irtcengineeventhandler_onaudiosubscribestatechanged) | 音频订阅状态发生改变回调。 |
| [onVideoSubscribeStateChanged](/zh-CN/api-reference/rtc/react-native/publishnsubscribe#callback_irtcengineeventhandler_onvideosubscribestatechanged) | 视频订阅状态发生改变回调。 |

<a id="rtc_api_overview__toc_audio_basic"></a>

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

| API | 描述 |
| --- | --- |
| [adjustPlaybackSignalVolume](/zh-CN/api-reference/rtc/react-native/audio/audio-basic#api_irtcengine_adjustplaybacksignalvolume) | 调节本地播放的所有远端用户信号音量。 |
| [adjustUserPlaybackSignalVolume](/zh-CN/api-reference/rtc/react-native/audio/audio-basic#api_irtcengine_adjustuserplaybacksignalvolume) | 调节本地播放的指定远端用户信号音量。 |
| [adjustUserPlaybackSignalVolumeEx](/zh-CN/api-reference/rtc/react-native/audio/audio-basic#api_irtcengineex_adjustuserplaybacksignalvolumeex) | 调节本地播放的指定远端用户信号音量。 |
| [disableAudio](/zh-CN/api-reference/rtc/react-native/audio/audio-basic#api_irtcengine_disableaudio) | 关闭音频模块。 |
| [enableAudio](/zh-CN/api-reference/rtc/react-native/audio/audio-basic#api_irtcengine_enableaudio) | 启用音频模块。 |
| [enableAudioVolumeIndication](/zh-CN/api-reference/rtc/react-native/audio/audio-basic#api_irtcengine_enableaudiovolumeindication) | 启用用户音量提示。 |
| [enableAudioVolumeIndicationEx](/zh-CN/api-reference/rtc/react-native/audio/audio-basic#api_irtcengineex_enableaudiovolumeindicationex) | 启用用户音量提示。 |
| [setAudioProfile](/zh-CN/api-reference/rtc/react-native/audio/audio-basic#api_irtcengine_setaudioprofile) | 设置音频编码属性和音频场景。 |
| [setAudioScenario](/zh-CN/api-reference/rtc/react-native/audio/audio-basic#api_irtcengine_setaudioscenario) | 设置音频场景。 |
| [setAudioSessionOperationRestriction](/zh-CN/api-reference/rtc/react-native/audio/audio-basic#api_irtcengine_setaudiosessionoperationrestriction) | 设置 SDK 对 Audio Session 的操作权限。 |
| [onActiveSpeaker](/zh-CN/api-reference/rtc/react-native/audio/audio-basic#callback_irtcengineeventhandler_onactivespeaker) | 监测到远端最活跃用户回调。 |
| [onAudioVolumeIndication](/zh-CN/api-reference/rtc/react-native/audio/audio-basic#callback_irtcengineeventhandler_onaudiovolumeindication) | 用户音量提示回调。 |
| [onFirstLocalAudioFramePublished](/zh-CN/api-reference/rtc/react-native/audio/audio-basic#callback_irtcengineeventhandler_onfirstlocalaudioframepublished) | 已发布本地音频首帧回调。 |
| [onLocalAudioStateChanged](/zh-CN/api-reference/rtc/react-native/audio/audio-basic#callback_irtcengineeventhandler_onlocalaudiostatechanged) | 本地音频状态发生改变回调。 |
| [onLocalAudioStats](/zh-CN/api-reference/rtc/react-native/audio/audio-basic#callback_irtcengineeventhandler_onlocalaudiostats) | 通话中本地音频流的统计信息回调。 |
| [onRemoteAudioStateChanged](/zh-CN/api-reference/rtc/react-native/audio/audio-basic#callback_irtcengineeventhandler_onremoteaudiostatechanged) | 远端音频流状态发生改变回调。 |
| [onRemoteAudioStats](/zh-CN/api-reference/rtc/react-native/audio/audio-basic#callback_irtcengineeventhandler_onremoteaudiostats) | 通话中远端音频流的统计信息回调。 |
| [onRemoteAudioTransportStats](/zh-CN/api-reference/rtc/react-native/audio/audio-basic#callback_irtcengineeventhandler_onremoteaudiotransportstats) | 通话中远端音频流传输的统计信息回调。 |
| [onUserMuteAudio](/zh-CN/api-reference/rtc/react-native/audio/audio-basic#callback_irtcengineeventhandler_onusermuteaudio) | 远端用户（通信场景）/主播（直播场景）停止或恢复发送音频流回调。 |

<a id="rtc_api_overview__toc_audio_capture"></a>

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

| API | 描述 |
| --- | --- |
| [adjustRecordingSignalVolume](/zh-CN/api-reference/rtc/react-native/audio/audio-capture#api_irtcengine_adjustrecordingsignalvolume) | 调节音频采集信号音量。 |
| [enableInEarMonitoring](/zh-CN/api-reference/rtc/react-native/audio/audio-capture#api_irtcengine_enableinearmonitoring2) | 开启耳返功能。 |
| [enableLocalAudio](/zh-CN/api-reference/rtc/react-native/audio/audio-capture#api_irtcengine_enablelocalaudio) | 开启或关闭本地音频采集。 |
| [muteRecordingSignal](/zh-CN/api-reference/rtc/react-native/audio/audio-capture#api_irtcengine_muterecordingsignal) | 是否将录音信号静音。 |
| [setInEarMonitoringVolume](/zh-CN/api-reference/rtc/react-native/audio/audio-capture#api_irtcengine_setinearmonitoringvolume) | 设置耳返音量。 |

<a id="rtc_api_overview__toc_audio_effect"></a>

## 人声音效 [#人声音效]

| API | 描述 |
| --- | --- |
| [enableVoiceAITuner](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/audio-effect#api_irtcengine_enablevoiceaituner) | 开启或关闭 AI 调音器功能。 |
| [setAdvancedAudioOptions](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/audio-effect#api_irtcengine_setadvancedaudiooptions) | 设置音频的高级选项。 |
| [setAINSMode](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/audio-effect#api_irtcengine_setainsmode) | 设置是否开启 AI 降噪功能并设置降噪模式。 |
| [setAudioEffectParameters](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/audio-effect#api_irtcengine_setaudioeffectparameters) | 设置 SDK 预设人声音效的参数。 |
| [setAudioEffectPreset](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/audio-effect#api_irtcengine_setaudioeffectpreset) | 设置 SDK 预设的人声音效。 |
| [setLocalVoiceEqualization](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/audio-effect#api_irtcengine_setlocalvoiceequalization) | 设置本地语音音效均衡。 |
| [setLocalVoiceFormant](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/audio-effect#api_irtcengine_setlocalvoiceformant) | 设置共振峰比率以改变语音的音色。 |
| [setLocalVoicePitch](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/audio-effect#api_irtcengine_setlocalvoicepitch) | 设置本地语音音调。 |
| [setLocalVoiceReverb](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/audio-effect#api_irtcengine_setlocalvoicereverb) | 设置本地音效混响。 |
| [setVoiceBeautifierParameters](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/audio-effect#api_irtcengine_setvoicebeautifierparameters) | 设置预设美声效果的参数。 |
| [setVoiceBeautifierPreset](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/audio-effect#api_irtcengine_setvoicebeautifierpreset) | 设置预设的美声效果。 |
| [setVoiceConversionPreset](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/audio-effect#api_irtcengine_setvoiceconversionpreset) | 设置预设的变声效果。 |

<a id="rtc_api_overview__toc_sound_position"></a>

## 听声辨位 [#听声辨位]

| API | 描述 |
| --- | --- |
| [enableSoundPositionIndication](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/sound-position#api_irtcengine_enablesoundpositionindication) | 开启/关闭远端用户的语音立体声。 |
| [setRemoteVoicePosition](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/sound-position#api_irtcengine_setremotevoiceposition) | 设置远端用户声音的 2D 位置，即水平面位置。 |
| [setRemoteVoicePositionEx](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/sound-position#api_irtcengineex_setremotevoicepositionex) | 设置远端用户声音的 2D 位置，即水平面位置。 |

<a id="rtc_api_overview__toc_spatial_audio"></a>

## 空间音频 [#空间音频]

| API | 描述 |
| --- | --- |
| [initialize](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/spatial-audio#api_ilocalspatialaudioengine_initialize_ilocalspatialaudioengine) | 初始化 [ILocalSpatialAudioEngine](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_ilocalspatialaudioengine)。 |
| [clearRemotePositions](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/spatial-audio#api_ilocalspatialaudioengine_clearremotepositions) | 删除所有远端用户的空间位置信息。 |
| [enableSpatialAudio](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/spatial-audio#api_irtcengine_enablespatialaudio) | 开启或关闭空间音频。 |
| [getLocalSpatialAudioEngine](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/spatial-audio#api_irtcengine_getlocalspatialaudioengine) | 获取 [ILocalSpatialAudioEngine](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_ilocalspatialaudioengine) 对象。 |
| [muteAllRemoteAudioStreams](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/spatial-audio#api_ibasespatialaudioengine_muteallremoteaudiostreams_ibasespatialaudioengine) | 取消或恢复订阅所有远端用户的音频流。 |
| [muteLocalAudioStream](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/spatial-audio#api_ibasespatialaudioengine_mutelocalaudiostream_ibasespatialaudioengine) | 取消或恢复发布本地音频流。 |
| [muteRemoteAudioStream](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/spatial-audio#api_ibasespatialaudioengine_muteremoteaudiostream_ibasespatialaudioengine) | 取消或恢复订阅指定远端用户的音频流。 |
| [release](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/spatial-audio#api_ibasespatialaudioengine_release_ibasespatialaudioengine) | 销毁 [IBaseSpatialAudioEngine](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_ibasespatialaudioengine)。 |
| [removeRemotePosition](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/spatial-audio#api_ilocalspatialaudioengine_removeremoteposition) | 删除指定远端用户的空间位置信息。 |
| [setAudioRecvRange](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/spatial-audio#api_ibasespatialaudioengine_setaudiorecvrange) | 设置本地用户的音频接收范围。 |
| [setDistanceUnit](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/spatial-audio#api_ibasespatialaudioengine_setdistanceunit) | 设置游戏引擎单位距离的长度（米）。 |
| [setHeadphoneEQParameters](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/spatial-audio#api_irtcengine_setheadphoneeqparameters) | 设置耳机均衡器的低频和高频参数。 |
| [setHeadphoneEQPreset](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/spatial-audio#api_irtcengine_setheadphoneeqpreset) | 设置预设的耳机均衡效果。 |
| [setMaxAudioRecvCount](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/spatial-audio#api_ibasespatialaudioengine_setmaxaudiorecvcount) | 设置音频接收范围内最多可接收的音频流数。 |
| [setPlayerAttenuation](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/spatial-audio#api_ibasespatialaudioengine_setplayerattenuation) | 设置媒体播放器的声音衰减属性。 |
| [setRemoteAudioAttenuation](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/spatial-audio#api_ilocalspatialaudioengine_setremoteaudioattenuation) | 设置指定用户的声音衰减效果。 |
| [setRemoteUserSpatialAudioParams](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/spatial-audio#api_irtcengine_setremoteuserspatialaudioparams) | 设置远端用户的空间音频参数。 |
| [setSpatialAudioParams](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/spatial-audio#api_imediaplayer_setspatialaudioparams) | 开启或关闭媒体播放器的空间音频。 |
| [setZones](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/spatial-audio#api_ibasespatialaudioengine_setzones) | 设置隔声区域。 |
| [updatePlayerPositionInfo](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/spatial-audio#api_ibasespatialaudioengine_updateplayerpositioninfo) | 更新媒体播放器的空间位置。 |
| [updateRemotePosition](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/spatial-audio#api_ilocalspatialaudioengine_updateremoteposition) | 更新远端用户的空间位置信息。 |
| [updateSelfPosition](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/spatial-audio#api_ibasespatialaudioengine_updateselfposition) | 更新本地用户的空间位置。 |

<a id="rtc_api_overview__toc_audiomixer"></a>

## 本地音频合流 [#本地音频合流]

| API | 描述 |
| --- | --- |
| [startLocalAudioMixer](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/audiomixer#api_irtcengine_startlocalaudiomixer) | 开启本地音频合流。 |
| [stopLocalAudioMixer](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/audiomixer#api_irtcengine_stoplocalaudiomixer) | 停止本地音频合流。 |
| [updateLocalAudioMixerConfiguration](/zh-CN/api-reference/rtc/react-native/audio/audio-prenpost/audiomixer#api_irtcengine_updatelocalaudiomixerconfiguration) | 更新本地音频合流的配置。 |

<a id="rtc_api_overview__toc_audio_raw"></a>

## 原始音频数据 [#原始音频数据]

| API | 描述 |
| --- | --- |
| [registerAudioFrameObserver](/zh-CN/api-reference/rtc/react-native/audio/audio-raw#api_imediaengine_registeraudioframeobserver) | 注册音频观测器对象。 |
| [setEarMonitoringAudioFrameParameters](/zh-CN/api-reference/rtc/react-native/audio/audio-raw#api_irtcengine_setearmonitoringaudioframeparameters) | 设置耳返的音频数据格式。 |
| [setMixedAudioFrameParameters](/zh-CN/api-reference/rtc/react-native/audio/audio-raw#api_irtcengine_setmixedaudioframeparameters) | 设置采集和播放音频混音后的原始音频数据格式。 |
| [setPlaybackAudioFrameBeforeMixingParameters](/zh-CN/api-reference/rtc/react-native/audio/audio-raw#api_irtcengine_setplaybackaudioframebeforemixingparameters1) | 设置混音前的原始音频播放数据格式。 |
| [setPlaybackAudioFrameParameters](/zh-CN/api-reference/rtc/react-native/audio/audio-raw#api_irtcengine_setplaybackaudioframeparameters) | 设置播放的原始音频数据格式。 |
| [setRecordingAudioFrameParameters](/zh-CN/api-reference/rtc/react-native/audio/audio-raw#api_irtcengine_setrecordingaudioframeparameters) | 设置采集的原始音频数据格式。 |
| [unregisterAudioFrameObserver](/zh-CN/api-reference/rtc/react-native/audio/audio-raw#api_imediaengine_unregisteraudioframeobserver_imediaengine) | 取消注册音频帧观测器。 |
| [onEarMonitoringAudioFrame](/zh-CN/api-reference/rtc/react-native/audio/audio-raw#callback_iaudioframeobserverbase_onearmonitoringaudioframe) | 获得耳返的原始音频数据。 |
| [onMixedAudioFrame](/zh-CN/api-reference/rtc/react-native/audio/audio-raw#callback_iaudioframeobserverbase_onmixedaudioframe) | 获取采集和播放音频混音后的数据。 |
| [onPlaybackAudioFrame](/zh-CN/api-reference/rtc/react-native/audio/audio-raw#callback_iaudioframeobserverbase_onplaybackaudioframe) | 获得播放的原始音频数据。 |
| [onPlaybackAudioFrameBeforeMixing](/zh-CN/api-reference/rtc/react-native/audio/audio-raw#callback_iaudioframeobserver_onplaybackaudioframebeforemixing) | 获取所订阅的远端用户混音前的声音。 |
| [onRecordAudioFrame](/zh-CN/api-reference/rtc/react-native/audio/audio-raw#callback_iaudioframeobserverbase_onrecordaudioframe) | 获得采集的原始音频数据。 |

<a id="rtc_api_overview__toc_audio_encoded"></a>

## 已编码音频数据 [#已编码音频数据]

| API | 描述 |
| --- | --- |
| [registerAudioEncodedFrameObserver](/zh-CN/api-reference/rtc/react-native/audio/audio-encoded#api_irtcengine_registeraudioencodedframeobserver) | 注册音频编码数据观测器。 |
| [unregisterAudioEncodedFrameObserver](/zh-CN/api-reference/rtc/react-native/audio/audio-encoded#api_irtcengine_unregisteraudioencodedframeobserver) | 取消注册音频编码数据观测器。 |
| [onMixedAudioEncodedFrame](/zh-CN/api-reference/rtc/react-native/audio/audio-encoded#callback_iaudioencodedframeobserver_onmixedaudioencodedframe) | 获取本地和所有远端用户混音后的音频编码数据。 |
| [onPlaybackAudioEncodedFrame](/zh-CN/api-reference/rtc/react-native/audio/audio-encoded#callback_iaudioencodedframeobserver_onplaybackaudioencodedframe) | 获取所有远端用户的音频编码数据。 |
| [onRecordAudioEncodedFrame](/zh-CN/api-reference/rtc/react-native/audio/audio-encoded#callback_iaudioencodedframeobserver_onrecordaudioencodedframe) | 获取本地用户的音频编码数据。 |

<a id="rtc_api_overview__toc_audio_custom_capturenrendering"></a>

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

| API | 描述 |
| --- | --- |
| [adjustCustomAudioPlayoutVolume](/zh-CN/api-reference/rtc/react-native/audio/audio-custom-capturenrendering#api_irtcengine_adjustcustomaudioplayoutvolume) | 调节自定义音频采集轨道在本地播放的音量。 |
| [adjustCustomAudioPublishVolume](/zh-CN/api-reference/rtc/react-native/audio/audio-custom-capturenrendering#api_irtcengine_adjustcustomaudiopublishvolume) | 调节自定义音频采集轨道在远端播放的音量。 |
| [createCustomAudioTrack](/zh-CN/api-reference/rtc/react-native/audio/audio-custom-capturenrendering#api_imediaengine_createcustomaudiotrack) | 创建一个自定义音频采集轨道。 |
| [destroyCustomAudioTrack](/zh-CN/api-reference/rtc/react-native/audio/audio-custom-capturenrendering#api_imediaengine_destroycustomaudiotrack) | 销毁指定的音频轨道。 |
| [enableCustomAudioLocalPlayback](/zh-CN/api-reference/rtc/react-native/audio/audio-custom-capturenrendering#api_irtcengine_enablecustomaudiolocalplayback) | 设置是否在本地播放外部音频源。 |
| [pullAudioFrame](/zh-CN/api-reference/rtc/react-native/audio/audio-custom-capturenrendering#api_imediaengine_pullaudioframe) | 拉取远端音频数据。 |
| [pushAudioFrame](/zh-CN/api-reference/rtc/react-native/audio/audio-custom-capturenrendering#api_imediaengine_pushaudioframe) | 推送外部音频帧。 |
| [setExternalAudioSink](/zh-CN/api-reference/rtc/react-native/audio/audio-custom-capturenrendering#api_imediaengine_setexternalaudiosink) | 设置外部音频渲染。 |

<a id="rtc_api_overview__toc_audio_spectrum"></a>

## 音频频谱 [#音频频谱]

| API | 描述 |
| --- | --- |
| [disableAudioSpectrumMonitor](/zh-CN/api-reference/rtc/react-native/audio/audio-spectrum#api_irtcengine_disableaudiospectrummonitor) | 关闭音频频谱监测。 |
| [enableAudioSpectrumMonitor](/zh-CN/api-reference/rtc/react-native/audio/audio-spectrum#api_irtcengine_enableaudiospectrummonitor) | 开启音频频谱监测。 |
| [registerAudioSpectrumObserver](/zh-CN/api-reference/rtc/react-native/audio/audio-spectrum#api_irtcengine_registeraudiospectrumobserver) | 注册音频频谱观测器。 |
| [unregisterAudioSpectrumObserver](/zh-CN/api-reference/rtc/react-native/audio/audio-spectrum#api_irtcengine_unregisteraudiospectrumobserver) | 取消注册音频频谱观测器。 |
| [onLocalAudioSpectrum](/zh-CN/api-reference/rtc/react-native/audio/audio-spectrum#callback_iaudiospectrumobserver_onlocalaudiospectrum) | 获取本地音频频谱。 |
| [onRemoteAudioSpectrum](/zh-CN/api-reference/rtc/react-native/audio/audio-spectrum#callback_iaudiospectrumobserver_onremoteaudiospectrum) | 获取远端音频频谱。 |

<a id="rtc_api_overview__toc_video_basic"></a>

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

| API | 描述 |
| --- | --- |
| [disableVideo](/zh-CN/api-reference/rtc/react-native/video/video-basic#api_irtcengine_disablevideo) | 关闭视频模块。 |
| [enableLocalVideo](/zh-CN/api-reference/rtc/react-native/video/video-basic#api_irtcengine_enablelocalvideo) | 开关本地视频采集。 |
| [enableVideo](/zh-CN/api-reference/rtc/react-native/video/video-basic#api_irtcengine_enablevideo) | 启用视频模块。 |
| [setVideoEncoderConfiguration](/zh-CN/api-reference/rtc/react-native/video/video-basic#api_irtcengine_setvideoencoderconfiguration) | 设置视频编码属性。 |
| [setVideoEncoderConfigurationEx](/zh-CN/api-reference/rtc/react-native/video/video-basic#api_irtcengineex_setvideoencoderconfigurationex) | 设置视频编码属性。 |
| [setVideoScenario](/zh-CN/api-reference/rtc/react-native/video/video-basic#api_irtcengine_setvideoscenario) | 设置视频业务场景。 |
| [startPreviewWithoutSourceType](/zh-CN/api-reference/rtc/react-native/video/video-basic#api_irtcengine_startpreview) | 开启视频预览。 |
| [startPreview](/zh-CN/api-reference/rtc/react-native/video/video-basic#api_irtcengine_startpreview2) | 开启视频预览并指定预览的视频源。 |
| [stopPreview](/zh-CN/api-reference/rtc/react-native/video/video-basic#api_irtcengine_stoppreview2) | 停止视频预览。 |
| [onFirstLocalVideoFrame](/zh-CN/api-reference/rtc/react-native/video/video-basic#callback_irtcengineeventhandler_onfirstlocalvideoframe) | 已显示本地视频首帧回调。 |
| [onFirstLocalVideoFramePublished](/zh-CN/api-reference/rtc/react-native/video/video-basic#callback_irtcengineeventhandler_onfirstlocalvideoframepublished) | 已发布本地视频首帧回调。 |
| [onFirstRemoteVideoDecoded](/zh-CN/api-reference/rtc/react-native/video/video-basic#callback_irtcengineeventhandler_onfirstremotevideodecoded) | 已接收到远端视频并完成解码回调。 |
| [onFirstRemoteVideoFrame](/zh-CN/api-reference/rtc/react-native/video/video-basic#callback_irtcengineeventhandler_onfirstremotevideoframe) | 渲染器已接收首帧远端视频回调。 |
| [onLocalVideoEvent](/zh-CN/api-reference/rtc/react-native/video/video-basic#callback_irtcengineeventhandler_onlocalvideoevent) | 本地视频事件发生时触发的回调。 |
| [onLocalVideoStateChanged](/zh-CN/api-reference/rtc/react-native/video/video-basic#callback_irtcengineeventhandler_onlocalvideostatechanged) | 本地视频状态发生改变回调。 |
| [onLocalVideoStats](/zh-CN/api-reference/rtc/react-native/video/video-basic#callback_irtcengineeventhandler_onlocalvideostats) | 本地视频流统计信息回调。 |
| [onRemoteVideoStateChanged](/zh-CN/api-reference/rtc/react-native/video/video-basic#callback_irtcengineeventhandler_onremotevideostatechanged) | 远端视频状态发生改变回调。 |
| [onRemoteVideoStats](/zh-CN/api-reference/rtc/react-native/video/video-basic#callback_irtcengineeventhandler_onremotevideostats) | 通话中远端视频流的统计信息回调。 |
| [onUserEnableVideo](/zh-CN/api-reference/rtc/react-native/video/video-basic#callback_irtcengineeventhandler_onuserenablevideo) | 远端用户开/关视频模块回调。 |
| [onUserMuteVideo](/zh-CN/api-reference/rtc/react-native/video/video-basic#callback_irtcengineeventhandler_onusermutevideo) | 远端用户取消或恢复发布视频流回调。 |
| [onVideoPublishStateChanged](/zh-CN/api-reference/rtc/react-native/video/video-basic#callback_irtcengineeventhandler_onvideopublishstatechanged) | 视频发布状态改变回调。 |
| [onVideoSizeChanged](/zh-CN/api-reference/rtc/react-native/video/video-basic#callback_irtcengineeventhandler_onvideosizechanged) | 本地或远端视频大小和旋转信息发生改变回调。 |

<a id="rtc_api_overview__toc_camera_capture"></a>

## 摄像头采集 [#摄像头采集]

| API | 描述 |
| --- | --- |
| [setCameraStabilizationMode](/zh-CN/api-reference/rtc/react-native/video/camera-capture#api_irtcengine_setcamerastabilizationmode) | 设置摄像头防抖模式。 |
| [startCameraCapture](/zh-CN/api-reference/rtc/react-native/video/camera-capture#api_irtcengine_startcameracapture) | 开始通过摄像头采集视频。 |
| [stopCameraCapture](/zh-CN/api-reference/rtc/react-native/video/camera-capture#api_irtcengine_stopcameracapture) | 停止通过摄像头采集视频。 |

<a id="rtc_api_overview__toc_screencapture"></a>

## 屏幕采集 [#屏幕采集]

| API | 描述 |
| --- | --- |
| [queryScreenCaptureCapability](/zh-CN/api-reference/rtc/react-native/video/screencapture#api_irtcengine_queryscreencapturecapability) | 查询设备在屏幕共享时支持的最高帧率。 |
| [setExternalMediaProjection](/zh-CN/api-reference/rtc/react-native/video/screencapture#api_irtcengine_setexternalmediaprojection) | 设置 SDK 外部的 `MediaProjection` 采集屏幕视频流。 |
| [setScreenCaptureContentHint](/zh-CN/api-reference/rtc/react-native/video/screencapture#api_irtcengine_setscreencapturecontenthint) | 设置屏幕共享内容类型。 |
| [setScreenCaptureScenario](/zh-CN/api-reference/rtc/react-native/video/screencapture#api_irtcengine_setscreencapturescenario) | 设置屏幕共享的场景。 |
| [startScreenCapture](/zh-CN/api-reference/rtc/react-native/video/screencapture#api_irtcengine_startscreencapture) | 开始屏幕采集。 |
| [stopScreenCapture](/zh-CN/api-reference/rtc/react-native/video/screencapture#api_irtcengine_stopscreencapture) | 停止屏幕采集。 |
| [updateScreenCapture](/zh-CN/api-reference/rtc/react-native/video/screencapture#api_irtcengine_updatescreencapture) | 更新屏幕采集的参数配置。 |
| [updateScreenCaptureParameters](/zh-CN/api-reference/rtc/react-native/video/screencapture#api_irtcengine_updatescreencaptureparameters) | 更新屏幕采集的参数配置。 |
| [updateScreenCaptureRegion](/zh-CN/api-reference/rtc/react-native/video/screencapture#api_irtcengine_updatescreencaptureregion1) | 更新屏幕采集的区域。 |

<a id="rtc_api_overview__toc_snapshot"></a>

## 本地截图上传 [#本地截图上传]

| API | 描述 |
| --- | --- |
| [enableContentInspect](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/snapshot#api_irtcengine_enablecontentinspect) | 开启/关闭本地截图上传。 |
| [enableContentInspectEx](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/snapshot#api_irtcengineex_enablecontentinspectex) | 开启/关闭本地截图上传。 |
| [takeSnapshot](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/snapshot#api_irtcengine_takesnapshot) | 对视频截图。 |
| [takeSnapshotWithConfig](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/snapshot#api_irtcengine_takesnapshot2) | 在指定观测位置进行视频截图。 |
| [takeSnapshotEx](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/snapshot#api_irtcengineex_takesnapshotex) | 使用连接 ID 获取视频截图。 |
| [takeSnapshotWithConfigEx](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/snapshot#api_irtcengineex_takesnapshotex2) | 使用连接 ID 获取指定观测位置的视频截图。 |
| [onSnapshotTaken](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/snapshot#callback_irtcengineeventhandler_onsnapshottaken) | 视频截图结果回调。 |

<a id="rtc_api_overview__toc_virtualbackground"></a>

## 虚拟背景 [#虚拟背景]

| API | 描述 |
| --- | --- |
| [enableVirtualBackground](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/virtualbackground#api_irtcengine_enablevirtualbackground) | 开启/关闭虚拟背景。 |

<a id="rtc_api_overview__toc_local_transcoder"></a>

## 本地合图 [#本地合图]

| API | 描述 |
| --- | --- |
| [startLocalVideoTranscoder](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/local-transcoder#api_irtcengine_startlocalvideotranscoder) | 开启本地合图。 |
| [stopLocalVideoTranscoder](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/local-transcoder#api_irtcengine_stoplocalvideotranscoder) | 停止本地合图。 |
| [updateLocalTranscoderConfiguration](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/local-transcoder#api_irtcengine_updatelocaltranscoderconfiguration) | 更新本地合图配置。 |
| [onLocalVideoTranscoderError](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/local-transcoder#callback_irtcengineeventhandler_onlocalvideotranscodererror) | 本地合图发生错误回调。 |

<a id="rtc_api_overview__toc_video_enhance_option"></a>

## 视频增强 [#视频增强]

| API | 描述 |
| --- | --- |
| [addOrUpdateVideoEffect](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/video-enhance-option#api_ivideoeffectobject_addorupdatevideoeffect) | 添加或更新指定视频特效节点和模板的特效。 |
| [createVideoEffectObject](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/video-enhance-option#api_irtcengine_createvideoeffectobject) | 创建一个 [IVideoEffectObject](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_ivideoeffectobject) 视频特效对象。 |
| [destroyVideoEffectObject](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/video-enhance-option#api_irtcengine_destroyvideoeffectobject) | 销毁视频特效对象。 |
| [getFaceShapeAreaOptions](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/video-enhance-option#api_irtcengine_getfaceshapeareaoptions) | 获取美型部位选项。 |
| [getFaceShapeBeautyOptions](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/video-enhance-option#api_irtcengine_getfaceshapebeautyoptions) | 获取美型效果选项。 |
| [getVideoEffectBoolParam](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/video-enhance-option#api_ivideoeffectobject_getvideoeffectboolparam) | 获取视频特效中的布尔参数。 |
| [getVideoEffectFloatParam](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/video-enhance-option#api_ivideoeffectobject_getvideoeffectfloatparam) | 获取视频特效中指定 `float` 类型参数的值。 |
| [getVideoEffectIntParam](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/video-enhance-option#api_ivideoeffectobject_getvideoeffectintparam) | 获取视频特效中的整数类型参数。 |
| [performVideoEffectAction](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/video-enhance-option#api_ivideoeffectobject_performvideoeffectaction) | 对指定的视频特效节点执行操作。 |
| [removeVideoEffect](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/video-enhance-option#api_ivideoeffectobject_removevideoeffect) | 移除指定节点 ID 的视频特效。 |
| [setBeautyEffectOptions](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/video-enhance-option#api_irtcengine_setbeautyeffectoptions) | 设置美颜效果选项。 |
| [setColorEnhanceOptions](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/video-enhance-option#api_irtcengine_setcolorenhanceoptions) | 设置色彩增强功能。 |
| [setFaceShapeAreaOptions](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/video-enhance-option#api_irtcengine_setfaceshapeareaoptions) | 设置美型部位选项并指定媒体源。 |
| [setFaceShapeBeautyOptions](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/video-enhance-option#api_irtcengine_setfaceshapebeautyoptions) | 设置美型效果选项并指定媒体源。 |
| [setFilterEffectOptions](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/video-enhance-option#api_irtcengine_setfiltereffectoptions) | 设置滤镜效果选项并指定媒体源。 |
| [setLowlightEnhanceOptions](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/video-enhance-option#api_irtcengine_setlowlightenhanceoptions) | 设置暗光增强功能。 |
| [setVideoDenoiserOptions](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/video-enhance-option#api_irtcengine_setvideodenoiseroptions) | 设置视频降噪功能。 |
| [setVideoEffectBoolParam](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/video-enhance-option#api_ivideoeffectobject_setvideoeffectboolparam) | 设置视频特效的布尔参数。 |
| [setVideoEffectFloatParam](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/video-enhance-option#api_ivideoeffectobject_setvideoeffectfloatparam) | 设置视频特效的浮点参数。 |
| [setVideoEffectIntParam](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/video-enhance-option#api_ivideoeffectobject_setvideoeffectintparam) | [setVideoEffectIntParam](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/video-enhance-option#api_ivideoeffectobject_setvideoeffectintparam)：设置视频特效的整数参数。 |

<a id="rtc_api_overview__toc_face_detection"></a>

## 人脸检测 [#人脸检测]

| API | 描述 |
| --- | --- |
| [enableFaceDetection](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/face-detection#api_irtcengine_enablefacedetection) | 开启/关闭本地人脸检测。 |
| [onFacePositionChanged](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/face-detection#callback_irtcengineeventhandler_onfacepositionchanged) | 报告本地人脸检测结果。 |

<a id="rtc_api_overview__toc_speech_driven"></a>

## 语音驱动 [#语音驱动]

| API | 描述 |
| --- | --- |
| [registerFaceInfoObserver](/zh-CN/api-reference/rtc/react-native/api-imediaengine-registerfaceinfoobserver) | 注册一个人脸信息观测器。 |
| [unregisterFaceInfoObserver](/zh-CN/api-reference/rtc/react-native/api-imediaengine-unregisterfaceinfoobserver) | 取消注册人脸信息观测器。 |
| [onFaceInfo](/zh-CN/api-reference/rtc/react-native/callback-ifaceinfoobserver-onfaceinfo) | 报告已获取语音驱动插件处理后的人脸信息。 |

<a id="rtc_api_overview__toc_center_stage"></a>

## 人像锁定 [#人像锁定]

| API | 描述 |
| --- | --- |
| [enableCameraCenterStage](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/center-stage#api_irtcengine_enablecameracenterstage) | 开启或关闭人像锁定功能。 |
| [isCameraCenterStageSupported](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/center-stage#api_irtcengine_iscameracenterstagesupported) | 查询摄像头是否支持人像锁定。 |

<a id="rtc_api_overview__toc_watermark"></a>

## 直播水印 [#直播水印]

| API | 描述 |
| --- | --- |
| [addVideoWatermarkWithConfig](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/watermark#api_irtcengine_addvideowatermark3) | 向本地视频流添加水印图像。 |
| [addVideoWatermarkWithConfigEx](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/watermark#api_irtcengineex_addvideowatermarkex1) | 向本地视频添加水印图像。 |
| [clearVideoWatermarkEx](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/watermark#api_irtcengineex_clearvideowatermarkex) | 删除已添加的视频水印。 |
| [clearVideoWatermarks](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/watermark#api_irtcengine_clearvideowatermarks) | 删除已添加的视频水印。 |
| [removeVideoWatermark](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/watermark#api_irtcengine_removevideowatermark) | 从本地视频中移除水印图像。 |
| [removeVideoWatermarkEx](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/watermark#api_irtcengineex_removevideowatermarkex) | 从本地或远端视频流中移除指定的水印图像。 |

<a id="rtc_api_overview__toc_image_source"></a>

## 垫片推流 [#垫片推流]

| API | 描述 |
| --- | --- |
| [enableVideoImageSource](/zh-CN/api-reference/rtc/react-native/video/video-prenpro/image-source#api_irtcengine_enablevideoimagesource) | 设置是否开启垫片推流功能。 |

<a id="rtc_api_overview__toc_video_rendering"></a>

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

| API | 描述 |
| --- | --- |
| [enableInstantMediaRendering](/zh-CN/api-reference/rtc/react-native/video/video-rendering#api_irtcengine_enableinstantmediarendering) | 开启音视频帧加速渲染。 |
| [setLocalRenderMode](/zh-CN/api-reference/rtc/react-native/video/video-rendering#api_irtcengine_setlocalrendermode2) | 更新本地视图显示模式。 |
| [setLocalRenderTargetFps](/zh-CN/api-reference/rtc/react-native/video/video-rendering#api_irtcengine_setlocalrendertargetfps) | 设置本地视频渲染的最大帧率。 |
| [setRemoteRenderMode](/zh-CN/api-reference/rtc/react-native/video/video-rendering#api_irtcengine_setremoterendermode2) | 更新远端视图显示模式。 |
| [setRemoteRenderModeEx](/zh-CN/api-reference/rtc/react-native/video/video-rendering#api_irtcengineex_setremoterendermodeex) | 设置远端视图显示模式。 |
| [setRemoteRenderTargetFps](/zh-CN/api-reference/rtc/react-native/video/video-rendering#api_irtcengine_setremoterendertargetfps) | 设置视频在远端渲染的最大帧率。 |
| [setRenderMode](/zh-CN/api-reference/rtc/react-native/video/video-rendering#api_imediaplayer_setrendermode) | 设置播放器视图的渲染模式。 |
| [startMediaRenderingTracing](/zh-CN/api-reference/rtc/react-native/video/video-rendering#api_irtcengine_startmediarenderingtracing) | 开启视频帧渲染数据打点。 |
| [startMediaRenderingTracingEx](/zh-CN/api-reference/rtc/react-native/video/video-rendering#api_irtcengineex_startmediarenderingtracingex) | 开启视频帧渲染数据打点。 |
| [onTranscodedStreamLayoutInfo](/zh-CN/api-reference/rtc/react-native/video/video-rendering#callback_irtcengineeventhandler_ontranscodedstreamlayoutinfo) | 已接收携带布局信息的合图视频流回调。 |
| [onVideoRenderingTracingResult](/zh-CN/api-reference/rtc/react-native/video/video-rendering#callback_irtcengineeventhandler_onvideorenderingtracingresult) | 视频帧渲染事件回调。 |

<a id="rtc_api_overview__toc_video_raw"></a>

## 原始视频数据 [#原始视频数据]

| API | 描述 |
| --- | --- |
| [registerVideoFrameObserver](/zh-CN/api-reference/rtc/react-native/video/video-raw#api_imediaengine_registervideoframeobserver) | 注册原始视频观测器对象。 |
| [unregisterVideoFrameObserver](/zh-CN/api-reference/rtc/react-native/video/video-raw#api_imediaengine_unregistervideoframeobserver_imediaengine) | 取消注册视频帧观测器。 |
| [onCaptureVideoFrame](/zh-CN/api-reference/rtc/react-native/video/video-raw#callback_ivideoframeobserver_oncapturevideoframe) | 获取本地设备采集到的视频数据。 |
| [onFrame](/zh-CN/api-reference/rtc/react-native/video/video-raw#callback_imediaplayervideoframeobserver_onframe_imediaplayervideoframeobserver) | 已获取视频帧回调。 |
| [onPreEncodeVideoFrame](/zh-CN/api-reference/rtc/react-native/video/video-raw#callback_ivideoframeobserver_onpreencodevideoframe) | 获取本地视频编码前的视频数据。 |
| [onRenderVideoFrame](/zh-CN/api-reference/rtc/react-native/video/video-raw#callback_ivideoframeobserver_onrendervideoframe) | 获取远端发送的视频数据。 |

<a id="rtc_api_overview__toc_video_encoded"></a>

## 已编码视频数据 [#已编码视频数据]

| API | 描述 |
| --- | --- |
| [addListener](/zh-CN/api-reference/rtc/react-native/video/video-encoded#api_imediaengine_addlistener_imediaengine) | 添加一个 [IMediaEngineEvent](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediaengineevent) 监听器。 |
| [registerVideoEncodedFrameObserver](/zh-CN/api-reference/rtc/react-native/video/video-encoded#api_imediaengine_registervideoencodedframeobserver) | 为编码后的视频图像注册视频帧接收观测器。 |
| [removeAllListeners](/zh-CN/api-reference/rtc/react-native/video/video-encoded#api_imediaengine_removealllisteners_imediaengine) | 移除指定事件的所有监听器。 |
| [removeListener](/zh-CN/api-reference/rtc/react-native/video/video-encoded#api_imediaengine_removelistener_imediaengine) | 移除指定的 [IMediaEngineEvent](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediaengineevent) 监听器。 |
| [unregisterVideoEncodedFrameObserver](/zh-CN/api-reference/rtc/react-native/video/video-encoded#api_imediaengine_unregistervideoencodedframeobserver) | 为编码后的视频图像取消注册视频帧接收观测器。 |
| [onEncodedVideoFrameReceived](/zh-CN/api-reference/rtc/react-native/video/video-encoded#callback_ivideoencodedframeobserver_onencodedvideoframereceived) | 报告接收端已收到远端发送的待解码视频帧。 |

<a id="rtc_api_overview__toc_video_custom_capturenrendering"></a>

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

| API | 描述 |
| --- | --- |
| [createCustomVideoTrack](/zh-CN/api-reference/rtc/react-native/video/video-custom-capturenrendering#api_irtcengine_createcustomvideotrack) | 创建一个自定义的视频轨道。 |
| [destroyCustomVideoTrack](/zh-CN/api-reference/rtc/react-native/video/video-custom-capturenrendering#api_irtcengine_destroycustomvideotrack) | 销毁指定的视频轨道。 |
| [isPipActivated](/zh-CN/api-reference/rtc/react-native/video/video-custom-capturenrendering#api_agorapip_ispipactivated) | 检查画中画模式是否已激活。 |
| [pipDispose](/zh-CN/api-reference/rtc/react-native/video/video-custom-capturenrendering#api_agorapip_pipdispose) | 释放画中画相关的资源。 |
| [pipIsAutoEnterSupported](/zh-CN/api-reference/rtc/react-native/video/video-custom-capturenrendering#api_agorapip_pipisautoentersupported) | 检查是否支持自动进入画中画模式。 |
| [pipIsSupported](/zh-CN/api-reference/rtc/react-native/video/video-custom-capturenrendering#api_agorapip_pipissupported) | 检查当前设备是否支持画中画模式。 |
| [pipSetup](/zh-CN/api-reference/rtc/react-native/video/video-custom-capturenrendering#api_agorapip_pipsetup) | 配置画中画模式。 |
| [pipStart](/zh-CN/api-reference/rtc/react-native/video/video-custom-capturenrendering#api_agorapip_pipstart) | 启动画中画模式。 |
| [pipStop](/zh-CN/api-reference/rtc/react-native/video/video-custom-capturenrendering#api_agorapip_pipstop) | 停止画中画模式。 |
| [pushVideoFrame](/zh-CN/api-reference/rtc/react-native/video/video-custom-capturenrendering#api_imediaengine_pushvideoframe) | 将外部原始视频帧通过自定义视频轨道发布到频道中。 |
| [registerPipStateChangedObserver](/zh-CN/api-reference/rtc/react-native/video/video-custom-capturenrendering#api_agorapip_registerpipstatechangedobserver) | 注册画中画状态改变观测器。 |
| [release](/zh-CN/api-reference/rtc/react-native/video/video-custom-capturenrendering#api_agorapip_release_agorapip) | 释放画中画相关的资源。 |
| [setExternalRemoteEglContext](/zh-CN/api-reference/rtc/react-native/video/video-custom-capturenrendering#api_irtcengine_setexternalremoteeglcontext) | 设置远端视频流渲染的 EGL 环境上下文。 |
| [setExternalVideoSource](/zh-CN/api-reference/rtc/react-native/video/video-custom-capturenrendering#api_imediaengine_setexternalvideosource) | 设置外部视频源。 |
| [unregisterPipStateChangedObserver](/zh-CN/api-reference/rtc/react-native/video/video-custom-capturenrendering#api_agorapip_unregisterpipstatechangedobserver) | 取消注册画中画状态改变观测器。 |
| [onPipStateChanged](/zh-CN/api-reference/rtc/react-native/video/video-custom-capturenrendering#callback_agorapipstatechangedobserver_onpipstatechanged) | 画中画状态改变回调。 |

<a id="rtc_api_overview__toc_audio_mixing"></a>

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

| API | 描述 |
| --- | --- |
| [adjustAudioMixingPlayoutVolume](/zh-CN/api-reference/rtc/react-native/play/audio-mixing#api_irtcengine_adjustaudiomixingplayoutvolume) | 调节音乐文件在本地播放的音量。 |
| [adjustAudioMixingPublishVolume](/zh-CN/api-reference/rtc/react-native/play/audio-mixing#api_irtcengine_adjustaudiomixingpublishvolume) | 调节音乐文件远端播放音量。 |
| [adjustAudioMixingVolume](/zh-CN/api-reference/rtc/react-native/play/audio-mixing#api_irtcengine_adjustaudiomixingvolume) | 调节音乐文件的播放音量。 |
| [getAudioMixingCurrentPosition](/zh-CN/api-reference/rtc/react-native/play/audio-mixing#api_irtcengine_getaudiomixingcurrentposition) | 获取音乐文件的播放进度。 |
| [getAudioMixingDuration](/zh-CN/api-reference/rtc/react-native/play/audio-mixing#api_irtcengine_getaudiomixingduration) | 获取音乐文件总时长。 |
| [getAudioMixingPlayoutVolume](/zh-CN/api-reference/rtc/react-native/play/audio-mixing#api_irtcengine_getaudiomixingplayoutvolume) | 获取音乐文件的本地播放音量。 |
| [getAudioMixingPublishVolume](/zh-CN/api-reference/rtc/react-native/play/audio-mixing#api_irtcengine_getaudiomixingpublishvolume) | 获取音乐文件的远端播放音量。 |
| [getAudioTrackCount](/zh-CN/api-reference/rtc/react-native/play/audio-mixing#api_irtcengine_getaudiotrackcount) | 获取当前音乐文件的音轨索引。 |
| [pauseAudioMixing](/zh-CN/api-reference/rtc/react-native/play/audio-mixing#api_irtcengine_pauseaudiomixing) | 暂停播放音乐文件。 |
| [resumeAudioMixing](/zh-CN/api-reference/rtc/react-native/play/audio-mixing#api_irtcengine_resumeaudiomixing) | 恢复播放音乐文件。 |
| [selectAudioTrack](/zh-CN/api-reference/rtc/react-native/play/audio-mixing#api_irtcengine_selectaudiotrack) | 指定当前音乐文件的播放音轨。 |
| [selectMultiAudioTrack](/zh-CN/api-reference/rtc/react-native/play/audio-mixing#api_imediaplayer_selectmultiaudiotrack) | 选择本地播放和发送至远端的音轨。 |
| [setAudioMixingDualMonoMode](/zh-CN/api-reference/rtc/react-native/play/audio-mixing#api_irtcengine_setaudiomixingdualmonomode) | 设置当前音频文件的声道模式。 |
| [setAudioMixingPitch](/zh-CN/api-reference/rtc/react-native/play/audio-mixing#api_irtcengine_setaudiomixingpitch) | 调整本地播放的音乐文件的音调。 |
| [setAudioMixingPlaybackSpeed](/zh-CN/api-reference/rtc/react-native/play/audio-mixing#api_irtcengine_setaudiomixingplaybackspeed) | 设置当前音乐文件的播放速度。 |
| [setAudioMixingPosition](/zh-CN/api-reference/rtc/react-native/play/audio-mixing#api_irtcengine_setaudiomixingposition) | 设置音乐文件的播放位置。 |
| [startAudioMixing](/zh-CN/api-reference/rtc/react-native/play/audio-mixing#api_irtcengine_startaudiomixing2) | 开始播放音乐文件。 |
| [stopAudioMixing](/zh-CN/api-reference/rtc/react-native/play/audio-mixing#api_irtcengine_stopaudiomixing) | 停止播放音乐文件。 |
| [onAudioMixingPositionChanged](/zh-CN/api-reference/rtc/react-native/play/audio-mixing#callback_irtcengineeventhandler_onaudiomixingpositionchanged) | 音乐文件播放进度回调。 |
| [onAudioMixingStateChanged](/zh-CN/api-reference/rtc/react-native/play/audio-mixing#callback_irtcengineeventhandler_onaudiomixingstatechanged) | 音乐文件的播放状态已改变回调。 |

<a id="rtc_api_overview__toc_audio_effect_file"></a>

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

| API | 描述 |
| --- | --- |
| [getEffectCurrentPosition](/zh-CN/api-reference/rtc/react-native/play/audio-effect-file#api_irtcengine_geteffectcurrentposition) | 获取指定音效文件的播放进度。 |
| [getEffectDuration](/zh-CN/api-reference/rtc/react-native/play/audio-effect-file#api_irtcengine_geteffectduration) | 获取指定音效文件总时长。 |
| [getEffectsVolume](/zh-CN/api-reference/rtc/react-native/play/audio-effect-file#api_irtcengine_geteffectsvolume) | 获取音效文件的播放音量。 |
| [getVolumeOfEffect](/zh-CN/api-reference/rtc/react-native/play/audio-effect-file#api_irtcengine_getvolumeofeffect) | 获取指定音效文件的播放音量。 |
| [pauseAllEffects](/zh-CN/api-reference/rtc/react-native/play/audio-effect-file#api_irtcengine_pausealleffects) | 暂停所有音效文件播放。 |
| [pauseEffect](/zh-CN/api-reference/rtc/react-native/play/audio-effect-file#api_irtcengine_pauseeffect) | 暂停音效文件播放。 |
| [playAllEffects](/zh-CN/api-reference/rtc/react-native/play/audio-effect-file#api_irtcengine_playalleffects) | 播放所有音效文件。 |
| [playEffect](/zh-CN/api-reference/rtc/react-native/play/audio-effect-file#api_irtcengine_playeffect3) | 播放指定的本地或在线音效文件。 |
| [playEffectEx](/zh-CN/api-reference/rtc/react-native/play/audio-effect-file#api_irtcengineex_playeffectex) | 在频道中播放指定音效。 |
| [preloadEffect](/zh-CN/api-reference/rtc/react-native/play/audio-effect-file#api_irtcengine_preloadeffect) | 将音效文件加载至内存。 |
| [preloadEffectEx](/zh-CN/api-reference/rtc/react-native/play/audio-effect-file#api_irtcengineex_preloadeffectex) | 将指定音效预加载到频道中。 |
| [resumeAllEffects](/zh-CN/api-reference/rtc/react-native/play/audio-effect-file#api_irtcengine_resumealleffects) | 恢复播放所有音效文件。 |
| [resumeEffect](/zh-CN/api-reference/rtc/react-native/play/audio-effect-file#api_irtcengine_resumeeffect) | 恢复播放指定音效文件。 |
| [setEffectPosition](/zh-CN/api-reference/rtc/react-native/play/audio-effect-file#api_irtcengine_seteffectposition) | 设置指定音效文件的播放位置。 |
| [setEffectsVolume](/zh-CN/api-reference/rtc/react-native/play/audio-effect-file#api_irtcengine_seteffectsvolume) | 设置音效文件的播放音量。 |
| [setVolumeOfEffect](/zh-CN/api-reference/rtc/react-native/play/audio-effect-file#api_irtcengine_setvolumeofeffect) | 设置指定音效文件的播放音量。 |
| [stopAllEffects](/zh-CN/api-reference/rtc/react-native/play/audio-effect-file#api_irtcengine_stopalleffects) | 停止播放所有音效文件。 |
| [stopEffect](/zh-CN/api-reference/rtc/react-native/play/audio-effect-file#api_irtcengine_stopeffect) | 停止播放指定音效文件。 |
| [unloadAllEffects](/zh-CN/api-reference/rtc/react-native/play/audio-effect-file#api_irtcengine_unloadalleffects) | 从内存释放所有预加载音效文件。 |
| [unloadEffect](/zh-CN/api-reference/rtc/react-native/play/audio-effect-file#api_irtcengine_unloadeffect) | 从内存释放某个预加载的音效文件。 |
| [onAudioEffectFinished](/zh-CN/api-reference/rtc/react-native/play/audio-effect-file#callback_irtcengineeventhandler_onaudioeffectfinished) | 本地音效文件播放已结束回调。 |

<a id="rtc_api_overview__toc_mediaplayer_initialize"></a>

## 初始化 [#初始化]

| API | 描述 |
| --- | --- |
| [addListener](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-initialize#api_imediaplayer_addlistener_imediaplayer) | 添加一个 [IMediaPlayerEvent](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediaplayerevent) 监听器。 |
| [createMediaPlayer](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-initialize#api_irtcengine_createmediaplayer) | 创建媒体播放器对象。 |
| [destroyMediaPlayer](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-initialize#api_irtcengine_destroymediaplayer) | 销毁媒体播放器。 |
| [getMediaPlayerCacheManager](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-initialize#api_imediaplayercachemanager_getmediaplayercachemanager) | 获取 [IMediaPlayerCacheManager](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediaplayercachemanager) 实例。 |
| [removeAllListeners](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-initialize#api_imediaplayer_removealllisteners_imediaplayer) | 移除指定事件的所有监听器。 |
| [removeListener](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-initialize#api_imediaplayer_removelistener_imediaplayer) | 移除指定的 [IMediaPlayerEvent](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediaplayerevent) 监听器。 |

<a id="rtc_api_overview__toc_mediaplayer_open"></a>

## 媒体资源打开 [#媒体资源打开]

| API | 描述 |
| --- | --- |
| [open](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-open#api_imediaplayer_open) | 打开媒体资源。 |
| [openWithMediaSource](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-open#api_imediaplayer_openwithmediasource) | 打开媒体资源并进行播放设置。 |
| [preloadSrc](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-open#api_imediaplayer_preloadsrc) | 预加载媒体资源。 |
| [switchSrc](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-open#api_imediaplayer_switchsrc) | 切换媒体资源。 |
| [unloadSrc](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-open#api_imediaplayer_unloadsrc) | 释放预加载的媒体资源。 |

<a id="rtc_api_overview__toc_mediaplayer_playnrender"></a>

## 媒体资源播放和渲染 [#媒体资源播放和渲染]

| API | 描述 |
| --- | --- |
| [selectAudioTrack](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-playnrender#api_imediaplayer_selectaudiotrack_imediaplayer) | 指定当前音频文件的播放音轨。 |
| [setAudioDualMonoMode](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-playnrender#api_imediaplayer_setaudiodualmonomode) | 设置当前音频文件的声道模式。 |
| [setAudioPitch](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-playnrender#api_imediaplayer_setaudiopitch) | 调整当前播放的媒体资源的音调。 |
| [setLoopCount](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-playnrender#api_imediaplayer_setloopcount) | 设置循环播放。 |
| [setPlaybackSpeed](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-playnrender#api_imediaplayer_setplaybackspeed) | 设置当前音频文件的播放速度。 |
| [setPlayerOptionInInt](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-playnrender#api_imediaplayer_setplayeroption) | 设置媒体播放器选项。 |
| [setPlayerOptionInString](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-playnrender#api_imediaplayer_setplayeroption2) | 设置媒体播放器选项。 |
| [setView](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-playnrender#api_imediaplayer_setview) | 设置播放器渲染视图。 |

<a id="rtc_api_overview__toc_mediaplayer_control"></a>

## 播放器控制 [#播放器控制]

| API | 描述 |
| --- | --- |
| [adjustPlayoutVolume](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-control#api_imediaplayer_adjustplayoutvolume) | 调节本地播放音量。 |
| [adjustPublishSignalVolume](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-control#api_imediaplayer_adjustpublishsignalvolume) | 调节远端用户听到的音量。 |
| [mute](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-control#api_imediaplayer_mute) | 设置是否静音。 |
| [pause](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-control#api_imediaplayer_pause) | 暂停播放。 |
| [play](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-control#api_imediaplayer_play) | 播放媒体文件。 |
| [playPreloadedSrc](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-control#api_imediaplayer_playpreloadedsrc) | 播放预加载的媒体资源。 |
| [resume](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-control#api_imediaplayer_resume) | 暂停后恢复播放。 |
| [seek](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-control#api_imediaplayer_seek) | 定位到媒体文件的指定播放位置。 |
| [stop](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-control#api_imediaplayer_stop) | 停止播放。 |

<a id="rtc_api_overview__toc_mediaplayer_info"></a>

## 播放信息获取 [#播放信息获取]

| API | 描述 |
| --- | --- |
| [getAudioBufferDelay](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-info#api_imediaplayer_getaudiobufferdelay) | 获取播放媒体文件时的音频缓冲延迟。 |
| [getDuration](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-info#api_imediaplayer_getduration) | 获取媒体文件总时长。 |
| [getMediaPlayerId](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-info#api_imediaplayer_getmediaplayerid) | 获取播放器 ID。 |
| [getMute](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-info#api_imediaplayer_getmute) | 获取当前播放的媒体文件是否静音。 |
| [getPlayoutVolume](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-info#api_imediaplayer_getplayoutvolume) | 获取当前本地播放音量。 |
| [getPlayPosition](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-info#api_imediaplayer_getplayposition) | 获取当前播放进度。 |
| [getPlaySrc](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-info#api_imediaplayer_getplaysrc_imediaplayer) | 获取播放的媒体资源的路径。 |
| [getPublishSignalVolume](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-info#api_imediaplayer_getpublishsignalvolume) | 获取远端用户听到的音量。 |
| [getState](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-info#api_imediaplayer_getstate) | 获取播放器当前状态。 |
| [getStreamCount](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-info#api_imediaplayer_getstreamcount) | 获取当前媒体文件中媒体流的数量。 |
| [getStreamInfo](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-info#api_imediaplayer_getstreaminfo) | 通过媒体流的索引值获取媒体流信息。 |
| [onPlayerPlaybackStats](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-info#callback_imediaplayersourceobserver_onplayerplaybackstats) | 报告当前播放的媒体资源的相关信息。 |

<a id="rtc_api_overview__toc_mediaplayer_observer"></a>

## 音视频观测器 [#音视频观测器]

| API | 描述 |
| --- | --- |
| [registerAudioFrameObserver](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-observer#api_imediaplayer_registeraudioframeobserver2_imediaplayer) | 注册音频帧观测器。 |
| [registerPlayerSourceObserver](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-observer#api_imediaplayer_registerplayersourceobserver) | 注册一个播放观测器。 |
| [registerVideoFrameObserver](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-observer#api_imediaplayer_registervideoframeobserver_imediaplayer) | 注册视频帧观测器。 |
| [unregisterAudioFrameObserver](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-observer#api_imediaplayer_unregisteraudioframeobserver_imediaplayer) | 取消注册音频帧观测器。 |
| [unregisterPlayerSourceObserver](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-observer#api_imediaplayer_unregisterplayersourceobserver) | 取消注册播放观测器。 |
| [unregisterVideoFrameObserver](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-observer#api_imediaplayer_unregistervideoframeobserver_imediaplayer) | 取消注册视频帧观测器。 |
| [onAudioVolumeIndication](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-observer#callback_imediaplayersourceobserver_onaudiovolumeindication_imediaplayersourceobserver) | 媒体播放器音量提示回调。 |
| [onFrame](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-observer#callback_iaudiopcmframesink_onframe_iaudiopcmframesink) | 已获取音频帧回调。 |
| [onMetaData](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-observer#callback_imediaplayersourceobserver_onmetadata) | 报告已获取媒体附属信息。 |
| [onPlayBufferUpdated](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-observer#callback_imediaplayersourceobserver_onplaybufferupdated) | 报告当前缓冲数据能播放的时间。 |
| [onPlayerEvent](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-observer#callback_imediaplayersourceobserver_onplayerevent) | 报告播放器的事件。 |
| [onPlayerInfoUpdated](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-observer#callback_imediaplayersourceobserver_onplayerinfoupdated) | 媒体播放器相关信息发生改变回调。 |
| [onPlayerSourceStateChanged](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-observer#callback_imediaplayersourceobserver_onplayersourcestatechanged) | 报告播放器状态改变。 |
| [onPlayerSrcInfoChanged](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-observer#callback_imediaplayersourceobserver_onplayersrcinfochanged) | 媒体资源视频码率变化回调。 |
| [onPositionChanged](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-observer#callback_imediaplayersourceobserver_onpositionchanged) | 报告当前媒体资源的播放进度。 |
| [onPreloadEvent](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-observer#callback_imediaplayersourceobserver_onpreloadevent) | 报告预加载媒体资源的事件。 |

<a id="rtc_api_overview__toc_mediaplayer_cache"></a>

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

| API | 描述 |
| --- | --- |
| [enableAutoRemoveCache](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-cache#api_imediaplayercachemanager_enableautoremovecache) | 设置是否开启自动清除缓存文件功能。 |
| [getCacheDir](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-cache#api_imediaplayercachemanager_getcachedir) | 获取缓存文件的储存路径。 |
| [getCacheFileCount](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-cache#api_imediaplayercachemanager_getcachefilecount) | 获取当前已缓存的媒体文件的总数量。 |
| [getMaxCacheFileCount](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-cache#api_imediaplayercachemanager_getmaxcachefilecount) | 获取所设置的缓存文件数量上限。 |
| [getMaxCacheFileSize](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-cache#api_imediaplayercachemanager_getmaxcachefilesize) | 获取所设置的缓存文件总缓存的上限。 |
| [removeAllCaches](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-cache#api_imediaplayercachemanager_removeallcaches) | 删除媒体播放器中所有已缓存的媒体文件。 |
| [removeCacheByUri](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-cache#api_imediaplayercachemanager_removecachebyuri) | 删除指定的已缓存媒体文件。 |
| [removeOldCache](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-cache#api_imediaplayercachemanager_removeoldcache) | 删除媒体播放器中近期最少使用的一个缓存媒体文件。 |
| [setCacheDir](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-cache#api_imediaplayercachemanager_setcachedir) | 设置待缓存的媒体文件的储存路径。 |
| [setMaxCacheFileCount](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-cache#api_imediaplayercachemanager_setmaxcachefilecount) | 设置缓存媒体文件数量的上限。 |
| [setMaxCacheFileSize](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-cache#api_imediaplayercachemanager_setmaxcachefilesize) | 设置缓存媒体文件的总缓存大小的上限。 |
| [onPlayerCacheStats](/zh-CN/api-reference/rtc/react-native/play/mediaplayer/mediaplayer-cache#callback_imediaplayersourceobserver_onplayercachestats) | 报告当前缓存中的媒体资源的相关信息。 |

<a id="rtc_api_overview__toc_drm"></a>

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

| API | 描述 |
| --- | --- |
| [createMusicPlayer](/zh-CN/api-reference/rtc/react-native/play/drm#api_imusiccontentcenter_createmusicplayer) | 创建音乐播放器。 |
| [destroyMusicPlayer](/zh-CN/api-reference/rtc/react-native/play/drm#api_imusiccontentcenter_destroymusicplayer) | 销毁音乐播放器对象。 |
| [get](/zh-CN/api-reference/rtc/react-native/play/drm#api_musicchartcollection_get) | 获取音乐榜单的详细信息。 |
| [getCaches](/zh-CN/api-reference/rtc/react-native/play/drm#api_imusiccontentcenter_getcaches) | 获取已缓存的音乐资源信息。 |
| [getCount](/zh-CN/api-reference/rtc/react-native/play/drm#api_musicchartcollection_getcount_musicchartcollection) | 获取本次请求的音乐榜单数量。 |
| [getCount](/zh-CN/api-reference/rtc/react-native/play/drm#api_musiccollection_getcount_musiccollection) | 获取本次请求的音乐数量。 |
| [getInternalSongCode](/zh-CN/api-reference/rtc/react-native/play/drm#api_imusiccontentcenter_getinternalsongcode) | 创建音乐资源的副歌片段编号。 |
| [getLyric](/zh-CN/api-reference/rtc/react-native/play/drm#api_imusiccontentcenter_getlyric) | 获取音乐资源的歌词下载地址。 |
| [getMusic](/zh-CN/api-reference/rtc/react-native/play/drm#api_musiccollection_getmusic_musiccollection) | 获取当前页面列表中音乐资源的详细信息。 |
| [getMusicCharts](/zh-CN/api-reference/rtc/react-native/play/drm#api_imusiccontentcenter_getmusiccharts) | 获取全部音乐榜单。 |
| [getMusicCollectionByMusicChartId](/zh-CN/api-reference/rtc/react-native/play/drm#api_imusiccontentcenter_getmusiccollectionbymusicchartid) | 通过音乐榜单的 ID 获取指定榜单的音乐资源列表。 |
| [getMusicContentCenter](/zh-CN/api-reference/rtc/react-native/play/drm#api_irtcengine_getmusiccontentcenter) | 获取 [IMusicContentCenter](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imusiccontentcenter)。 |
| [getPage](/zh-CN/api-reference/rtc/react-native/play/drm#api_musiccollection_getpage_musiccollection) | 获取音乐资源列表当前页的页码。 |
| [getPageSize](/zh-CN/api-reference/rtc/react-native/play/drm#api_musiccollection_getpagesize_musiccollection) | 获取 SDK 实际返回的音乐资源数量。 |
| [getSongSimpleInfo](/zh-CN/api-reference/rtc/react-native/play/drm#api_imusiccontentcenter_getsongsimpleinfo) | 获取某一音乐资源的详细信息。 |
| [getTotal](/zh-CN/api-reference/rtc/react-native/play/drm#api_musiccollection_gettotal_musiccollection) | 获取列表内音乐资源的总数量。 |
| [initialize](/zh-CN/api-reference/rtc/react-native/play/drm#api_imusiccontentcenter_initialize_imusiccontentcenter) | 初始化 [IMusicContentCenter](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imusiccontentcenter)。 |
| [isPreloaded](/zh-CN/api-reference/rtc/react-native/play/drm#api_imusiccontentcenter_ispreloaded) | 检测音乐资源是否已被预加载。 |
| [openWithSongCode](/zh-CN/api-reference/rtc/react-native/play/drm#api_imusicplayer_open_imusicplayer) | 通过音乐资源编号打开音乐资源。 |
| [Preload](/zh-CN/api-reference/rtc/react-native/play/drm#api_imusiccontentcenter_preload2) | 预加载音乐资源。 |
| [registerEventHandler](/zh-CN/api-reference/rtc/react-native/play/drm#api_imusiccontentcenter_registereventhandler_imusiccontentcenter) | 注册音乐内容中心回调事件。 |
| [release](/zh-CN/api-reference/rtc/react-native/play/drm#api_imusiccontentcenter_release_imusiccontentcenter) | 释放音乐内容中心所占用的所有资源。 |
| [removeCache](/zh-CN/api-reference/rtc/react-native/play/drm#api_imusiccontentcenter_removecache) | 删除已缓存的音乐资源。 |
| [renewToken](/zh-CN/api-reference/rtc/react-native/play/drm#api_imusiccontentcenter_renewtoken_imusiccontentcenter) | 更新 Token。 |
| [searchMusic](/zh-CN/api-reference/rtc/react-native/play/drm#api_imusiccontentcenter_searchmusic) | 搜索音乐资源。 |
| [setPlayMode](/zh-CN/api-reference/rtc/react-native/play/drm#api_imusicplayer_setplaymode) | 设置音乐资源的播放模式。 |
| [unregisterEventHandler](/zh-CN/api-reference/rtc/react-native/play/drm#api_imusiccontentcenter_unregistereventhandler_imusiccontentcenter) | 取消注册音乐内容中心事件回调。 |
| [onLyricResult](/zh-CN/api-reference/rtc/react-native/play/drm#callback_imusiccontentcentereventhandler_onlyricresult) | 歌词下载地址回调。 |
| [onMusicChartsResult](/zh-CN/api-reference/rtc/react-native/play/drm#callback_imusiccontentcentereventhandler_onmusicchartsresult) | 获取音乐榜单回调。 |
| [onMusicCollectionResult](/zh-CN/api-reference/rtc/react-native/play/drm#callback_imusiccontentcentereventhandler_onmusiccollectionresult) | 获取音乐资源列表回调。 |
| [onPreLoadEvent](/zh-CN/api-reference/rtc/react-native/play/drm#callback_imusiccontentcentereventhandler_onpreloadevent_imusiccontentcentereventhandler) | 报告预加载音乐资源的事件。 |
| [onSongSimpleInfoResult](/zh-CN/api-reference/rtc/react-native/play/drm#callback_imusiccontentcentereventhandler_onsongsimpleinforesult) | 音乐资源的详细信息回调。 |

<a id="rtc_api_overview__toc_recording"></a>

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

| API | 描述 |
| --- | --- |
| [addListener](/zh-CN/api-reference/rtc/react-native/recording#api_imediarecorder_addlistener_imediarecorder) | 添加一个 [IMediaRecorderEvent](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediarecorderevent) 监听器。 |
| [createMediaRecorder](/zh-CN/api-reference/rtc/react-native/recording#api_irtcengine_createmediarecorder) | 创建音视频录制对象。 |
| [destroyMediaRecorder](/zh-CN/api-reference/rtc/react-native/recording#api_irtcengine_destroymediarecorder) | 销毁音视频录制对象。 |
| [removeAllListeners](/zh-CN/api-reference/rtc/react-native/recording#api_imediarecorder_removealllisteners_imediarecorder) | 移除指定事件的所有监听器。 |
| [removeListener](/zh-CN/api-reference/rtc/react-native/recording#api_imediarecorder_removelistener_imediarecorder) | 移除指定的 [IMediaRecorderEvent](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediarecorderevent) 监听器。 |
| [setMediaRecorderObserver](/zh-CN/api-reference/rtc/react-native/recording#api_imediarecorder_setmediarecorderobserver) | 注册 [IMediaRecorderObserver](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_imediarecorderobserver) 观测器。 |
| [startAudioRecording](/zh-CN/api-reference/rtc/react-native/recording#api_irtcengine_startaudiorecording3) | 开始客户端录音并进行录音配置。 |
| [startRecording](/zh-CN/api-reference/rtc/react-native/recording#api_imediarecorder_startrecording) | 开启音视频流录制。 |
| [stopAudioRecording](/zh-CN/api-reference/rtc/react-native/recording#api_irtcengine_stopaudiorecording) | 停止客户端录音。 |
| [stopRecording](/zh-CN/api-reference/rtc/react-native/recording#api_imediarecorder_stoprecording) | 停止音视频流录制。 |
| [onRecorderInfoUpdated](/zh-CN/api-reference/rtc/react-native/recording#callback_imediarecorderobserver_onrecorderinfoupdated) | 录制信息更新回调。 |
| [onRecorderStateChanged](/zh-CN/api-reference/rtc/react-native/recording#callback_imediarecorderobserver_onrecorderstatechanged) | 录制状态发生改变回调。 |

<a id="rtc_api_overview__toc_channel_media_relay"></a>

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

| API | 描述 |
| --- | --- |
| [pauseAllChannelMediaRelay](/zh-CN/api-reference/rtc/react-native/cloud-media-relay/channel-media-relay#api_irtcengine_pauseallchannelmediarelay) | 暂停向所有目标频道转发媒体流。 |
| [pauseAllChannelMediaRelayEx](/zh-CN/api-reference/rtc/react-native/cloud-media-relay/channel-media-relay#api_irtcengineex_pauseallchannelmediarelayex) | 暂停向所有目标频道转发媒体流。 |
| [resumeAllChannelMediaRelay](/zh-CN/api-reference/rtc/react-native/cloud-media-relay/channel-media-relay#api_irtcengine_resumeallchannelmediarelay) | 恢复向所有目标频道转发媒体流。 |
| [resumeAllChannelMediaRelayEx](/zh-CN/api-reference/rtc/react-native/cloud-media-relay/channel-media-relay#api_irtcengineex_resumeallchannelmediarelayex) | 恢复向所有目标频道转发媒体流。 |
| [startOrUpdateChannelMediaRelay](/zh-CN/api-reference/rtc/react-native/cloud-media-relay/channel-media-relay#api_irtcengine_startorupdatechannelmediarelay) | 开始或更新跨频道媒体流转发。 |
| [startOrUpdateChannelMediaRelayEx](/zh-CN/api-reference/rtc/react-native/cloud-media-relay/channel-media-relay#api_irtcengineex_startorupdatechannelmediarelayex) | 开始或更新跨频道媒体流转发。 |
| [stopChannelMediaRelay](/zh-CN/api-reference/rtc/react-native/cloud-media-relay/channel-media-relay#api_irtcengine_stopchannelmediarelay) | 停止跨频道媒体流转发。一旦停止，主播会退出所有目标频道。 |
| [stopChannelMediaRelayEx](/zh-CN/api-reference/rtc/react-native/cloud-media-relay/channel-media-relay#api_irtcengineex_stopchannelmediarelayex) | 停止跨频道媒体流转发。一旦停止，主播会退出所有目标频道。 |
| [onChannelMediaRelayStateChanged](/zh-CN/api-reference/rtc/react-native/cloud-media-relay/channel-media-relay#callback_irtcengineeventhandler_onchannelmediarelaystatechanged) | 跨频道媒体流转发状态发生改变回调。 |

<a id="rtc_api_overview__toc_media_push"></a>

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

| API | 描述 |
| --- | --- |
| [startRtmpStreamWithoutTranscoding](/zh-CN/api-reference/rtc/react-native/cloud-media-relay/media-push#api_irtcengine_startrtmpstreamwithouttranscoding) | 开始非转码推流。 |
| [startRtmpStreamWithoutTranscodingEx](/zh-CN/api-reference/rtc/react-native/cloud-media-relay/media-push#api_irtcengineex_startrtmpstreamwithouttranscodingex) | 开始非转码推流。 |
| [startRtmpStreamWithTranscoding](/zh-CN/api-reference/rtc/react-native/cloud-media-relay/media-push#api_irtcengine_startrtmpstreamwithtranscoding) | 开始旁路推流并设置转码属性。 |
| [startRtmpStreamWithTranscodingEx](/zh-CN/api-reference/rtc/react-native/cloud-media-relay/media-push#api_irtcengineex_startrtmpstreamwithtranscodingex) | 开始旁路推流并设置转码属性。 |
| [stopRtmpStream](/zh-CN/api-reference/rtc/react-native/cloud-media-relay/media-push#api_irtcengine_stoprtmpstream) | 结束旁路推流。 |
| [stopRtmpStreamEx](/zh-CN/api-reference/rtc/react-native/cloud-media-relay/media-push#api_irtcengineex_stoprtmpstreamex) | 结束旁路推流。 |
| [updateRtmpTranscoding](/zh-CN/api-reference/rtc/react-native/cloud-media-relay/media-push#api_irtcengine_updatertmptranscoding) | 更新旁路推流转码属性。 |
| [updateRtmpTranscodingEx](/zh-CN/api-reference/rtc/react-native/cloud-media-relay/media-push#api_irtcengineex_updatertmptranscodingex) | 更新旁路推流转码属性。 |
| [onRtmpStreamingEvent](/zh-CN/api-reference/rtc/react-native/cloud-media-relay/media-push#callback_irtcengineeventhandler_onrtmpstreamingevent) | 旁路推流事件回调。 |
| [onRtmpStreamingStateChanged](/zh-CN/api-reference/rtc/react-native/cloud-media-relay/media-push#callback_irtcengineeventhandler_onrtmpstreamingstatechanged) | 旁路推流状态发生改变回调。 |
| [onTranscodingUpdated](/zh-CN/api-reference/rtc/react-native/cloud-media-relay/media-push#callback_irtcengineeventhandler_ontranscodingupdated) | 旁路推流转码设置已被更新回调。 |

<a id="rtc_api_overview__toc_datastream"></a>

## 数据流 Datastream [#数据流-datastream]

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

<a id="rtc_api_overview__toc_metadata_observer"></a>

## 媒体流附属信息分发 [#媒体流附属信息分发]

| API | 描述 |
| --- | --- |
| [registerMediaMetadataObserver](/zh-CN/api-reference/rtc/react-native/metadata/metadata-observer#api_irtcengine_registermediametadataobserver) | 注册媒体 metadata 观测器用于接收或发送 metadata。 |
| [sendMetaData](/zh-CN/api-reference/rtc/react-native/metadata/metadata-observer#api_irtcengine_sendmetadata) | 发送媒体附属信息。 |
| [setMaxMetadataSize](/zh-CN/api-reference/rtc/react-native/metadata/metadata-observer#api_irtcengine_setmaxmetadatasize) | 设置媒体附属信息的最大大小。 |
| [unregisterMediaMetadataObserver](/zh-CN/api-reference/rtc/react-native/metadata/metadata-observer#api_irtcengine_unregistermediametadataobserver) | 取消注册媒体 metadata 观测器。 |
| [onMetadataReceived](/zh-CN/api-reference/rtc/react-native/metadata/metadata-observer#callback_imetadataobserver_onmetadatareceived) | 接收端已收到 metadata。 |

<a id="rtc_api_overview__toc_audio_route"></a>

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

| API | 描述 |
| --- | --- |
| [isSpeakerphoneEnabled](/zh-CN/api-reference/rtc/react-native/device-management/audio-route#api_irtcengine_isspeakerphoneenabled) | 检查扬声器状态启用状态。 |
| [setDefaultAudioRouteToSpeakerphone](/zh-CN/api-reference/rtc/react-native/device-management/audio-route#api_irtcengine_setdefaultaudioroutetospeakerphone) | 设置默认的音频路由。 |
| [setEnableSpeakerphone](/zh-CN/api-reference/rtc/react-native/device-management/audio-route#api_irtcengine_setenablespeakerphone) | 开启或关闭扬声器播放。 |
| [setRouteInCommunicationMode](/zh-CN/api-reference/rtc/react-native/device-management/audio-route#api_irtcengine_setrouteincommunicationmode) | 选择通话音量模式下的音频路由。 |
| [onAudioRoutingChanged](/zh-CN/api-reference/rtc/react-native/device-management/audio-route#callback_irtcengineeventhandler_onaudioroutingchanged) | 音频路由已发生变化回调。 |

<a id="rtc_api_overview__toc_video_device"></a>

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

| API | 描述 |
| --- | --- |
| [enableMultiCamera](/zh-CN/api-reference/rtc/react-native/device-management/video-device#api_irtcengine_enablemulticamera) | 开启或关闭多路摄像头采集。 |
| [getCameraMaxZoomFactor](/zh-CN/api-reference/rtc/react-native/device-management/video-device#api_irtcengine_getcameramaxzoomfactor) | 获取摄像头支持的最大放大倍率。 |
| [getVideoDeviceManager](/zh-CN/api-reference/rtc/react-native/device-management/video-device#api_irtcengine_getvideodevicemanager) | 获取 `IVideoDeviceManager` 对象，以管理视频设备。 |
| [isCameraAutoExposureFaceModeSupported](/zh-CN/api-reference/rtc/react-native/device-management/video-device#api_irtcengine_iscameraautoexposurefacemodesupported) | 检测设备是否支持自动曝光功能。 |
| [isCameraAutoFocusFaceModeSupported](/zh-CN/api-reference/rtc/react-native/device-management/video-device#api_irtcengine_iscameraautofocusfacemodesupported) | 检测设备是否支持人脸对焦功能。 |
| [isCameraExposurePositionSupported](/zh-CN/api-reference/rtc/react-native/device-management/video-device#api_irtcengine_iscameraexposurepositionsupported) | 检测设备是否支持手动曝光功能。 |
| [isCameraExposureSupported](/zh-CN/api-reference/rtc/react-native/device-management/video-device#api_irtcengine_iscameraexposuresupported) | 查询当前摄像头是否支持曝光调节。 |
| [isCameraFaceDetectSupported](/zh-CN/api-reference/rtc/react-native/device-management/video-device#api_irtcengine_iscamerafacedetectsupported) | 检查设备摄像头是否支持人脸检测。 |
| [isCameraFocusSupported](/zh-CN/api-reference/rtc/react-native/device-management/video-device#api_irtcengine_iscamerafocussupported) | 检测设备是否支持手动对焦功能。 |
| [isCameraTorchSupported](/zh-CN/api-reference/rtc/react-native/device-management/video-device#api_irtcengine_iscameratorchsupported) | 检测设备是否支持闪光灯常开。 |
| [isCameraZoomSupported](/zh-CN/api-reference/rtc/react-native/device-management/video-device#api_irtcengine_iscamerazoomsupported) | 检测设备是否支持摄像头缩放功能。 |
| [queryCameraFocalLengthCapability](/zh-CN/api-reference/rtc/react-native/device-management/video-device#api_irtcengine_querycamerafocallengthcapability) | 查询摄像头支持的焦距能力。 |
| [queryCodecCapability](/zh-CN/api-reference/rtc/react-native/device-management/video-device#api_irtcengine_querycodeccapability) | 查询 SDK 支持的视频编解码能力。 |
| [setCameraAutoExposureFaceModeEnabled](/zh-CN/api-reference/rtc/react-native/device-management/video-device#api_irtcengine_setcameraautoexposurefacemodeenabled) | 设置是否开启自动曝光功能。 |
| [setCameraAutoFocusFaceModeEnabled](/zh-CN/api-reference/rtc/react-native/device-management/video-device#api_irtcengine_setcameraautofocusfacemodeenabled) | 设置是否开启人脸对焦功能。 |
| [setCameraCapturerConfiguration](/zh-CN/api-reference/rtc/react-native/device-management/video-device#api_irtcengine_setcameracapturerconfiguration) | 设置摄像头采集配置。 |
| [setCameraDeviceOrientation](/zh-CN/api-reference/rtc/react-native/device-management/video-device#api_irtcengine_setcameradeviceorientation) | 设置采集视频的旋转角度。 |
| [setCameraExposureFactor](/zh-CN/api-reference/rtc/react-native/device-management/video-device#api_irtcengine_setcameraexposurefactor) | 设置当前摄像头的曝光系数。 |
| [setCameraExposurePosition](/zh-CN/api-reference/rtc/react-native/device-management/video-device#api_irtcengine_setcameraexposureposition) | 设置手动曝光位置。 |
| [setCameraFocusPositionInPreview](/zh-CN/api-reference/rtc/react-native/device-management/video-device#api_irtcengine_setcamerafocuspositioninpreview) | 设置手动对焦位置，并触发对焦。 |
| [setCameraTorchOn](/zh-CN/api-reference/rtc/react-native/device-management/video-device#api_irtcengine_setcameratorchon) | 设置是否打开闪光灯。 |
| [setCameraZoomFactor](/zh-CN/api-reference/rtc/react-native/device-management/video-device#api_irtcengine_setcamerazoomfactor) | 设置摄像头放大比例。 |
| [switchCamera](/zh-CN/api-reference/rtc/react-native/device-management/video-device#api_irtcengine_switchcamera) | 切换前置/后置摄像头。 |
| [onCameraExposureAreaChanged](/zh-CN/api-reference/rtc/react-native/device-management/video-device#callback_irtcengineeventhandler_oncameraexposureareachanged) | 摄像头曝光区域已改变回调。 |
| [onCameraFocusAreaChanged](/zh-CN/api-reference/rtc/react-native/device-management/video-device#callback_irtcengineeventhandler_oncamerafocusareachanged) | 相机对焦区域已改变回调。 |

<a id="rtc_api_overview__toc_audio_device"></a>

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

| API | 描述 |
| --- | --- |
| [getAudioDeviceInfo](/zh-CN/api-reference/rtc/react-native/device-management/audio-device#api_irtcengine_getaudiodeviceinfo) | 获取音频设备信息。 |
| [getAudioDeviceManager](/zh-CN/api-reference/rtc/react-native/device-management/audio-device#api_irtcengine_getaudiodevicemanager) | 获取 [IAudioDeviceManager](/zh-CN/api-reference/rtc/react-native/rtc-interface-class#class_iaudiodevicemanager) 对象，以管理音频设备。 |
| [startPlaybackDeviceTest](/zh-CN/api-reference/rtc/react-native/device-management/audio-device#api_iaudiodevicemanager_startplaybackdevicetest) | 启动音频播放设备测试。 |
| [stopPlaybackDeviceTest](/zh-CN/api-reference/rtc/react-native/device-management/audio-device#api_iaudiodevicemanager_stopplaybackdevicetest) | 停止音频播放设备测试。 |

<a id="rtc_api_overview__toc_extension"></a>

## 插件 [#插件]

| API | 描述 |
| --- | --- |
| [enableExtension](/zh-CN/api-reference/rtc/react-native/extension#api_irtcengine_enableextension) | 启用/禁用插件。 |
| [getExtensionProperty](/zh-CN/api-reference/rtc/react-native/extension#api_irtcengine_getextensionproperty2) | 获取插件的详细信息。 |
| [loadExtensionProvider](/zh-CN/api-reference/rtc/react-native/extension#api_irtcengine_loadextensionprovider) | 加载插件。 |
| [registerExtension](/zh-CN/api-reference/rtc/react-native/extension#api_irtcengine_registerextension) | 注册插件。 |
| [setExtensionProperty](/zh-CN/api-reference/rtc/react-native/extension#api_irtcengine_setextensionproperty) | 设置插件的属性。 |
| [setExtensionProviderProperty](/zh-CN/api-reference/rtc/react-native/extension#api_irtcengine_setextensionproviderproperty) | 设置插件服务商的属性。 |
| [onExtensionErrorWithContext](/zh-CN/api-reference/rtc/react-native/extension#callback_irtcengineeventhandler_onextensionerrorwithcontext) | 插件出错回调。 |
| [onExtensionEventWithContext](/zh-CN/api-reference/rtc/react-native/extension#callback_irtcengineeventhandler_onextensioneventwithcontext) | 插件事件回调。 |
| [onExtensionStartedWithContext](/zh-CN/api-reference/rtc/react-native/extension#callback_irtcengineeventhandler_onextensionstartedwithcontext) | 插件已启用成功回调。 |
| [onExtensionStoppedWithContext](/zh-CN/api-reference/rtc/react-native/extension#callback_irtcengineeventhandler_onextensionstoppedwithcontext) | 插件已禁用回调。 |

<a id="rtc_api_overview__toc_network"></a>

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

| API | 描述 |
| --- | --- |
| [complain](/zh-CN/api-reference/rtc/react-native/network#api_irtcengine_complain) | 投诉通话质量。 |
| [enableEncryption](/zh-CN/api-reference/rtc/react-native/network#api_irtcengine_enableencryption) | 开启或关闭内置加密。 |
| [enableEncryptionEx](/zh-CN/api-reference/rtc/react-native/network#api_irtcengineex_enableencryptionex) | 开启或关闭内置加密。 |
| [getCallId](/zh-CN/api-reference/rtc/react-native/network#api_irtcengine_getcallid) | 获取通话 ID。 |
| [getCallIdEx](/zh-CN/api-reference/rtc/react-native/network#api_irtcengineex_getcallidex) | 使用连接 ID 获取通话 ID。 |
| [getConnectionState](/zh-CN/api-reference/rtc/react-native/network#api_irtcengine_getconnectionstate) | 获取当前网络连接状态。 |
| [getConnectionStateEx](/zh-CN/api-reference/rtc/react-native/network#api_irtcengineex_getconnectionstateex) | 获取当前网络连接状态。 |
| [getCurrentMonotonicTimeInMs](/zh-CN/api-reference/rtc/react-native/network#api_irtcengine_getcurrentmonotonictimeinms) | 获取 SDK 当前的 Monotonic Time。 |
| [getErrorDescription](/zh-CN/api-reference/rtc/react-native/network#api_irtcengine_geterrordescription) | 获取警告或错误描述。 |
| [getNativeHandle](/zh-CN/api-reference/rtc/react-native/network#api_irtcengine_getnativehandle) | 获取 Native SDK 的 C++ 句柄。 |
| [getNetworkType](/zh-CN/api-reference/rtc/react-native/network#api_irtcengine_getnetworktype) | 获取本地网络连接类型。 |
| [getNtpWallTimeInMs](/zh-CN/api-reference/rtc/react-native/network#api_irtcengine_getntpwalltimeinms) | 获取当前的 NTP (网络时间协议) 时间。 |
| [getVersion](/zh-CN/api-reference/rtc/react-native/network#api_irtcengine_getversion) | 获取 SDK 版本。 |
| [isFeatureAvailableOnDevice](/zh-CN/api-reference/rtc/react-native/network#api_irtcengine_isfeatureavailableondevice) | 查询设备是否支持指定进阶功能。 |
| [queryDeviceScore](/zh-CN/api-reference/rtc/react-native/network#api_irtcengine_querydevicescore) | 查询设备评分等级。 |
| [rate](/zh-CN/api-reference/rtc/react-native/network#api_irtcengine_rate) | 给通话评分。 |
| [sendCustomReportMessage](/zh-CN/api-reference/rtc/react-native/network#api_irtcengine_sendcustomreportmessage) | 发送自定义上报消息。 |
| [sendCustomReportMessageEx](/zh-CN/api-reference/rtc/react-native/network#api_irtcengineex_sendcustomreportmessageex) | 自定义数据上报和分析服务。 |
| [setAVSyncSource](/zh-CN/api-reference/rtc/react-native/network#api_irtcengine_setavsyncsource) | 设置发流端音画同步。 |
| [setCloudProxy](/zh-CN/api-reference/rtc/react-native/network#api_irtcengine_setcloudproxy) | 设置云代理服务。 |
| [setLocalAccessPoint](/zh-CN/api-reference/rtc/react-native/network#api_irtcengine_setlocalaccesspoint) | 配置与声网私有媒体服务器接入模块的连接。 |
| [setParameters](/zh-CN/api-reference/rtc/react-native/network#api_irtcengine_setparameters) | SDK 的 JSON 配置信息，用于提供技术预览或特别定制功能。 |
| [setRemoteSubscribeFallbackOption](/zh-CN/api-reference/rtc/react-native/network#api_irtcengine_setremotesubscribefallbackoption) | 设置弱网环境下订阅的音视频流回退选项。 |
| [startEchoTest](/zh-CN/api-reference/rtc/react-native/network#api_irtcengine_startechotest3) | 开始音视频通话回路测试。 |
| [startLastmileProbeTest](/zh-CN/api-reference/rtc/react-native/network#api_irtcengine_startlastmileprobetest) | 开始通话前网络质量探测。 |
| [stopEchoTest](/zh-CN/api-reference/rtc/react-native/network#api_irtcengine_stopechotest) | 停止语音通话回路测试。 |
| [stopLastmileProbeTest](/zh-CN/api-reference/rtc/react-native/network#api_irtcengine_stoplastmileprobetest) | 停止通话前网络质量探测。 |
| [onConnectionLost](/zh-CN/api-reference/rtc/react-native/network#callback_irtcengineeventhandler_onconnectionlost) | 网络连接中断，且 SDK 无法在 10 秒内连接服务器回调。 |
| [onConnectionStateChanged](/zh-CN/api-reference/rtc/react-native/network#callback_irtcengineeventhandler_onconnectionstatechanged) | 网络连接状态已改变回调。 |
| [onEncryptionError](/zh-CN/api-reference/rtc/react-native/network#callback_irtcengineeventhandler_onencryptionerror) | 内置加密出错回调。 |
| [onLastmileProbeResult](/zh-CN/api-reference/rtc/react-native/network#callback_irtcengineeventhandler_onlastmileproberesult) | 通话前网络上下行 Last mile 质量探测报告回调。 |
| [onLastmileQuality](/zh-CN/api-reference/rtc/react-native/network#callback_irtcengineeventhandler_onlastmilequality) | 网络上下行 last mile 质量报告回调。 |
| [onMultipathStats](/zh-CN/api-reference/rtc/react-native/network#callback_irtcengineeventhandler_onmultipathstats) | 多路径传输统计信息的回调。 |
| [onNetworkQuality](/zh-CN/api-reference/rtc/react-native/network#callback_irtcengineeventhandler_onnetworkquality) | 通话中每个用户的网络上下行 last mile 质量报告回调。 |
| [onNetworkTypeChanged](/zh-CN/api-reference/rtc/react-native/network#callback_irtcengineeventhandler_onnetworktypechanged) | 本地网络类型发生改变回调。 |
| [onPermissionError](/zh-CN/api-reference/rtc/react-native/network#callback_irtcengineeventhandler_onpermissionerror) | 获取设备权限出错回调。 |
| [onPermissionGranted](/zh-CN/api-reference/rtc/react-native/network#callback_irtcengineeventhandler_onpermissiongranted) | 权限被授予时的回调。 |
| [onProxyConnected](/zh-CN/api-reference/rtc/react-native/network#callback_irtcengineeventhandler_onproxyconnected) | 代理连接状态回调。 |
| [onRemoteSubscribeFallbackToAudioOnly](/zh-CN/api-reference/rtc/react-native/network#callback_irtcengineeventhandler_onremotesubscribefallbacktoaudioonly) | 订阅流已回退为音频流或恢复为音视频流回调。 |
| [onUplinkNetworkInfoUpdated](/zh-CN/api-reference/rtc/react-native/network#callback_irtcengineeventhandler_onuplinknetworkinfoupdated) | 上行网络信息变化回调。 |