实时音视频 API 概览

API 介绍
TRTC 对象通过调用 TRTC.create() 方法创建，提供实时音视频的核心能力：
进入一个音视频房间，调用 trtc.enterRoom() 方法。
退出当前音视频房间，调用 trtc.exitRoom() 方法。
预览/发布本地视频，调用 trtc.startLocalVideo() 方法。
采集/发布本地音频，调用 trtc.startLocalAudio() 方法。
取消预览/发布本地视频，调用 trtc.stopLocalVideo() 方法。
取消采集/发布本地音频，调用 trtc.stopLocalAudio() 方法。
观看远端视频，调用 trtc.startRemoteVideo() 方法。
取消观看远端视频，调用 trtc.stopRemoteVideo() 方法。
静默/取消静默远端音频，调用 trtc.muteRemoteAudio() 方法。
静态方法
import TRTC from 'trtc-sdk-v5';
﻿
const trtc = TRTC.create();
API
描述
﻿create﻿
创建一个 TRTC 对象实例，用于实现进房、预览、推流、拉流等功能。
﻿setLogLevel﻿
设置日志输出等级。
﻿isSupported﻿
检测当前浏览器是否支持 TRTC Web SDK。
﻿getCameraList﻿
返回摄像头设备列表。
﻿getMicrophoneList﻿
返回麦克风设备列表。
﻿getSpeakerList﻿
返回扬声器设备列表。
﻿setCurrentSpeaker﻿
设置当前音频播放的扬声器。
成员方法
创建实例后调用。
分类
API
描述
房间相关
﻿enterRoom﻿
进入一个音视频通话房间（以下简称"进房"）。
﻿
﻿exitRoom﻿
退出当前音视频通话房间。
﻿
﻿switchRole﻿
切换用户角色，仅在 TRTC.TYPE.SCENE_LIVE 互动直播模式下生效。
﻿
﻿destroy﻿
销毁 TRTC 实例。
本地音频
﻿startLocalAudio﻿
开启本地麦克风采集，并发布到当前的房间中。
﻿
﻿updateLocalAudio﻿
更新本地麦克风配置。
﻿
﻿stopLocalAudio﻿
停止本地麦克风的采集及发布。
本地视频
﻿startLocalVideo﻿
开启本地摄像头采集，在您指定的 HTMLElement 标签下播放摄像头画面，并将摄像头画面发布到当前所在房间中。
﻿
﻿updateLocalVideo﻿
更新本地摄像头配置。
﻿
﻿stopLocalVideo﻿
停止本地摄像头的采集、预览及发布。
本地屏幕分享
﻿startScreenShare﻿
开启屏幕分享。
﻿
﻿updateScreenShare﻿
更新屏幕分享配置。
﻿
﻿stopScreenShare﻿
停止屏幕分享。
远端视频
﻿startRemoteVideo﻿
播放远端视频。
﻿
﻿updateRemoteVideo﻿
更新远端视频播放配置。
﻿
﻿stopRemoteVideo﻿
用于停止远端视频播放。
远端音频
﻿muteRemoteAudio﻿
静音某个远端用户，并且不再拉取该用户的音频数据。仅对当前用户有效，房间内的其他用户依然可以听到被静音用户的声音。
﻿
﻿setRemoteAudioVolume﻿
用于控制远端音频的播放音量。
﻿
﻿enableAudioVolumeEvaluation﻿
开启或关闭音量大小回调。
插件相关
﻿startPlugin﻿
开启插件。
﻿
﻿updatePlugin﻿
更新插件。
﻿
﻿stopPlugin﻿
停止插件。
其他
﻿on﻿
监听 TRTC 事件，详细事件列表请参见：TRTC.EVENT。
﻿
﻿off﻿
取消事件监听。
﻿
﻿getVideoSnapshot﻿
获取视频截图。
﻿
﻿getVideoTrack﻿
获取视频轨道。
﻿
﻿getAudioTrack﻿
获取音频轨道。
消息收发
﻿sendSEIMessage﻿
发送 SEI 消息。
﻿
﻿sendCustomMessage﻿
发送自定义消息。
基础教程
功能
示例代码指引
开始集成音视频通话
﻿指引链接﻿
实现互动直播连麦
﻿指引链接﻿
切换摄像头和麦克风
﻿指引链接﻿
设置本地视频属性
﻿指引链接﻿
开关摄像头、麦克风
﻿指引链接﻿
屏幕分享
﻿指引链接﻿
音量大小检测
﻿指引链接﻿
调试模式
﻿指引链接﻿
高级教程
功能
示例代码指引
自定义采集与自定义播放渲染
﻿指引链接﻿
开启混音插件
﻿指引链接﻿
通话前环境与设备检测
﻿指引链接﻿
检测网络质量
﻿指引链接﻿
处理设备插拔
﻿指引链接﻿
云端混流和转推 CDN
﻿指引链接﻿
开启水印
﻿指引链接﻿
实现跨房连麦
﻿指引链接﻿
实时语音识别
﻿指引链接﻿
开启 AI 降噪
﻿指引链接﻿
开启虚拟背景
﻿指引链接﻿
开启美声效果
﻿指引链接﻿
开启基础美颜
﻿指引链接﻿
开启本地合流
﻿指引链接﻿
最佳实践
最佳实践
示例代码指引
多人视频通话
﻿指引链接﻿
自动播放处理建议
﻿指引链接﻿
应对防火墙受限
﻿指引链接﻿
说明：
常见问题参见 Web 端相关。
支持的平台
TRTC Web SDK 基于 WebRTC 实现，目前支持桌面端和移动端的主流浏览器，详细支持度参见下方表格。
如果您的应用场景不在支持的表格里（例如 WebView），可以使用 TRTC.isSupported 接口 或者 打开 TRTC Web SDK 能力检测页面 检测当前环境是否支持 WebRTC 所有能力。
PC 端
操作系统
浏览器
浏览器最低版本要求
拉流
推流
屏幕分享
备注
Windows
Chrome
56+
支持
支持
Chrome 72+
-
Windows
Edge
80+
支持
支持
Edge 80+
-
Windows
Firefox
56+
支持
支持
Firefox 66+
-
Windows
其他
Chromium 56+
支持
支持
Chromium 72+
其他浏览器例如 QQ 浏览器、Opera 等基本都是基于 Chromium 内核开发的，所以关注 Chromium 版本即可。
Mac
Safari
11+
支持
支持
Safari 13+
-
Mac
Chrome
56+
支持
支持
Chrome 72+
-
Mac
Edge
80+
支持
支持
Edge 80+
-
Mac
Firefox
56+
支持
支持
Firefox 66+
-
ChromeOS
Chrome
56+
支持
支持
Chrome 72+
-
移动端
操作系统
浏览器
浏览器最低版本要求
拉流
推流
屏幕分享
备注
Android
Chrome
85+
支持
支持
不支持
85 以下的版本 Chrome 已知缺陷可能会导致推拉流失败，建议使用 Chrome 85+ 版本。
Android
Edge
85+
支持
支持
不支持
-
Android
Firefox
56+
支持
支持
不支持
-
Android
微信内嵌浏览器
-
支持
支持
不支持
-
Android
其他
Chromium 85+
支持
支持
不支持
其他浏览器例如 QQ 浏览器、UC 浏览器、小米浏览器等是基于 Chromium 内核开发的，建议以 TRTC.isSupported 接口实际检测结果为准。
iOS
Safari
11+
支持
支持
不支持
-
iOS
Chrome
11+
支持
iOS 14.3+
不支持
iOS 中非 Safari 浏览器都是基于 WKWebView 实现的，WKWebview 在 iOS 14.3+ 才支持采集摄像头、麦克风能力。
HarmonyOS
华为浏览器
-
支持
支持
不支持
-
注意：
建议您及时将 TRTC Web SDK 更新至最新版本，以便获得更好的产品稳定性及在线支持。版本升级注意事项请参见：升级指引。
URL 域名协议限制
由于浏览器安全策略的限制，使用 WebRTC 能力对页面的访问协议有严格的要求，请参照以下表格进行开发和部署应用。
应用场景
协议
接收（播放）
发送（上麦）
屏幕分享
备注
生产环境
HTTPS 协议
支持
支持
支持
推荐
生产环境
HTTP 协议
支持
不支持
不支持
-
本地开发环境
http://localhost
支持
支持
支持
推荐
本地开发环境
http://127.0.0.1
支持
支持
支持
-
本地开发环境
http://[本机 IP]
支持
不支持
不支持
-
本地开发环境
file:///
支持
支持
支持
-
联系我们
若您遇到任何问题，请随时 联系我们。

API	描述
create	创建一个 TRTC 对象实例，用于实现进房、预览、推流、拉流等功能。
setLogLevel	设置日志输出等级。
isSupported	检测当前浏览器是否支持 TRTC Web SDK。
getCameraList	返回摄像头设备列表。
getMicrophoneList	返回麦克风设备列表。
getSpeakerList	返回扬声器设备列表。
setCurrentSpeaker	设置当前音频播放的扬声器。

分类	API	描述
房间相关	enterRoom	进入一个音视频通话房间（以下简称"进房"）。
		exitRoom	退出当前音视频通话房间。
		switchRole	切换用户角色，仅在 TRTC.TYPE.SCENE_LIVE 互动直播模式下生效。
		destroy	销毁 TRTC 实例。
本地音频	startLocalAudio	开启本地麦克风采集，并发布到当前的房间中。
		updateLocalAudio	更新本地麦克风配置。
		stopLocalAudio	停止本地麦克风的采集及发布。
本地视频	startLocalVideo	开启本地摄像头采集，在您指定的 HTMLElement 标签下播放摄像头画面，并将摄像头画面发布到当前所在房间中。
		updateLocalVideo	更新本地摄像头配置。
		stopLocalVideo	停止本地摄像头的采集、预览及发布。
本地屏幕分享	startScreenShare	开启屏幕分享。
		updateScreenShare	更新屏幕分享配置。
		stopScreenShare	停止屏幕分享。
远端视频	startRemoteVideo	播放远端视频。
		updateRemoteVideo	更新远端视频播放配置。
		stopRemoteVideo	用于停止远端视频播放。
远端音频	muteRemoteAudio	静音某个远端用户，并且不再拉取该用户的音频数据。仅对当前用户有效，房间内的其他用户依然可以听到被静音用户的声音。
		setRemoteAudioVolume	用于控制远端音频的播放音量。
		enableAudioVolumeEvaluation	开启或关闭音量大小回调。
插件相关	startPlugin	开启插件。
		updatePlugin	更新插件。
		stopPlugin	停止插件。
其他	on	监听 TRTC 事件，详细事件列表请参见：TRTC.EVENT。
		off	取消事件监听。
		getVideoSnapshot	获取视频截图。
		getVideoTrack	获取视频轨道。
		getAudioTrack	获取音频轨道。
消息收发	sendSEIMessage	发送 SEI 消息。
消息收发		sendCustomMessage	发送自定义消息。

功能	示例代码指引
开始集成音视频通话	指引链接
实现互动直播连麦	指引链接
切换摄像头和麦克风	指引链接
设置本地视频属性	指引链接
开关摄像头、麦克风	指引链接
屏幕分享	指引链接
音量大小检测	指引链接
调试模式	指引链接

功能	示例代码指引
自定义采集与自定义播放渲染	指引链接
开启混音插件	指引链接
通话前环境与设备检测	指引链接
检测网络质量	指引链接
处理设备插拔	指引链接
云端混流和转推 CDN	指引链接
开启水印	指引链接
实现跨房连麦	指引链接
实时语音识别	指引链接
开启 AI 降噪	指引链接
开启虚拟背景	指引链接
开启美声效果	指引链接
开启基础美颜	指引链接
开启本地合流	指引链接

最佳实践	示例代码指引
多人视频通话	指引链接
自动播放处理建议	指引链接
应对防火墙受限	指引链接

操作系统	浏览器	浏览器最低版本要求	拉流	推流	屏幕分享	备注
Windows	Chrome	56+	支持	支持	Chrome 72+	-
Windows	Edge	80+	支持	支持	Edge 80+	-
Windows	Firefox	56+	支持	支持	Firefox 66+	-
Windows	其他	Chromium 56+	支持	支持	Chromium 72+	其他浏览器例如 QQ 浏览器、Opera 等基本都是基于 Chromium 内核开发的，所以关注 Chromium 版本即可。
Mac	Safari	11+	支持	支持	Safari 13+	-
Mac	Chrome	56+	支持	支持	Chrome 72+	-
Mac	Edge	80+	支持	支持	Edge 80+	-
Mac	Firefox	56+	支持	支持	Firefox 66+	-
ChromeOS	Chrome	56+	支持	支持	Chrome 72+	-

应用场景	协议	接收（播放）	发送（上麦）	屏幕分享	备注
生产环境	HTTPS 协议	支持	支持	支持	推荐
生产环境	HTTP 协议	支持	不支持	不支持	-
本地开发环境	http://localhost	支持	支持	支持	推荐
本地开发环境	http://127.0.0.1	支持	支持	支持	-
本地开发环境	http://[本机 IP]	支持	不支持	不支持	-
本地开发环境	file:///	支持	支持	支持	-

API 概览

本页目录：

API 介绍

静态方法

成员方法

基础教程

高级教程

最佳实践

支持的平台

PC 端

移动端

URL 域名协议限制

联系我们