概览--实时音视频-火山引擎

文档中心

导航

概览

最近更新时间：2025.03.28 18:35:03首次发布时间：2025.02.26 11:44:49

引擎管理

方法	描述
setLogConfig	配置 SDK 本地日志参数，包括日志级别、存储路径、日志文件最大占用的总空间、日志文件名前缀。
createRTCEngine	创建引擎对象如果当前进程中未创建引擎实例，那么你必须先使用此方法，以使用 RTC 提供的各种音视频能力。如果当前进程中已创建了引擎实例，再次调用此方法时，会返回已创建的引擎实例。
getSDKVersion	获取当前 ReactNative SDK 版本
destroyRTCEngine	销毁所创建的引擎实例，并释放所有相关资源。
setRtcVideoEventHandler	设置引擎事件回调的接收类，必须继承自 IRTCVideoEventHandler 。
setBusinessId	设置业务标识参数可通过 businessId 区分不同的业务场景。businessId 由客户自定义，相当于一个“标签”，可以分担和细化现在 AppId 的逻辑划分的功能，但不需要鉴权。
setRuntimeParameters	设置运行时的参数

设备管理

方法	描述
android_getVideoDeviceManager	创建视频设备管理实例
ios_getVideoCaptureDevice	获取当前 SDK 正在使用的视频采集设备信息
android_enumerateVideoCaptureDevices	获取当前系统内视频采集设备列表。
setVideoCaptureDevice	设置当前视频采集设备

房间管理

方法	描述
sendRoomMessage	给房间内的所有其他用户群发文本消息。
createRTCRoom	创建房间实例。调用此方法仅返回一个房间实例，你仍需调用 joinRoom 才能真正地创建/加入房间。多次调用此方法以创建多个 RTCRoom 实例。分别调用各 RTCRoom 实例中的 joinRoom 方法，同时加入多个房间。多房间模式下，用户可以同时订阅各房间的音视频流。
sendRoomBinaryMessage	给房间内的所有其他用户群发二进制消息。
destroy	退出并销毁调用 createRTCRoom 所创建的房间实例。
sendUserMessage	给房间内指定的用户发送点对点文本消息（P2P）。
setRTCRoomEventHandler	通过设置 RTCRoom 对象的事件句柄，监听此对象对应的回调事件。
sendUserBinaryMessage	给房间内指定的用户发送点对点二进制消息（P2P）。
joinRoom	加入房间。调用 createRTCRoom 创建房间后，调用此方法加入房间，同房间内其他用户进行音视频通话。
setRemoteRoomAudioPlaybackVolume	调节某个房间内所有远端用户的音频播放音量。
leaveRoom	离开房间。用户调用此方法离开房间，结束通话过程，释放所有通话相关的资源。此方法是异步操作，调用返回时并没有真正退出房间。真正退出房间后，本地会收到 onLeaveRoom 回调通知。
setUserVisibility	设置用户可见性。未调用该接口前，本地用户默认对他人可见。默认情况下，一个 RTC 房间最多同时容纳 50 名可见用户，最多 30 人可同时上麦。更多信息参看用户和媒体流上限。
pauseAllSubscribedStream	暂停接收来自远端的媒体流。
resumeAllSubscribedStream	恢复接收来自远端的媒体流
stopForwardStreamToRooms	停止跨房间媒体流转发。通过 startForwardStreamToRooms 发起媒体流转发后，可调用本方法停止向所有目标房间转发媒体流。
pauseForwardStreamToAllRooms	暂停跨房间媒体流转发。通过 startForwardStreamToRooms 发起媒体流转发后，可调用本方法暂停向所有目标房间转发媒体流。调用本方法暂停向所有目标房间转发后，你可以随时调用 resumeForwardStreamToAllRooms 快速恢复转发。
resumeForwardStreamToAllRooms	恢复跨房间媒体流转发。调用 pauseForwardStreamToAllRooms 暂停转发之后，调用本方法恢复向所有目标房间转发媒体流。
setMultiDeviceAVSync	设置发流端音画同步。当同一用户同时使用两个通话设备分别采集发送音频和视频时，有可能会因两个设备所处的网络环境不一致而导致发布的流不同步，此时你可以在视频发送端调用该接口，SDK 会根据音频流的时间戳自动校准视频流，以保证接收端听到音频和看到视频在时间上的同步性。

音频管理

方法	描述
enablePlaybackDucking	打开/关闭音量闪避功能，适用于在 RTC 通话过程中会同时播放短视频或音乐的场景，如“一起看”、“在线 KTV”等。开启该功能后，当检测到远端人声时，本地的媒体播放音量会自动减弱，从而保证远端人声的清晰可辨；当远端人声消失时，本地媒体音量会恢复到闪避前的音量水平。
enableVocalInstrumentBalance	开启/关闭音量均衡功能。开启音量均衡功能后，人声的响度会调整为 -16lufs。如果已调用 setAudioMixingLoudness 传入了混音音乐的原始响度，此音乐播放时，响度会调整为 -20lufs。
getAudioRoute	获取当前使用的音频播放路由。
setPlaybackVolume	调节本地播放的所有远端用户混音后的音量。播放音频前或播放音频时，你都可以使用此接口设定播放音量。
setEarMonitorMode	打开/关闭耳返功能。
setEarMonitorVolume	设置耳返音量。
enableAudioPropertiesReport	启用音频信息提示。开启提示后，你可以收到 onLocalAudioPropertiesReport，onRemoteAudioPropertiesReport onRemoteAudioPropertiesReport 和 onActiveSpeaker。
startAudioCapture	开启内部音频采集。默认为关闭状态。内部采集是指：使用 RTC SDK 内置的音频采集机制进行音频采集。调用该方法开启后，本地用户会收到 onAudioDeviceStateChanged 的回调。可见用户进房后调用该方法，房间中的其他用户会收到 onUserStartAudioCapture 的回调。
disableRemoteOrientation	关闭本地用户朝向对本地用户发声效果的影响。调用此接口后，房间内的其他用户收听本地发声时，声源都在收听者正面。
stopAudioCapture	立即关闭内部音频采集。默认为关闭状态。内部采集是指：使用 RTC SDK 内置的音频采集机制进行音频采集。调用该方法，本地用户会收到 onAudioDeviceStateChanged 的回调。可见用户进房后调用该方法，房间中的其他用户会收到 onUserStopAudioCapture 的回调。
setAudioScenario	设置音频场景类型。你可以根据你的应用所在场景，选择合适的音频场景类型。选择音频场景后，SDK 会自动根据客户端音频采集播放设备和状态，适用通话音量/媒体音量，并同步变更对应音频相关的算法配置和采集配置。
setAudioProfile	设置音质档位。当所选的 ChannelProfile 中的音频参数无法满足你的场景需求时，调用本接口切换的音质档位。
sendStreamSyncInfo	发送音频流同步信息。将消息通过音频流发送到远端，并实现与音频流同步，该接口调用成功后，远端用户会收到 onStreamSyncInfoReceived 回调。
setAnsMode	支持根据业务场景，设置通话中的音频降噪模式。
updateSelfPosition	设置本地用户在自建空间直角坐标系中的收听坐标和收听朝向，以实现本地用户预期的空间音频收听效果。
updateRemotePosition	设置房间内某一远端用户在本地用户自建的空间音频坐标系中的发声位置和发声朝向，以实现本地用户预期的空间音频收听效果。
removeRemotePosition	移除调用 updateRemotePosition 为某一远端用户设置的空间音频效果。
removeAllRemotePosition	移除调用 updateRemotePosition 为所有远端用户设置的空间音频效果。

视频管理

方法	描述
disableAlphaChannelVideoEncode	关闭外部采集视频帧的 Alpha 通道编码功能。
enableAlphaChannelVideoEncode	开启自定义采集视频帧的 Alpha 通道编码功能。适用于需要分离推流端视频主体与背景，且在拉流端可自定义渲染背景的场景。
setVideoEncoderConfig	视频发布端设置推送多路流时各路流的参数，包括分辨率、帧率、码率、网络不佳时的回退策略等。
enableSimulcastMode	该方法设置视频流发布端是否开启发布多路编码参数不同的视频流的模式。
setVideoSourceType	设置向 SDK 输入的视频源，包括屏幕流默认使用内部采集。内部采集指：使用 RTC SDK 内置的视频采集机制进行视频采集。
updateRemoteStreamVideoCanvas	使用 SDK 内部渲染时，修改远端视频帧的渲染设置，包括渲染模式、背景颜色和旋转角度。
setRemoteVideoConfig	设置期望订阅的远端视频流的参数。
setLocalVideoMirrorType	为采集到的视频流开启镜像
setRemoteVideoMirrorType	使用内部渲染时，为远端流开启镜像。
startVideoCapture	立即开启内部视频采集。默认为关闭状态。内部视频采集指：使用 RTC SDK 内置视频采集模块，进行采集。调用该方法后，本地用户会收到 onVideoDeviceStateChanged 的回调。本地用户在可见状态下调用该方法后，房间中的其他用户会收到 onUserStartVideoCapture 的回调。
registerRemoteEncodedVideoFrameObserver	注册远端编码后视频数据回调。完成注册后，当 SDK 监测到远端编码后视频帧时，会触发 onRemoteEncodedVideoFrame 回调
stopVideoCapture	立即关闭内部视频采集。默认为关闭状态。内部视频采集指：使用 RTC SDK 内置视频采集模块，进行采集。调用该方法，本地用户会收到 onVideoDeviceStateChanged 的回调。可见用户进房后调用该方法，房间中的其他用户会收到 onUserStopVideoCapture 的回调。
setVideoDecoderConfig	在订阅远端视频流之前，设置远端视频数据解码方式
setVideoCaptureConfig	设置 RTC SDK 内部采集时的视频采集参数。如果你的项目使用了 SDK 内部采集模块，可以通过本接口指定视频采集参数包括模式、分辨率、帧率。
setVideoRotationMode	设置采集视频的旋转模式。默认以 App 方向为旋转参考系。接收端渲染视频时，将按照和发送端相同的方式进行旋转。
setLocalVideoCanvas	设置本地视频渲染时使用的视图，并设置渲染模式。
updateLocalVideoCanvas	修改本地视频渲染模式和背景色。
setVideoCaptureRotation	设置本端采集的视频帧的旋转角度。当摄像头倒置或者倾斜安装时，可调用本接口进行调整。对于手机等普通设备，可调用 setVideoRotationMode 实现旋转。
requestRemoteVideoKeyFrame	在订阅远端视频流之后，向远端请求关键帧
switchCamera	切换视频内部采集时使用的前置/后置摄像头调用此接口后，在本地会触发 onVideoDeviceStateChanged 回调。
isCameraZoomSupported	检测当前使用的摄像头（前置/后置），是否支持变焦（数码/光学变焦）。
getCameraZoomMaxRatio	获取当前使用的摄像头（前置/后置）的最大变焦倍数
setCameraZoomRatio	设置当前使用的摄像头（前置/后置）的光学变焦倍数
isCameraTorchSupported	检测当前使用的摄像头（前置/后置），是否支持闪光灯。
setCameraTorch	打开/关闭当前使用的摄像头（前置/后置）的闪光灯
isCameraFocusPositionSupported	检查当前使用的摄像头是否支持手动对焦。
setCameraFocusPosition	设置当前使用的摄像头的对焦点。
isCameraExposurePositionSupported	检查当前使用的摄像头是否支持手动设置曝光点。
ios_setMaxVideoEncoderConfig	视频发布端设置期望发布的最大分辨率视频流参数，包括分辨率、帧率、码率、网络不佳时的回退策略等。该接口支持设置一路视频流参数，设置多路参数请使用 setVideoEncoderConfig。
setCameraExposurePosition	设置当前使用的摄像头的曝光点
setCameraExposureCompensation	设置当前使用的摄像头的曝光补偿。
setExternalVideoEncoderEventHandler	注册自定义编码帧推送事件回调

音视频传输

方法	描述
setDummyCaptureImagePath	摄像头处于关闭状态时，使用静态图片填充本地推送的视频流。调用 `stopVideoCapture` 接口时，会开始推静态图片。若要停止发送图片，可传入空字符串或启用内部摄像头采集。可重复调用该接口来更新图片。

屏幕共享

方法	描述
startScreenCapture	使用 RTC SDK 内部采集模块开始采集屏幕音频流和（或）视频流。
updateScreenCapture	使用 RTC SDK 内部屏幕采集后，更新采集的媒体类型。
stopScreenCapture	在屏幕共享时，停止使用 RTC SDK 内部采集方式采集屏幕音视频。
publishScreen	在当前所在房间内发布本地屏幕共享音视频流
unpublishScreen	停止将本地屏幕共享音视频流发布到当前所在房间中
setScreenAudioSourceType	在屏幕共享时，设置屏幕音频的采集方式（内部采集/自定义采集）
setScreenAudioStreamIndex	在屏幕共享时，设置屏幕音频流和麦克风采集到的音频流的混流方式
setScreenVideoEncoderConfig	为发布的屏幕共享视频流设置期望的编码参数，包括分辨率、帧率、码率、网络不佳时的回退策略等。

混音

方法	描述
setLocalVoicePitch	开启本地语音变调功能，多用于 K 歌场景。使用该方法，你可以对本地语音的音调进行升调或降调等调整。

消息

方法	描述
sendSEIMessage	通过视频帧发送 SEI 数据。在视频通话场景下，SEI 数据会随视频帧发送；在语音通话场景下，SDK 会自动生成一路 16px × 16px 的黑帧视频流用来发送 SEI 数据。

字幕翻译服务

方法	描述
startSubtitle	识别或翻译房间内所有用户的语音，形成字幕。调用该方法时，可以在 SubtitleMode 中选择语音识别或翻译模式。如果选择识别模式，语音识别文本会通过 onSubtitleMessageReceived 事件回调给你；如果选择翻译模式，你会同时收到两个 onSubtitleMessageReceived 回调，分别包含字幕原文及字幕译文。调用该方法后，你会收到 onSubtitleStateChanged 回调，通知字幕是否开启。
stopSubtitle	关闭字幕。调用该方法后，用户会收到 onSubtitleStateChanged 回调，通知字幕是否关闭。

方法

描述

startSubtitle

识别或翻译房间内所有用户的语音，形成字幕。
调用该方法时，可以在 SubtitleMode 中选择语音识别或翻译模式。如果选择识别模式，语音识别文本会通过 onSubtitleMessageReceived 事件回调给你；
如果选择翻译模式，你会同时收到两个 onSubtitleMessageReceived 回调，分别包含字幕原文及字幕译文。
调用该方法后，你会收到 onSubtitleStateChanged 回调，通知字幕是否开启。

stopSubtitle

关闭字幕。
调用该方法后，用户会收到 onSubtitleStateChanged 回调，通知字幕是否关闭。

网络管理

方法	描述
startEchoTest	开启音视频回路测试。在进房前，用户可调用该接口对音视频通话全链路进行检测，包括对音视频设备以及用户上下行网络的检测，从而帮助用户判断是否可以正常发布和接收音视频流。开始检测后，SDK 会录制你声音或视频。如果你在设置的延时范围内收到了回放，则视为音视频回路测试正常。
stopEchoTest	停止音视频回路测试。调用 startEchoTest 开启音视频回路检测后，你必须调用该方法停止检测。

高级功能

方法	描述
setVodPlayer	注入点播播放器实例