动态与公告

产品动态

产品近期公告

关于 TRTC Live 正式上线的公告

关于TRTC Conference 正式版上线的公告

Conference 商业化版本即将推出

关于多人音视频 Conference 开启内测公告

关于音视频通话 Call 正式版上线的公告

关于腾讯云音视频终端 SDK 播放升级及新增授权校验的公告

关于 TRTC 应用订阅套餐服务上线的相关说明

产品简介

产品概述

基本概念

产品功能

产品优势

应用场景

性能数据

购买指南

计费概述

免费时长说明

月订阅

现收现付

TRTC 逾期与暂停政策

常见问题解答

退款说明

新手指引

Demo 体验

视频通话 SDK

组件介绍

开通服务

跑通 Demo

快速接入

离线唤醒

会话聊天

云端录制

AI 降噪

界面定制

Chat 集成通话能力

更多特性

无 UI 集成

服务端 API

客户端 API

解决方案

错误码表

发布日志

常见问题

视频会议 SDK

组件介绍（TUIRoomKit）

开通服务（TUIRoomKit）

跑通 Demo（TUIRoomKit）

快速接入（TUIRoomKit）

屏幕共享（TUIRoomKit）

预定会议（TUIRoomKit）

会中呼叫（TUIRoomKit）

界面定制（TUIRoomKit）

虚拟背景（TUIRoomKit）

会议控制（TUIRoomKit）

云端录制（TUIRoomKit）

AI 降噪（TUIRoomKit）

会中聊天（TUIRoomKit）

机器人推流（TUIRoomKit）

更多特性（TUIRoomKit）

客户端 API（TUIRoomKit）

服务端 API（TUIRoomKit）

常见问题（TUIRoomKit）

错误码 (TUIRoomKit)

SDK更新日志（TUIRoomKit）

直播与语聊 SDK

Live 视频直播计费说明

组件介绍

开通服务（TUILiveKit）

跑通 Demo

无 UI 集成

UI 自定义

直播监播

视频直播

语聊房

高级功能

客户端 API

服务端 API

错误码

发布日志

常见问题

RTC Engine

开通服务

SDK 下载

API-Example

接入指引

API-参考手册

高级功能

AI 集成

概述

MCP 配置

Skills 配置

集成指南

常见问题

RTC RESTFUL API

History

Introduction

API Category

Room Management APIs

Stream mixing and relay APIs

On-cloud recording APIs

Data Monitoring APIs

Pull stream Relay Related interface

Web Record APIs

AI Service APIs

Cloud Slicing APIs

Cloud Moderation APIs

Making API Requests

Call Quality Monitoring APIs

Usage Statistics APIs

Data Types

Appendix

Error Codes

控制台指南

应用管理

套餐包管理

用量统计

监控仪表盘

开发辅助

解决方案

实时合唱

常见问题

迁移指南

计费相关

功能相关

UserSig 相关

应对防火墙限制相关

缩减安装包体积相关

Andriod 与 iOS 相关

Web 端相关

Flutter 相关

Electron 相关

TRTCCalling Web 相关

音视频质量相关

其他问题

旧版文档

RTC RoomEngine SDK（旧）

集成 TUIRoom (Web)

集成 TUIRoom (Android)

集成 TUIRoom (iOS)

集成 TUIRoom (Flutter)

集成 TUIRoom (Electron)

TUIRoom API 查询

实现云端录制与回放（旧）

监控仪表盘计费（旧）

协议与策略

安全合规认证

安全白皮书

信息安全说明

服务等级协议

苹果隐私策略：PrivacyInfo.xcprivacy

TRTC 政策

隐私协议

数据处理和安全协议

词汇表

API 概览

PDF

聚焦模式

字号

最后更新时间： 2024-05-29 15:21:54

API 介绍
TRTC
注意：
本文适用于 5.x.x 版本的 TRTC Web SDK。
TRTC 对象通过调用 TRTC.create() 方法创建，提供实时音视频的核心能力：
进入一个音视频房间，调用 trtc.enterRoom() 方法。
退出当前音视频房间，调用 trtc.exitRoom() 方法。
预览/发布本地视频，调用 trtc.startLocalVideo() 方法。
采集/发布本地音频，调用 trtc.startLocalAudio() 方法。
取消预览/发布本地视频，调用 trtc.stopLocalVideo() 方法。
取消采集/发布本地音频，调用 trtc.stopLocalAudio() 方法。
观看远端视频，调用 trtc.startRemoteVideo() 方法。
取消观看远端视频，调用 trtc.stopRemoteVideo() 方法。
静默/取消静默远端音频，调用 trtc.muteRemoteAudio() 方法。
静态方法
API
描述
﻿create﻿
创建一个 TRTC 对象，用于实现进房、预览、推流、拉流等功能。
﻿setLogLevel﻿
设置日志输出等级建议在开发测试阶段设置为 DEBUG 等级，该日志等级包含详细的提示信息。默认输出 INFO 日志等级，该日志等级包含 SDK 主要功能的日志信息。
﻿isSupported﻿
检测 TRTC Web SDK 是否支持当前浏览器
﻿getCameraList﻿
返回摄像头设备列表
﻿getMicrophoneList﻿
返回麦克风设备列表
﻿getSpeakerList﻿
返回扬声器设备列表，出于安全的考虑，在用户未授权摄像头或麦克风访问权限前，label 及 deviceId 字段可能都是空的。因此建议在用户授权访问后再调用该接口获取设备详情。
﻿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﻿
开启或关闭音量大小回调
﻿on﻿
监听 TRTC 事件详细事件列表请参见：TRTC.EVENT﻿
﻿off﻿
取消事件监听
﻿getVideoSnapshot﻿
获取视频截图
﻿getVideoTrack﻿
获取视频轨道
﻿getAudioTrack﻿
获取音频轨道
﻿sendSEIMessage﻿
发送 SEI 消息
﻿sendCustomMessage﻿
发送自定义消息
﻿startPlugin﻿
开启插件
﻿updatePlugin﻿
更新插件
﻿stopPlugin﻿
停止插件
教程
您可以参考如下教程实现各种功能：
功能
Sample Code 指引
基础音视频通话
﻿指引链接﻿
实现互动直播连麦
﻿指引链接﻿
切换摄像头和麦克风
﻿指引链接﻿
设置本地视频属性
﻿指引链接﻿
开关摄像头、麦克风
﻿指引链接﻿
屏幕分享
﻿指引链接﻿
音量大小检测
﻿指引链接﻿
自定义采集与自定义播放渲染
﻿指引链接﻿
房间内上行用户个数限制
﻿指引链接﻿
通话前环境与设备检测
﻿指引链接﻿
通话前的网络质量检测
﻿指引链接﻿
设备插拔检测及采集异常处理
﻿指引链接﻿
开启水印
﻿指引链接﻿
最佳实践
最佳实践
指引链接
多人视频通话
﻿指引链接﻿
自动播放处理建议
﻿指引链接﻿
应对防火墙受限
﻿指引链接﻿
说明：
常见问题参见 Web 端相关。
支持的平台
TRTC Web SDK 基于 WebRTC 实现，目前支持桌面端和移动端的主流浏览器，详细支持度参见下方表格。理论上来说， SDK 支持所有基于 Chromium 56+ 版本的浏览器。

如果您的应用场景不在支持的表格里，可以使用 TRTC.isSupported() 接口 或者打开 TRTC Web SDK 能力检测页面 检测当前环境是否支持 WebRTC 所有能力。
操作系统
浏览器类型
浏览器最低版本要求
接收（播放）
发送（推流）
屏幕分享
Windows
Chrome
56+
支持
支持
Chrome 72+
﻿
Firefox
56+
支持
支持
Firefox 66+
﻿
Edge
80+
支持
支持
支持
﻿
Opera
46+
支持
支持
Opera 60+
MacOS
Chrome
56+
支持
支持
Chrome 72+
﻿
Safari
11+
支持
支持
Safari 13+
﻿
Edge
80+
支持
支持
支持
﻿
Firefox
56+
支持
支持
Firefox 66+
Android
Chrome
69+
支持
支持
不支持
﻿
Edge
80+
支持
支持
不支持
﻿
Firefox
56+
支持
支持
不支持
﻿
Opera
46+
支持
支持
不支持
iOS
Chrome
iOS 11+
支持
iOS 14.3+
不支持
﻿
Safari
iOS 11+
支持
支持
不支持
﻿
Edge
iOS 11+
支持
iOS 14.3+
不支持
﻿
Firefox
iOS 11+
支持
iOS 14.3+
不支持
注意
1. 由于 H.264 版权限制，华为 Chrome 88 以下版本以及部分厂商的 Android 设备，不具备 H264 编码能力（即无法推流）。如果您希望在这些设备的浏览器中，使用 TRTC Web SDK 推流，请 联系我们 开通 VP8 编解码能力。
2. Mac OS 下的 Firefox 
屏幕分享效果比较差且暂无解决方案，建议使用 Chrome 或者 Safari 进行屏幕分享。
3. 建议您及时将 TRTC Web SDK 更新至最新版本，以便获得更好的产品稳定性及在线支持。版本升级注意事项请参见：升级指引。
URL 域名协议限制
由于浏览器安全策略的限制，使用 WebRTC 能力对页面的访问协议有严格的要求，请参照以下表格进行开发和部署应用。
应用场景
协议
接收（播放）
发送（上麦）
屏幕分享
备注
生产环境
HTTPS 协议
支持
支持
支持
推荐
生产环境
HTTP 协议
支持
不支持
不支持
-
本地开发环境
http://localhost
支持
支持
支持
推荐
本地开发环境
http://127.0.0.1
支持
支持
支持
-
本地开发环境
http://[本机IP]
支持
不支持
不支持
-
本地开发环境
file:///
支持
支持
支持
-
联系我们
在 telegram 或 github 联系我们。

帮助和支持

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

填写满意度调查问卷，共创更好文档体验。

文档反馈

API	描述
create	创建一个 TRTC 对象，用于实现进房、预览、推流、拉流等功能。
setLogLevel	设置日志输出等级建议在开发测试阶段设置为 DEBUG 等级，该日志等级包含详细的提示信息。默认输出 INFO 日志等级，该日志等级包含 SDK 主要功能的日志信息。
isSupported	检测 TRTC Web SDK 是否支持当前浏览器
getCameraList	返回摄像头设备列表
getMicrophoneList	返回麦克风设备列表
getSpeakerList	返回扬声器设备列表，出于安全的考虑，在用户未授权摄像头或麦克风访问权限前，label 及 deviceId 字段可能都是空的。因此建议在用户授权访问后再调用该接口获取设备详情。
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	开启或关闭音量大小回调
on	监听 TRTC 事件详细事件列表请参见：TRTC.EVENT
off	取消事件监听
getVideoSnapshot	获取视频截图
getVideoTrack	获取视频轨道
getAudioTrack	获取音频轨道
sendSEIMessage	发送 SEI 消息
sendCustomMessage	发送自定义消息
startPlugin	开启插件
updatePlugin	更新插件
stopPlugin	停止插件

功能	Sample Code 指引
基础音视频通话	指引链接
实现互动直播连麦	指引链接
切换摄像头和麦克风	指引链接
设置本地视频属性	指引链接
开关摄像头、麦克风	指引链接
屏幕分享	指引链接
音量大小检测	指引链接
自定义采集与自定义播放渲染	指引链接
房间内上行用户个数限制	指引链接
通话前环境与设备检测	指引链接
通话前的网络质量检测	指引链接
设备插拔检测及采集异常处理	指引链接
开启水印	指引链接

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

操作系统	浏览器类型	浏览器最低版本要求	接收（播放）	发送（推流）	屏幕分享
Windows	Chrome	56+	支持	支持	Chrome 72+
		Firefox	56+	支持	支持	Firefox 66+
		Edge	80+	支持	支持	支持
		Opera	46+	支持	支持	Opera 60+
MacOS	Chrome	56+	支持	支持	Chrome 72+
		Safari	11+	支持	支持	Safari 13+
		Edge	80+	支持	支持	支持
		Firefox	56+	支持	支持	Firefox 66+
Android	Chrome	69+	支持	支持	不支持
		Edge	80+	支持	支持	不支持
		Firefox	56+	支持	支持	不支持
		Opera	46+	支持	支持	不支持
iOS	Chrome	iOS 11+	支持	iOS 14.3+	不支持
		Safari	iOS 11+	支持	支持	不支持
		Edge	iOS 11+	支持	iOS 14.3+	不支持
		Firefox	iOS 11+	支持	iOS 14.3+	不支持

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

tencent cloud

实时音视频

API 概览

API 介绍

TRTC

静态方法

成员方法

教程

最佳实践

支持的平台

URL 域名协议限制

联系我们

帮助和支持