tencent cloud

Tencent Real-Time Communication

Release Notes and Announcements
Release Notes
Recent Product Announcement
TRTC Live (TUILiveKit) Product Launch Announcement
TRTC Conference Official Editions Launched
The commercial version of Conference is coming soon
Terms and Conditions Applicable to $9.9 Starter Package
Rules for the "First Subscription $100 Discount" Promotion
Announcement on the Start of Beta Testing for Multi-person Audio and Video Conference
TRTC Call Official Editions Launched
License Required for Video Playback in New Version of LiteAV SDK
TRTC to Offer Monthly Packages
Product Introduction
Overview
Concepts
Features
Strengths
Use Cases
Performance Statistics
Tencent RTC Quickplay: Experience Ultimate Real-Time Audio and Video Interaction!
Purchase Guide
Billing Overview
Free Minutes
Monthly subscription
Pay-as-you-go
TRTC Overdue and Suspension Policy
FAQs
Refund Instructions
User Tutorial
Free Demo
Call
Overview
Activate the Service
Run Demo
Integration
Offline Call Push
Conversational Chat
On-Cloud Recording
AI Noise Reduction
UI Customization
Calls integration to Chat
Additional Features
No UI Integration
Server APIs
Client APIs
Solution
ErrorCode
Release Notes
FAQs
Conference
Overview(TUIRoomKit)
Activate the Service (TUIRoomKit)
Run Demo(TUIRoomKit)
Integration(TUIRoomKit)
Screen Sharing (TUIRoomKit)
Schedule a meeting (TUIRoomKit)
In-meeting Call (TUIRoomKit)
UI Customization(TUIRoomKit)
Virtual Background (TUIRoomKit)
Conference Control (TUIRoomKit)
Cloud Recording (TUIRoomKit)
AI Noise Reduction (TUIRoomKit)
In-Conference Chat (TUIRoomKit)
Robot Streaming (TUIRoomKit)
Enhanced Features (TUIRoomKit)
Client APIs (TUIRoomKit)
Server APIs (TUIRoomKit)
FAQs (TUIRoomKit)
Error Code (TUIRoomKit)
SDK Update Log (TUIRoomKit)
Live
Billing of Video Live Component
Overview
Activating the Service (TUILiveKit)
Run Demo
No UI Integration
UI Customization
Live Broadcast Monitoring
Video Live Streaming
Voice Chat Room
Advanced Features
Client APIs
Server APIs
Error Codes
Release Notes
FAQs
RTC Engine
Activate Service
SDK Download
API Examples
Usage Guidelines
API Reference Manual
Advanced Features
AI Integration
Overview
Configure MCP Server
Install Skills
Integration Guide
FAQ
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
Console Guide
Application Management
Package Management
Usage Statistics
Monitoring Dashboard
Development Assistance
Solution
Real-Time Chorus
FAQs
Migration Guide
Billing
Features
UserSig
Firewall Restrictions
How to Downsize Installation Package
Android and iOS
Web
Flutter
Electron
TRTCCalling for Web
Audio and Video Quality
Others
Legacy Documentation
RTC RoomEngine SDK(Old)
Integrating TUIRoom (Web)
Integrating TUIRoom (Android)
Integrating TUIRoom (iOS)
Integrating TUIRoom (Flutter)
Integrating TUIRoom (Electron)
TUIRoom APIs
On-Cloud Recording and Playback (Old)
RTC Analytics Monthly Packages (Previous Version)
Protocols and Policies
Compliance
Security White Paper
Notes on Information Security
Service Level Agreement
Apple Privacy Policy: PrivacyInfo.xcprivacy
TRTC Policy
Privacy Policy
Data Processing And Security Agreement
Glossary

Preparation (Web React Desktop Browser)

PDF
Focus Mode
Font Size
Last updated: 2026-02-27 17:27:47

Feature Preview

TUILiveKit React is a feature-rich web live streaming component that provides comprehensive live streaming capabilities out of the box:


Preparation

Activate the Service

Before using TUILiveKit, you'll need to activate the service first. See Activate Services to get a trial version or activate the paid version.

Environment Requirements

Devices: Camera, microphone, and speakers

Configuration Requirements

Node.js: ≥ 18.19.1 (Official LTS version recommended, check your current version with node -v command)
react: ≥ 18.2.0 and < 19.0.0
vite: ≥ 5.4.0
typescript: ≥ 5.8.3
sass: ≥ 1.77.0

Code Integration

Step 1: Install Dependencies

Choose your preferred package manager:
npm
pnpm
yarn
npm install tuikit-atomicx-react @tencentcloud/uikit-base-component-react --save
pnpm install tuikit-atomicx-react @tencentcloud/uikit-base-component-react
yarn install tuikit-atomicx-react @tencentcloud/uikit-base-component-react

Step 2: Complete Login

Completing login is the foundation for using TUILiveKit. TUILiveKit features can only be used normally after successful login. Make sure all parameters are configured correctly before proceeding.
Note:
While the sample code shows direct login calls, we strongly recommend calling TUILiveKit's login service only after completing your own user authentication flow. This prevents business logic conflicts or data inconsistency issues and integrates better with your existing user management and permission systems.
// Best practice: Call this login logic immediately after your authentication flow completes
import { useLoginState } from 'tuikit-atomicx-react';

const { login, logout } = useLoginState();

async function initLogin() {
try {
await login({
SDKAppID: 0, // SDKAppID - SDKAppID obtained when activating service
userID: '', // UserID - User ID
userSig: '', // userSig - User signature, see parameter description below for detailed instructions
});
} catch (error) {
console.error('Login failed:', error);
}
}

Login API Parameter Description
Parameter
Type
Description
SDKAppID
Int
UserID
String
Unique identifier for the current user. It can only contain letters (a-z, A-Z), numbers (0-9), hyphens (-), and underscores (_).
userSig
String
A ticket for TRTC authentication:
Development Environment: Use GenerateTestUserSig.genTestSig locally or the UserSig Generation Tool to generate temporary credentials.
Production: Generate UserSig server-side to prevent key exposure. See Server-Side UserSig Generation.

Next Steps

After completing authentication, you can integrate TUILiveKit's live streaming features. Follow the guides below to implement audience viewing, live lists, and more:
Feature
Description
Integration Guide
Audience Viewing
Allow viewers to watch live streams, request co-hosting, view room information, see online audience, and interact via chat.
Live Room List
Display available live rooms with room information and status.
Host Streaming
Enable hosts to start broadcasts with pre-stream setup and in-stream interactions
Host Streaming (Vue3)(React support coming soon)

FAQ

Do I need to call login every time I enter a room?

No. You typically only need to call login() once. We strongly recommend integrating the login() and logout() functions returned by useLoginState() with your application's authentication system.

Why is HTTPS required for production deployments?

When deploying your application to production, you must use an HTTPS domain. TUILiveKit relies on WebRTC technology and requires access to users' cameras, microphones, and speakers. Browsers enforce HTTPS to protect user privacy and security when accessing these sensitive devices.
Note:
Protocol Requirements for Production:
Due to browser security policy restrictions, using WebRTC capabilities has strict requirements for page access protocols. Please refer to the following table for application development and deployment.
Environment
Protocol
Receive Stream
Send Stream
Screen Sharing
Notes
Production
HTTPS
Recommended
Production
HTTP
-
Local Development
http://localhost
Recommended
Local Development
http://127.0.0.1
-
Local Development
http://[Local IP]
-
Local Development
file://
-


Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback