文档中心

实时音视频

Electron 3.60.1

概览

引擎管理

方法	描述
createRTCEngine	创建引擎对象。
setBusinessId	设置业务标识参数。
feedback	将用户反馈的问题上报到 RTC。
destroyRTCEngine	销毁引擎实例对象。

回调	描述
onLogReport	端监控日志回调。当产生一个端监控事件时触发该回调。
onWarning	当内部发生警告事件时触发该回调。
onError	当内部发生不可逆转错误时触发该回调。
onSysStats	每 2 秒回调一次，报告当前 CPU 和内存使用率。

房间管理

方法	描述
createRTCRoom	创建房间。
getRoomId	获取房间 ID。
setUserVisibility	设置用户可见性。未调用该接口前，本地用户默认对他人可见。
joinRoom	加入房间。
getCallId	获取通话 ID。该方法需要在加入房间后调用。
setLiveMode	设置房间直播模式。
setRoomExtraInfo	设置/更新房间附加信息，可用于标识房间状态或属性，或灵活实现各种业务逻辑。
updateToken	更新 Token。Token 中同时包含进房、发布和订阅权限，各权限有一定的有效期，并且到期前 30 秒会触发回调，提示用户更新 Token 相关权限。此时需要重新获取 Token，并调用此方法更新 Token，以保证通话的正常进行。
leaveRoom	离开房间。
destroy	退出并销毁房间。

回调	描述
onRoomStreamExtraInfoUpdate	接收同一房间内，其他用户调用 setStreamExtraInfo 设置的流附加信息的回调。
onRoomStats	房间通话统计信息回调。用户进房开始通话后，每 2s 收到一次本回调。
onUserJoined	可见用户加入房间，或房内不可见用户切换为可见的回调。 1.远端可见用户调用 setUserVisibility 方法将自身设为可见后加入房间时，房间内其他用户将收到该事件。 2.远端可见用户断网后重新连入房间时，房间内其他用户将收到该事件。 3.房间内不可见远端用户调用 setUserVisibility 方法切换至可见时，房间内其他用户将收到该事件。 4.新进房用户也会收到进房前已在房内的可见角色用户的进房回调通知。
onLeaveRoom	离开房间成功回调。
onUserLeave	远端用户离开房间，或切至不可见时，本地用户会收到此事件。
onSetRoomExtraInfoResult	调用 setRoomExtraInfo 设置房间附加信息结果的回调。
onRoomExtraInfoUpdate	接收同一房间内，其他用户调用 setRoomExtraInfo 设置的房间附加信息的回调。
onUserVisibilityChanged	用户调用 setUserVisibility 设置用户可见性的回调。
onTokenWillExpire	Token 过期前 30 秒将触发该回调。
onPublishPrivilegeTokenWillExpire	Token 发布权限过期前 30 秒将触发该回调。
onSubscribePrivilegeTokenWillExpire	Token 订阅权限过期前 30 秒将触发该回调。

音频管理

方法	描述
enumerateAudioPlaybackDevices	获取当前系统内音频播放设备列表。如果后续设备有变更，你会收到 `onAudioDeviceStateChanged` 回调通知，然后需要重新调用本接口以获得新的设备列表。
setAudioPlaybackDevice	设置音频播放设备。
getAudioPlaybackDevice	获取当前音频播放设备 ID。
followSystemPlaybackDevice	设置音频播放路由是否跟随系统。
enumerateAudioCaptureDevices	获取当前系统内音频采集设备列表。如果后续设备有变更，你需要重新调用本接口以获得新的设备列表。
setAudioCaptureDevice	设置音频采集设备。
getAudioCaptureDevice	获取当前音频采集设备 ID。
followSystemCaptureDevice	设置音频采集路由是否跟随系统。
setAudioProfile	设置音质档位。
enableExternalSoundCard	启用匹配外置声卡的音频处理模式。
enableAGC	开启或关闭自动增益控制，用于自动调节麦克风采集音量。
enableVocalInstrumentBalance	开启/关闭音量均衡功能。
startAudioCapture	开启内部音频采集。默认为关闭状态。
muteAudioCapture	设置是否将录音信号静音（不改变本端硬件）。
setCaptureVolume	调节音频采集音量。
setAudioCaptureDeviceVolume	设置当前音频采集设备音量。
getAudioCaptureDeviceVolume	获取当前音频采集设备音量。
setAudioCaptureDeviceMute	设置当前音频采集设备静音状态，默认为非静音。
getAudioCaptureDeviceMute	获取当前音频采集设备是否静音的信息。
stopAudioCapture	关闭内部音频采集。默认为关闭状态。
setAudioPlaybackDeviceVolume	设置当前音频播放设备音量。
getAudioPlaybackDeviceVolume	获取当前音频播放设备音量。
setAudioPlaybackDeviceMute	设置当前音频播放设备静音状态，默认为非静音。
getAudioPlaybackDeviceMute	获取当前音频播放设备是否静音的信息。
setScreenCaptureVolume	调节屏幕共享时采集的音频音量。只改变音频数据的音量信息，不影响麦克风采集的音量，也不会改变本端音频设备本身的音量。
setPlaybackVolume	调节本地播放的所有远端用户音频混音后的音量，混音内容包括远端人声、音乐、音效等。播放音频前或播放音频时，你都可以使用此接口设定播放音量。
setRemoteAudioPlaybackVolume	调节来自远端用户的音频播放音量。
setRemoteRoomAudioPlaybackVolume	调节某个房间内所有远端用户的音频播放音量。
enableAudioPropertiesReport	启用音频信息提示。
setAudioSelectionConfig	设置本端发布流在音频选路中的优先级。
initAudioPlaybackDeviceForTest	尝试初始化音频播放设备，可检测出设备不存在、权限被拒绝/禁用等异常问题。
startAudioPlaybackDeviceTest	启动音频播放设备测试。该方法测试播放设备是否能正常工作。SDK 播放指定的音频文件，测试者如果能听到声音，说明播放设备能正常工作。
stopAudioPlaybackDeviceTest	停止音频播放设备测试。
initAudioCaptureDeviceForTest	尝试初始化音频采集设备，可检测出设备不存在、权限被拒绝/禁用等异常问题。
startAudioDeviceRecordTest	开始音频采集设备和音频播放设备测试。
stopAudioDeviceRecordAndPlayTest	停止采集本地音频，并开始播放采集到的声音。录音播放完毕后，设备测试流程结束。
stopAudioDevicePlayTest	停止由调用 startAudioDeviceRecordTest 开始的音频播放设备测试。
startHardwareEchoDetection	开启通话前回声检测。
stopHardwareEchoDetection	停止通话前回声检测。

回调	描述
onAudioDeviceWarning	音频设备警告回调。音频设备包括音频采集设备和音频渲染设备。
onAudioDeviceStateChanged	音频设备状态回调。提示音频采集、音频播放等设备的状态。
onAudioStreamBanned	通过调用服务端 BanUserStream/UnbanUserStream 方法禁用/解禁指定房间内指定用户音频流的发送时，触发此回调。
onAudioDeviceVolumeChanged	音频设备音量改变回调。当通过系统设置，改变音频设备音量或静音状态时，触发本回调。本回调无需手动开启。
onStreamSyncInfoReceived	音频流同步信息回调。可以通过此回调，在远端用户调用 sendStreamSyncInfo 发送音频流同步消息后，收到远端发送的音频流同步信息。
onLocalAudioPropertiesReport	调用 enableAudioPropertiesReport 后，根据设置的 interval 值，你会周期性地收到此回调，了解本地音频的相关信息。
onRemoteAudioPropertiesReport	远端用户进房后，本地调用 enableAudioPropertiesReport，根据设置的 interval 值，本地会周期性地收到此回调，了解订阅的远端用户的音频信息。
onActiveSpeaker	调用 enableAudioPropertiesReport 后，根据设置的 config.interval，你会周期性地收到此回调，获取房间内的最活跃用户信息。
onUserStartAudioCapture	房间内的用户调用 startAudioCapture 开启音频采集时，房间内其他用户会收到此回调。
onUserStopAudioCapture	房间内的用户调用 stopAudioCapture 关闭音频采集时，房间内其他用户会收到此回调。
onAudioPlaybackDeviceTestVolume	回调音频设备测试时的播放音量。
onHardwareEchoDetectionResult	通话前回声检测结果回调。

视频管理

方法	描述
enumerateVideoCaptureDevices	获取当前系统内视频采集设备列表。
setVideoCaptureDevice	设置当前视频采集设备。
getVideoCaptureDevice	获取当前 SDK 正在使用的视频采集设备 ID。
setVideoCaptureConfig	设置 RTC SDK 内部采集时的视频采集参数。指定视频采集参数包括模式、分辨率、帧率。
setVideoEncoderConfig	设置期望发布的最大分辨率视频流参数。
setupLocalVideo	设置本地视频渲染时使用的视图，并设置渲染模式。
startVideoCapture	开启内部视频采集。默认为关闭状态。
setupRemoteVideo	绑定远端视频流到本地视图。
requestRemoteVideoKeyFrame	向已订阅的远端视频流请求关键帧。
removeRemoteVideo	解绑指定远端视频流已绑定的本地视图。
removeAllRemoteVideo	解绑房间内所有已绑定的远端视频流视图。
removeLocalVideo	解除本地视频流与渲染视图的绑定。
stopVideoCapture	关闭内部视频采集。默认为关闭状态。

回调	描述
onUserStartVideoCapture	房间内的用户调用 startVideoCapture 开启视频采集时，房间内其他用户会收到此回调。
onUserStopVideoCapture	房间内的用户调用 stopVideoCapture 关闭视频采集时，房间内其他用户会收到此回调。
onVideoDeviceStateChanged	视频设备状态回调。提示摄像头视频采集、屏幕视频采集等设备的状态。
onVideoDeviceWarning	视频设备警告回调，包括视频采集设备等。
onFirstLocalVideoFrameCaptured	第一帧本地采集的视频/屏幕共享画面在本地视图渲染完成时，收到此回调。
onLocalVideoStateChanged	本地视频流的状态发生改变时，收到该事件。

音视频传输

方法	描述
setDummyCaptureImagePath	摄像头处于关闭状态时，使用静态图片填充本地推送的视频流。可重复调用该接口来更新图片。若要停止发送图片，可传入空字符串或启用内部摄像头采集。
publishStreamAudio	在当前所在房间内手动/取消发布本地通过麦克风采集的音频流。
publishStreamVideo	在当前所在房间内手动/取消发布本地通过摄像头采集的视频流。
subscribeStreamAudio	手动/取消订阅房间内指定的通过麦克风采集的音频流，或更新对指定远端用户的订阅选项。
subscribeStreamVideo	手动/取消订阅房间内指定的通过摄像头采集的视频流，或更新对指定远端用户的订阅选项。
subscribeAllStreamsAudio	订阅房间内所有通过麦克风采集的音频流。
unsubscribeAllStreamsAudio	取消订阅房间内所有通过麦克风采集的音频流。
subscribeAllStreamsVideo	订阅房间内所有通过摄像头采集的视频流。
unsubscribeAllStreamsVideo	取消订阅房间内所有通过摄像头采集的视频流。
setStreamExtraInfo	设置当前推流的流附加信息。
setMultiDeviceAVSync	设置发流端音画同步。
pauseAllSubscribedStreamAudio	暂停接收来自远端的音频流。
resumeAllSubscribedStreamAudio	恢复接收来自远端的音频流。
pauseAllSubscribedStreamVideo	暂停接收来自远端的视频流。
resumeAllSubscribedStreamVideo	恢复接收来自远端的视频流。
startForwardStreamToRooms	开始跨房间转发媒体流。
updateForwardStreamToRooms	更新跨房间媒体流转发信息。
pauseForwardStreamToAllRooms	暂停跨房间媒体流转发。
resumeForwardStreamToAllRooms	恢复跨房间媒体流转发。
stopForwardStreamToRooms	停止跨房间媒体流转发。

回调	描述
onRemoteAudioStateChanged	用户订阅来自远端的音频流状态发生改变时，会收到此回调，了解当前的远端音频流状态。
onFirstLocalAudioFrame	本地采集到第一帧音频帧时，收到该回调。
onFirstRemoteAudioFrame	收到房间内每一路音频流的第一帧时，收到该回调。
onAudioFrameSendStateChanged	音频首帧发送状态改变回调。
onVideoFrameSendStateChanged	视频首帧发送状态改变回调。
onAudioFramePlayStateChanged	音频首帧播放状态改变回调。
onVideoFramePlayStateChanged	视频首帧播放状态改变回调。
onLocalStreamStats	反映通话中本地设备发送音/视频流的统计信息以及网络状况的回调。本地用户发布音视频流成功后，每隔 2s 收到此回调。
onRemoteStreamStats	反映通话中本地设备接收订阅的远端音/视频流的统计信息以及网络状况的回调。每隔 2s 收到此回调。
onNetworkQuality	加入房间后，以 2 秒 1 次的频率，报告用户的网络质量信息。
onLocalVideoSizeChanged	本地视频大小或旋转配置发生改变时，收到此回调。
onRemoteVideoSizeChanged	远端视频大小或旋转配置发生改变时，房间内订阅此视频流的用户会收到此回调。
onRemoteVideoStateChanged	远端视频流的状态发生改变时，房间内订阅此流的用户会收到该事件。
onFirstRemoteVideoFrameRendered	第一帧远端视频流在视图上渲染成功后，收到此回调。
onVideoStreamBanned	通过调用服务端 BanUserStream/UnbanUserStream 方法禁用/解禁指定房间内指定用户视频流的发送时，触发此回调。
onFirstRemoteVideoFrameDecoded	SDK 接收并解码远端视频流首帧后，收到此回调。
onForwardStreamStateChanged	跨房间媒体流转发状态和错误回调。
onForwardStreamEvent	跨房间媒体流转发事件回调。
onAVSyncStateChange	发布端调用 setMultiDeviceAVSync 后音视频同步状态发生改变时，会收到此回调。

视频处理

方法	描述
setLocalVideoMirrorType	为采集到的视频流开启镜像。
setVideoCaptureRotation	设置本端采集的视频帧的旋转角度。当外接摄像头倒置或者倾斜安装时，调用本接口进行调整。
setLowLightAdjusted	设置视频暗光增强模式。对于光线不足、照明不均匀或背光等场景下推荐开启，可有效改善画面质量。
setVideoWatermark	在本地视频流上添加水印。
clearVideoWatermark	移除本地视频流的水印。
enableEffectBeauty	开启/关闭基础美颜。
setBeautyIntensity	调整基础美颜强度。
initCVResource	视频特效许可证检查。
getAuthMessage	从 CV SDK 获取授权消息，用于获取在线许可证。
enableVideoEffect	开启高级美颜、滤镜等视频特效。
setEffectNodes	设置视频特效素材包，支持同时设置多个素材包。
updateEffectNode	设置特效强度。
setColorFilter	设置颜色滤镜。
setColorFilterIntensity	设置已启用颜色滤镜的强度。
disableVideoEffect	关闭视频特效。
enableVirtualBackground	将摄像头采集画面中的人像背景替换为指定图片或纯色背景。
disableVirtualBackground	关闭虚拟背景。
enableFaceDetection	开启人脸识别功能，并设置人脸检测结果回调观察者。
disableFaceDetection	关闭人脸识别功能。
setVideoDigitalZoomConfig	设置本地摄像头数码变焦参数，包括缩放倍数，移动步长。
setVideoDigitalZoomControl	控制本地摄像头数码变焦，缩放或移动一次。设置对本地预览画面和发布到远端的视频都生效。
startVideoDigitalZoomControl	开启本地摄像头持续数码变焦，缩放或移动。设置对本地预览画面和发布到远端的视频都生效。
stopVideoDigitalZoomControl	停止本地摄像头持续数码变焦。

回调	描述
onFaceDetectResult	特效 SDK 进行人脸检测结果的回调。调用 enableFaceDetection 注册了回调，并使用 RTC SDK 中包含的特效 SDK 进行视频特效处理时，你会收到此回调。

音频处理

方法	描述
setVoiceChangerType	设置变声特效类型。
setVoiceReverbType	设置混响特效类型。
setLocalVoicePitch	开启本地语音变调功能，多用于 K 歌场景。使用该方法，你可以对本地语音的音调进行升调或降调等调整。
setLocalVoiceReverbParam	设置本地采集音频的混响效果。包含内部采集和外部采集，但不包含混音音频文件。
enableLocalVoiceReverb	开启本地音效混响效果。
setLocalVoiceEqualization	设置本地采集语音的均衡效果。包含内部采集和外部采集，但不包含混音音频文件。
enablePlaybackDucking	打开/关闭音量闪避功能，适用于在 RTC 通话过程中会同时播放短视频或音乐的场景，如“一起看”、“在线 KTV”等。开启该功能后，当检测到远端人声时，本地的媒体播放音量会自动减弱，从而保证远端人声的清晰可辨；当远端人声消失时，本地媒体音量会恢复到闪避前的音量水平。

自定义流处理

方法	描述
setVideoSourceType	设置向 SDK 输入的视频源，包括屏幕流。默认使用内部采集。内部采集指：使用 RTC SDK 内置的视频采集机制进行视频采集。
pushExternalVideoFrame	推送外部视频帧。
enableAlphaChannelVideoEncode	开启带有Alpha通道的视频帧编码支持。
disableAlphaChannelVideoEncode	关闭带有Alpha通道的视频帧编码支持。
setAudioSourceType	切换音频采集方式。
pushExternalAudioFrame	推送自定义采集的音频数据到 RTC SDK。
setLocalVideoSink	获取本地视频流。
unsetLocalVideoSink	停止获取本地视频流。
setRemoteVideoSink	获取远端视频流。
unsetRemoteVideoSink	停止获取远端视频流。
enableAudioFrameCallback	设置并开启指定的音频数据帧回调。
disableAudioFrameCallback	关闭音频回调。

回调	描述
onLocalVideoFrame	获取采集成功的本地摄像头视频帧，用于自定义处理或渲染。
onRemoteVideoFrame	获取采集成功的远端摄像头视频帧，用于自定义处理或渲染。
onRecordAudioFrame	返回麦克风录制的音频数据。
onPlaybackAudioFrame	返回远端所有用户混音后的音频数据。
onRemoteUserAudioFrame	返回远端单个用户的音频数据。
onMixedAudioFrame	返回本地麦克风录制和远端所有用户混音后的音频数据。
onRecordScreenAudioFrame	返回本地屏幕录制的音频数据。

网络管理

方法	描述
setLocalSimulcastMode	设置本地视频大小流模式，并可选地设置小流参数。
setRemoteVideoConfig	设置期望订阅的远端视频流的参数。
setPublishFallbackOption	设置发布的音视频流回退选项。你可以调用这个接口来设置网络情况不佳或设备性能不足时只发送小流，以保证通话质量。
setSubscribeFallbackOption	设置订阅的音视频流回退选项。你可以通过调用该接口来设置网络情况不佳或性能不足时只订阅小流或音频流，以保证通话质量。
setRemoteUserPriority	设置用户优先级。
startNetworkDetection	开启通话前网络探测。
stopNetworkDetection	停止通话前网络探测。
startEchoTest	单流版本暂不支持音视频回路检测。
stopEchoTest	单流版本暂不支持停止音视频回路检测。
getNetworkTimeInfo	通过 NTP 协议，获取网络时间。

回调	描述
onSimulcastSubscribeFallback	因发布/订阅性能回退或退出回退状态，订阅的音视频流，发生流的切换时，收到该回调。
onPerformanceAlarms	本地未通过 `setPublishFallbackOption` 开启发布性能回退，检测到设备性能不足时，收到此回调。本地通过 `setPublishFallbackOption` 开启发布性能回退，因设备性能/网络原因，造成发布性能回退/恢复时，收到此回调。
onConnectionStateChanged	SDK 与信令服务器连接状态改变回调。连接状态改变时触发。
onNetworkTypeChanged	SDK 当前网络连接类型改变回调。当 SDK 的当前网络连接类型发生改变时回调该事件。
onNetworkDetectionResult	成功调用 startNetworkDetection 接口开始探测后，会在 3s 内首次收到该回调，之后每 2s 收到一次该回调。
onNetworkDetectionStopped	通话前网络探测结束。
onEchoTestResult	通话回路测试结果回调。
onNetworkTimeSynchronized	首次调用 getNetworkTimeInfo 后，SDK 内部启动网络时间同步，同步完成时会触发此回调。

消息

方法	描述
login	登录 RTS 服务器。必须先登录，才能发送房间外点对点消息和向应用服务器发送消息。
updateLoginToken	更新用户用于登录的 Token。
getPeerOnlineStatus	查询对端用户或本端用户的登录状态。
sendRoomMessage	给房间内的所有其他用户群发文本消息。
sendRoomBinaryMessage	给房间内的所有其他用户群发二进制消息。
sendUserMessage	给房间内指定的用户发送点对点文本消息。
sendUserBinaryMessage	给房间内指定的用户发送点对点二进制消息。
sendUserMessageOutsideRoom	给房间外指定的用户发送文本消息（P2P）。
sendUserBinaryMessageOutsideRoom	给房间外指定的用户发送二进制消息（P2P）。
setServerParams	设置业务服务器参数。
sendServerMessage	客户端给业务服务器发送文本消息（P2Server）。
sendServerBinaryMessage	客户端给业务服务器发送二进制消息（P2Server）。
sendStreamSyncInfo	发送音频流同步信息。将消息通过音频流发送到远端，并实现与音频流同步。
sendSEIMessage	通过视频帧发送 SEI 数据。
sendLivePushSEIMessage	以 Key-Value 格式通过视频帧发送 SEI 数据。
logout	登出 RTS 服务器。调用本接口登出后，无法调用房间外消息以及端到服务器消息相关的方法或收到相关回调。

回调	描述
onLoginResult	调用 login 后，会收到此回调。
onLogout	登出结果回调。
onRoomMessageSendResult	调用 sendRoomMessage 或 sendRoomBinaryMessage 向房间内群发文本或二进制消息后，消息发送方会收到该消息发送结果回调。
onRoomMessageReceived	接收到房间内广播消息的回调。
onRoomBinaryMessageReceived	接收到房间内广播二进制消息的回调。
onGetPeerOnlineStatus	查询对端或本端用户登录状态的返回结果。
onUserMessageReceived	收到来自房间中其他用户通过 sendUserMessage 发来的点对点文本消息时，会收到此回调。
onUserMessageSendResult	向房间内单个用户发送点对点文本或点对点二进制消息后，消息发送方会收到该消息发送结果回调。
onUserMessageSendResult	调用 sendUserMessage 或 sendUserBinaryMessage 后，消息发送方会收到该消息发送结果回调。
onServerParamsSetResult	设置业务服务器参数的返回结果。
onServerMessageSendResult	给业务服务器发送消息的回调。
onUserBinaryMessageReceived	收到来自房间中其他用户通过 sendUserBinaryMessage 发来的点对点二进制消息时，会收到此回调。
onUserBinaryMessageReceived	单个用户接收到同一房间内其他 uid 所属用户发来二进制消息的回调（P2P）。
onUserMessageSendResultOutsideRoom	给房间外指定的用户发送消息的回调。
onUserMessageReceivedOutsideRoom	收到房间外用户调用 sendUserMessageOutsideRoom 发来的文本消息时，会收到此回调。
onUserBinaryMessageReceivedOutsideRoom	收到房间外用户调用 sendUserBinaryMessageOutsideRoom 发来的二进制消息时，会收到此回调。
onSEIStreamUpdate	黑帧视频流发布状态回调。
onSEIMessageReceived	收到通过 sendSEIMessage 发送的带有 SEI 消息的视频帧时，收到此回调。

推流至 CDN/WTN

方法	描述
setAudioAlignmentProperty	在听众端，设置订阅的所有远端音频流精准对齐后播放。
startPushMixedStream	启动一路合流转推任务，发布到 CDN 或发布为一路 WTN 流。
updatePushMixedStream	更新由 startPushMixedStream 启动的任务参数。
stopPushMixedStream	停止合流转推任务。
startPushSingleStream	开始将房间内一路音视频流转推到指定 RTC 房间或 CDN 地址。
stopPushSingleStream	停止跨房间转推或者单流转推。该方法可用于停止单流跨房间转推或者单流转推直播，通过 task_id 区分需要停止的任务。
getWTNStream	获取 WTN 流实例。
subscribeWTNAudioStream	订阅或取消订阅指定 WTN 音频流。
subscribeWTNVideoStream	订阅或取消订阅指定 WTN 视频流。
setupWTNRemoteVideo	为指定 WTN 远端视频流绑定内部渲染视图。
setWTNRemoteVideoSink	为指定 WTN 远端视频流绑定自定义视频接收器。
setWTNRemoteAudioPlaybackVolume	调节指定 WTN 远端音频流的播放音量。
unsetWTNRemoteVideoSink	解除指定 WTN 远端视频流绑定的自定义视频接收器。
removeWTNRemoteVideo	移除指定 WTN 远端视频流绑定的内部渲染视图。
dispose	销毁 WTN 流实例。

回调	描述
onMixedStreamEvent	服务端合流转推任务事件回调。
onSingleStreamEvent	单流转推直播状态回调。
onWTNAudioSubscribeStateChanged	WTN 音频流订阅状态变化回调。
onWTNVideoSubscribeStateChanged	WTN 视频流订阅状态变化回调。
onWTNFirstRemoteAudioFrame	WTN 音频流首帧解码成功回调。
onWTNFirstRemoteVideoFrameDecoded	WTN 视频流首帧解码成功回调。
onWTNSEIMessageReceived	回调 WTN 流中携带的 SEI 信息。
onWTNDataMessageReceived	回调 WTN 流中携带的数据消息。
onWTNVideoFrame	自定义渲染 WTN 视频帧回调。

音效播放

方法	描述
getAudioEffectPlayer	创建音效播放器实例。
setEventHandler	设置回调句柄。
preload	预加载指定音乐文件到内存中，以避免频繁播放同一文件时的重复加载，减少 CPU 占用。
start	开始播放音效文件。可以通过传入不同的 ID 和 filepath 多次调用本方法，以实现同时播放多个音效文件，实现音效叠加。
setPosition	设置音效文件的起始播放位置。
getPosition	获取音效文件播放进度。
getDuration	获取音效文件时长。
setVolume	调节指定音效的音量大小，包括音效文件和 PCM 音频。
setVolumeAll	设置所有音效的音量大小，包括音效文件和 PCM 音效。
getVolume	获取当前音量。
pause	暂停播放音效文件。
resume	恢复播放音效文件。
pauseAll	暂停播放所有音效文件。
resumeAll	恢复播放所有音效文件。
stop	停止播放音效文件。
stopAll	停止播放所有音效文件。
unload	卸载指定音效文件。
unloadAll	卸载所有音效文件。

回调	描述
onAudioEffectPlayerStateChanged	播放状态改变时回调。

音乐播放

方法	描述
getMediaPlayer	创建音乐播放器实例。
setEventHandler	注册回调句柄以在本地音乐文件混音时，收到相关回调。
open	打开音乐文件。一个播放器实例仅能够同时打开一个音乐文件。如果需要同时打开多个音乐文件，请创建多个音乐播放器实例。
openWithCustomSource	启动音频裸数据混音。
pushExternalAudioFrame	推送用于混音的 PCM 音频帧数据。
start	播放音乐。你仅需要在调用 open，且未开启自动播放时，调用此方法。
setVolume	调节指定混音的音量大小，包括音乐文件混音和 PCM 混音。
getVolume	获取当前音量。
setPosition	设置音乐文件的起始播放位置。
getPosition	获取音乐文件播放进度。
getTotalDuration	获取音乐文件时长。
getPlaybackDuration	获取混音音乐文件的实际播放时长，单位为毫秒。
setAudioPitch	开启变调功能，多用于 K 歌场景。
setAudioDualMonoMode	设置当前音乐文件的声道模式。
getAudioTrackCount	获取当前音乐文件的音轨数。
selectAudioTrack	指定当前音乐文件的播放音轨。
setPlaybackSpeed	设置播放速度。
setProgressInterval	设置音频文件混音时，收到 onMediaPlayerPlayingProgress 的间隔。
setLoudness	如果你需要使用 `enableVocalInstrumentBalance` 对音频文件/PCM 音频数据设置音量均衡，你必须通过此接口传入其原始响度。
pause	调用 open，或 start 开始播放音频文件后，调用本方法暂停播放。
resume	调用 pause 暂停音频播放后，调用本方法恢复播放。
stop	调用 open 或 start 开始播放后，可以调用本方法停止。

回调	描述
onMediaPlayerStateChanged	播放状态改变时回调。
onMediaPlayerEvent	播放器事件回调。
onMediaPlayerPlayingProgress	播放进度周期性回调。回调周期通过 `MediaPlayerConfig.callback_on_progress_interval` 设置。

屏幕共享

方法	描述
getScreenCaptureSourceList	获取屏幕采集对象列表。
getThumbnail	获取共享对象缩略图。
getWindowAppIcon	获取应用窗体所属应用的图标。
startScreenVideoCapture	采集屏幕视频流，用于共享。屏幕视频流包括：屏幕上显示的内容，应用窗口中显示的内容，或虚拟屏幕中显示的内容。其中，虚拟屏幕中显示的内容仅在 Windows 平台上支持。
updateScreenCaptureMouseCursor	通过 RTC SDK 提供的采集模块采集屏幕视频流时，更新对鼠标的处理设置。默认采集鼠标。
updateScreenCaptureRegion	更新屏幕共享区域。
updateScreenCaptureHighlightConfig	通过 RTC SDK 提供的采集模块采集屏幕视频流时，更新边框高亮设置。默认展示边框。
updateScreenCaptureFilterConfig	通过 RTC SDK 提供的采集模块采集屏幕视频流时，设置需要过滤的窗口。
startScreenAudioCapture	在屏幕共享时，开始使用 RTC SDK 内部采集方式，采集屏幕音频。
muteScreenAudioCapture	暂停/恢复屏幕音频。
setScreenAudioChannel	在屏幕共享时，设置屏幕音频流的声道数。
stopScreenAudioCapture	在屏幕共享时，停止使用 RTC SDK 内部采集方式，采集屏幕音频。
stopScreenVideoCapture	停止屏幕视频流采集。

安全与加密

方法	描述
setEncryptInfo	设置传输时使用内置加密的方式。
setLocalProxy	设置本地代理。
startCloudProxy	开启云代理。
stopCloudProxy	关闭云代理。

回调	描述
onCloudProxyConnected	调用 startCloudProxy 开启云代理，SDK 首次成功连接云代理服务器时，回调此事件。
onLocalProxyStateChanged	本地代理状态发生改变回调。调用 setLocalProxy 设置本地代理后，SDK 会触发此回调，返回代理连接的状态。

录制

方法	描述
startFileRecording	该方法将通话过程中的音视频数据录制到本地的文件中。
stopFileRecording	停止本地录制。
startAudioRecording	开启录制语音通话，生成本地文件。
stopAudioRecording	停止音频文件录制。

回调	描述
onRecordingStateUpdate	获取本地录制状态回调。
onRecordingProgressUpdate	本地录制进度回调。
onAudioRecordingStateUpdate	调用 startAudioRecording 或 stopAudioRecording 改变音频文件录制状态时，收到此回调。

空间音频

方法	描述
enableSpatialAudio	开启/关闭空间音频功能。
disableRemoteOrientation	参与通话的各端调用本接口后，将忽略远端用户的朝向，认为所有远端用户都面向本地用户。
updateSelfPosition	设置本地用户在自建空间直角坐标系中的收听坐标和收听朝向，以实现本地用户预期的空间音频收听效果。
updateRemotePosition	设置房间内某一远端用户在本地用户自建的空间音频坐标系中的发声位置和发声朝向，以实现本地用户预期的空间音频收听效果。
removeRemotePosition	移除调用 updateRemotePosition 为某一远端用户设置的空间音频效果。
removeAllRemotePosition	移除调用 updateRemotePosition 为所有远端用户设置的空间音频效果。

范围语音

方法	描述
updateRangePosition	更新本地用户在房间内空间直角坐标系中的位置坐标。
updateReceiveRange	更新本地用户的音频收听范围。
setAttenuationModel	设置范围语音的音量衰减模式。
setNoAttenuationFlags	添加标签组，用于标记相互之间通话不衰减的用户组。在同一个 RTC 房间中，如果多个用户的标签组之间有交集，那么，他们之间互相通话时，通话不衰减。比如，用户身处多个队伍，队伍成员间通话不衰减。那么，可以为每个队伍绑定专属标签，每个用户的标签组包含用户所属各个队伍的标签。
enableRangeAudio	开启/关闭范围语音功能。

字幕翻译服务

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

回调	描述
onSubtitleStateChanged	字幕状态发生改变回调。当用户调用 startSubtitle 和 stopSubtitle 使字幕状态发生改变或字幕任务出现错误时，触发该回调。
onSubtitleMessageReceived	字幕相关内容回调。当用户成功调用 startSubtitle 后会收到此回调，通知字幕的相关信息。

视频截图

方法	描述
takeLocalSnapshot	截取本地视频画面。
takeLocalSnapshotToFile	截取本地视频流画面，生成 JPG 文件，并保存到本地指定路径。调用该方法后，SDK 会触发回调 onLocalSnapshotTakenToFile 报告截图是否成功，以及截取的图片信息。
takeRemoteSnapshot	截取远端视频画面。
takeRemoteSnapshotToFile	截取远端的视频流画面，生成 JPG 文件，并保存到本地指定路径。调用该方法后，SDK 会触发回调 onRemoteSnapshotTakenToFile 报告截图是否成功，以及截取的图片信息。

回调	描述
onTakeLocalSnapshotResult	调用 takeLocalSnapshot 截取视频画面时，收到此回调。
onLocalSnapshotTakenToFile	调用 takeLocalSnapshotToFile 截取视频画面时，会收到此回调报告截图是否成功，以及截取的图片信息。
onTakeRemoteSnapshotResult	调用 takeRemoteSnapshot 截取视频画面时，收到此回调。
onRemoteSnapshotTakenToFile	调用 takeRemoteSnapshotToFile 截取视频画面时，会收到此回调报告截图是否成功，以及截取的图片信息。

插件管理器

方法	描述
initializePluginManager	初始化插件管理器。
registerPlugin	注册插件库。
getPlugin	获取已注册插件的操作接口。
unregisterPlugin	卸载插件。
releasePluginManager	释放插件管理器。

高级功能

方法	描述
setAnsMode	支持根据业务场景，设置通话中的音频降噪模式。
setEarMonitorMode	开启/关闭耳返功能。
setEarMonitorVolume	设置耳返的音量。

回调	描述
onExtensionAccessError	当访问插件失败时，收到此回调。 RTC SDK 将一些功能封装成插件。当使用这些功能时，如果插件不存在，功能将无法使用。

最近更新时间：2026.10.10 20:08:47

这个页面对您有帮助吗？

有用

无用

实时音视频

引擎管理 #

房间管理 #

音频管理 #

视频管理 #

音视频传输 #

视频处理 #

音频处理 #

自定义流处理 #

网络管理 #

消息 #

推流至 CDN/WTN #

音效播放 #

音乐播放 #

屏幕共享 #

安全与加密 #

录制 #

空间音频 #

范围语音 #

字幕翻译服务 #

视频截图 #

插件管理器 #

高级功能 #

引擎管理

房间管理

音频管理

视频管理

音视频传输

视频处理

音频处理

自定义流处理

网络管理

消息

推流至 CDN/WTN

音效播放

音乐播放

屏幕共享

安全与加密

录制

空间音频

范围语音

字幕翻译服务

视频截图

插件管理器

高级功能