RTC Engine

Overview

Web
- Demo Quick Run
- SDK Quick Start
- Basic Features
  - Screen Sharing
  - Live Streaming
  - Media Device
  - Audio Volume
  - Set Encoding Profile
  - Detect Network Quality
  - Detect Capabilities
- Advance Features
  - Enable AI Denoiser
  - Enable Audio Mixer
  - Enable Watermark
  - Enable Beauty and Effects
  - SEI Message
  - Custom Capturing and Rendering
- Best Practices
  - Optimize Multi-Person Video Calls
  - Handle Autoplay Restriction
  - Handle Firewall Restriction
- API List
- Released Notes
- Supported Platforms
- Web FAQs
Android
- Integration
  - 1.API Examples
  - 2.Importing the SDK
  - 3.Entering a Room
  - 4.Subscribing to Audio/Video Streams
  - 5.Publish Audio/Video Streams
  - 6.Exiting a Room
  - 7.Sensing Network Quality
  - 8.Enabling Screen Sharing
  - 9.Setting Video Quality
  - 10.Rotating Videos
- Testing Newwork Quality
- Custom Capturing and Rendering
- Custom Audio Capturing and Playback
- Client APIs
  - Overview
  - TRTCCloud
  - TRTCStatistics
  - TRTCCloudListener
  - TXAudioEffectManager
  - TXBeautyManager
  - TXDeviceManager
  - Type Definition
  - Deprecated Interface
  - Error Codes
- Solution
  - Real-Time Chorus (TUIKaraoke)
    - Quick Integration
    - Implementation Steps
    - Song Synchronization
    - Lyric Synchronization
    - Vocal Synchronization
    - Mixing Stream Solution
    - TRTCKaraoke APIs
    - FAQs
- Release Notes
iOS
- Integration
  - 1.API Examples
  - 2.Importing the SDK
  - 3.Entering a Room
  - 4.Subscribing to Audio/Video Streams
  - 5.Publish Audio/Video Streams
  - 6.Exiting a Room
  - 7.Sensing Network Quality
  - 8.Enabling Screen Sharing
  - 9.Setting Video Quality
  - 10.Rotating Videos
- Testing Network Quality
- Custom Capturing and Rendering
- Custom Audio Capturing and Playback
- Client APIs
  - Overview
  - TRTCCloud
  - TRTCCloudDelegate
  - TRTCStatistics
  - TXAudioEffectManager
  - TXBeautyManager
  - TXDeviceManager
  - Type Definition
  - Deprecated Interface
  - ErrorCode
- Solution
  - Quick Integration
  - Implementation Steps
  - Song Synchronization
  - Lyric Synchronization
  - Vocal Synchronization
  - Mixing Stream Solution
  - TRTCKaraoke APIs
  - FAQs
- Release Notes
macOS
- Integration
  - 1.API Examples
  - 2.Importing the SDK
  - 3.Entering a Room
  - 4.Subscribing to Audio/Video Streams
  - 5.Publish Audio/Video Streams
  - 6.Exiting a Room
  - 7.Sensing Network Quality
  - 8.Enabling Screen Sharing
  - 9.Sharing Computer Audio
  - 10.Setting Video Quality
  - 11.Rotating Videos
- Testing Hardware Devices
- Testing Network Quality
- Custom Capturing and Rendering
- Custom Audio Capturing and Playback
- Client APIs
  - Overview
  - TRTCCloud
  - TRTCCloudDelegate
  - TRTCStatistics
  - TXAudioEffectManager
  - TXBeautyManager
  - TXDeviceManager
  - Type Definition
  - Deprecated Interface
  - ErrorCode
  - Release Notes
- Release Notes
Windows
- Integration
  - 1.API Examples
  - 2.Importing the SDK
  - 3.Entering a Room
  - 4.Subscribing to Audio/Video Streams
  - 5.Publish Audio/Video Streams
  - 6.Exiting a Room
  - 7.Sensing Network Quality
  - 8.Enabling Screen Sharing
  - 9.Setting Video Quality
  - 10.Rotating Videos
- Testing Hardware Devices
- Testing Network Quality
- Custom Capturing and Rendering
- Custom Audio Capturing and Playback
- Client APIs
  - Overview
  - ITRTCCloud
  - ITRTCStatistics
  - TRTCCloudCallback
  - ITXAudioEffectManager
  - ITXDeviceManager
  - Type Definition
  - Deprecated Interface
  - Error Codes
- Release Notes
Electron
- Integration
  - 1.API Examples
  - 2.Importing the SDK
  - 3.Entering a Room
  - 4.Subscribing to Audio/Video Streams
  - 5.Publish Audio/Video Streams
  - 6.Exiting a Room
  - 7.Sensing Network Quality
  - 8.Enabling Screen Sharing
  - 9.Sharing Computer Audio
  - 10.Setting Video Quality
  - 11.Rotating Videos
- Client APIs
  - Overview
  - Error Codes
Flutter
- Integration
  - 1.API Examples
  - 2.Importing the SDK
  - 3.Entering a Room
  - 4.Subscribing to Audio/Video Streams
  - 5.Publish Audio/Video Streams
  - 6.Exiting a Room
  - 7.Sensing Network Quality
  - 8.Enabling Screen Sharing
  - 9.Sharing Computer Audio
  - 10.Setting Video Quality
  - 11.Rotating Videos
- Client APIs
  - Overview
  - Error Codes
Unity
- Integration
  - 1.API Examples
  - 2Importing the SDK
- Client APIs
  - Overview
  - Error Codes
Qt
- Integration
  - 1.Importing the SDK
Overview
- Overview

Concepts
Features
Performance Statistics
Pricing
- RTC-Engine Packages
- Billing of On-Cloud Recording
- Billing of MixTranscoding and Relay to CDN
- Billing Explanation for Subscription Package Duration
- Billing of Monitoring Dashboard
- Free Minutes
- Pay-As-You-Go
Tencent RTC Quickplay: Experience Ultimate Real-Time Audio and Video Interaction!
FAQs
- FAQs for Beginners
- Migration Guide
  - Twilio Video to Tencent RTC
  - Billing
  - Features
  - UserSig
  - Firewall Restrictions
  - How to Downsize Installation Package
  - TRTCCalling for Web
  - Audio and Video Quality
  - Others

RTC Engine

1.API Examples

This document shows you how to quickly run TRTC-API-Example (Electron).
Prerequisites
You have signed up for a Tencent Cloud account.
Directions
Step 1. Create an application
1. Log in to the TRTC console overview page, click Create Application.
2. In the popup page, select RTC Engine, enter the application name, and then click Create.
﻿
﻿
﻿
Step 2. Get your SDKAppId and SecretKey
After your application created, you can get your SDKAppID and SDKSecretKey on Basic informaction. SDKAppID and SDKSecretKey is needed for running demo.
﻿
﻿
﻿
Step 3. Download the sample code
1.Go to GitHub to download the sample code for your platform.
git clone https://github.com/LiteAVSDK/TRTC_Electron.git
2.The steps to import SDK can refer to Electron SDK import.
Step 4. Configure the project
Find and open Electron/TRTC-API-Example/assets/debug/gen-test-user-sig.js and set the following parameters:
SDKAPPID: A placeholder by default. Set it to the actual SDKAppID.
SDKSECRETKEY: A placeholder by default. Set it to the actual key.
Note
The method for generating UserSig described in this document involves configuring SDKSECRETKEY in the client code. In this method, SDKSECRETKEY may be easily decompiled and reversed, and if your key is disclosed, attackers can steal your Tencent Cloud traffic. Therefore, this method is only suitable for the local execution and debugging of TRTC-API-Example.
The best practice is to integrate the calculation code of UserSig into your server and provide an application-oriented API. When UserSig is needed, your application can send a request to your server for a dynamic UserSig. For more information, see How do I calculate UserSig during production?.
FAQs
1. What firewall restrictions does the SDK face?
The SDK uses the UDP protocol for audio/video transmission and therefore cannot be used in office networks that block UDP. If you encounter such a problem, refer to Firewall Restrictions to troubleshoot the issue.