TRTC Web SDK

English | 简体中文

Tencent Real-Time Communication (TRTC) Web SDK is a professional WebRTC SDK for building real-time video calls, voice calls, live streaming, video conferencing, online education, and interactive social experiences in web applications.

What is TRTC?

TRTC (Tencent Real-Time Communication) is Tencent Cloud's real-time audio and video platform. This repository contains the Web SDK, demo projects, and feature samples for browser-based RTC applications.

With TRTC Web SDK, you can build:

• 1-to-1 and group video calls for social, healthcare, and customer support apps
• Voice calls and voice rooms for gaming, communities, and social audio products
• Interactive live streaming with host-audience scenarios
• Video conferencing with screen sharing and device control
• Online education and collaboration products running directly in browsers

TRTC Product Family

TRTC offers both core SDKs and ready-to-use UI kits, so teams can start quickly or build fully custom RTC experiences.

Product	Best for	Platforms
AI Real-Time Conversation	Low-latency AI voice and conversational interaction	Web, Android, iOS, Flutter, React Native, Electron, Windows, macOS
Chat	Instant messaging, one-to-one chat, group chat, and conversation capabilities	Web, Mini Program, uni-app, Android, iOS, macOS, Windows, Flutter, React Native, HarmonyOS, Unity, Unreal Engine
TUICallKit	1v1 and group audio/video calling UI	Web, Android, iOS, Flutter, uni-app, WeChat Mini Program
TUIRoomKit	Video conferencing and online meetings UI	Web, Android, iOS, Flutter, uni-app (Mini Program / Client)
TUILiveKit	Interactive live streaming and voice room UI	Web, Android, iOS, Flutter, uni-app, React Native (headless), Windows (Electron)
TRTC SDK	Cross-platform real-time audio and video SDK for fully customized development	Web, Android, iOS, macOS, Windows, Flutter, Electron, React Native

Why developers use TRTC Web SDK

• Built on Tencent RTC’s globally proven real-time network: backed by Tencent’s long-standing expertise in audio/video and network technology, with below 300 ms end-to-end latency for calling scenarios, below 1000 ms audience latency for live streaming, and over 99.99% service uptime
• Low-latency, production-ready communication: optimized for video calls, voice calls, interactive live streaming, conferencing, and other scenarios that need fast join times, stable connectivity, and smooth interaction
• Cross-browser support with cross-platform interoperability: works on major modern desktop and mobile browsers and fits naturally into product ecosystems that also span Android, iOS, Flutter, Electron, and React Native
• Flexible integration model: supports vanilla JavaScript, Vue, and any web framework, so teams can prototype quickly or integrate into existing frontend architectures
• Ready for meetings, live streaming, and richer RTC workflows: beyond calling, it supports screen sharing, host/audience live streaming, cross-room co-hosting, and other common real-time interaction patterns
• Strong diagnostics for devices, environments, and challenging networks: includes browser capability checks, permission and device detection, network quality evaluation, device hot-plug handling, and debug workflows
• Advanced media and live orchestration: custom capture/rendering, multi-user video with small stream, cloud mixing and CDN streaming, watermarking, and video mixer workflows for more complex media pipelines
• Plugin-based enhancement and AI capabilities: audio mixer, beauty/basic beauty, virtual background, AI noise reduction, voice changer, face detection, small-stream auto switching, and real-time transcription/translation
• Clear path from core SDK to faster delivery: build deeply customized RTC experiences with the SDK, or move faster with Call, Conference, Live, Chat, and other UIKit-based solutions in the Tencent RTC ecosystem

Quick Start

Install

npm install trtc-sdk-v5 --save

or

yarn add trtc-sdk-v5

You can also download trtc.js manually and include it in your project.

Basic Usage

importTRTCfrom'trtc-sdk-v5';consttrtc=TRTC.create();awaittrtc.enterRoom({
sdkAppId,
userId,
userSig,strRoomId: 'room_123',});awaittrtc.startLocalVideo({view: document.getElementById('local-video'),});awaittrtc.startLocalAudio();

Security note: Generate userSig on your application server for production. Do not expose SDKSecretKey in frontend code.

Useful links

• Demo Quick Run
• Integration Quick Start
• TRTC Web SDK API Reference
• Supported Browsers

Common Questions This Repository Helps Answer

How do I add video calling to my web app?

Install trtc-sdk-v5, create a TRTC instance, call enterRoom(), then start local audio and video. If you want the most complete modern starter in this repository, begin with quick-demo-react, then use the other quick demos as framework-specific references.

Does TRTC Web SDK work with React, Vue, or other frameworks?

Yes. TRTC Web SDK works with any JavaScript framework. This repository now includes a React + TypeScript demo as the primary recommended example, plus vanilla JavaScript, Vue 2, and Vue 3 + TypeScript demos for different project styles.

How do I implement screen sharing, live streaming, or other RTC features in browsers?

Start with the runnable demos in this repository. We recommend quick-demo-react first for a modern React-based integration reference, then samples for feature-specific examples, followed by quick-demo-js, quick-demo-vue2-js, and quick-demo-vue3-ts when you want lighter or framework-targeted demos.

Repository Guide

Directory	What it contains	Notes
quick-demo-react	React 18 + TypeScript + Vite quick demo	Recommended first demo for modern web projects
quick-demo-js	Quick start demo built with vanilla JavaScript	Good for understanding the bare SDK flow quickly
quick-demo-vue2-js	Vue 2 demo	Good for legacy Vue projects
quick-demo-vue3-ts	Vue 3 + TypeScript demo	Good for Vue 3 + TypeScript projects
samples	Feature demos such as screen sharing and live streaming	Best for exploring specific capabilities
SDK	TRTC Web SDK v5.x files	Recommended SDK version
v4	TRTC Web SDK v4.x files	Legacy version, not recommended for new projects

Browser Support

TRTC Web SDK supports major modern browsers.

Browser	Version
Chrome	56+
Edge	80+
Firefox	56+
Safari	11+
iOS Safari	11+
Opera	46+

Other TRTC Repositories

Platform / Product	Repository
Android SDK	TRTC_Android
iOS SDK	TRTC_iOS
Flutter UIKit	TUIKit_Flutter
React Native UIKit	TUIKit_ReactNative
Calling UI Kit	TUICallKit
Meeting UI Kit	TUIRoomKit
Live UI Kit	TUILiveKit

Resources

• Official Website
• Documentation Center
• Online Demo (quick-demo-js)
• Changelog
• FAQ
• Contact Technical Support

Contact Us

• If you find a bug, please create an issue in this repository.
• If you need technical support for your TRTC project, see Contact Technical Support.