Release Notes and Announcements
User Tutorial
Product Introduction
Purchase Guide
Free Demo
SDK Download
Integration (UI Included)
- TUIKit Overview
- Audio/Video Call
  - Overview (TUICallKit)
  - Integration (TUICallKit)
  - UI Customization (TUICallKit)
  - Offline Call Push (TUICallKit)
    - Android
    - iOS
      - VoIP
      - APNs
    - Flutter
  - On-Cloud Recording (TUICallKit)
  - API Documentation (TUICallKit)
  - Release Notes (TUICallKit)
  - FAQs
    - All Platform
    - Flutter
- Audio/Video Conference
  - Overview (TUIRoomKit)
  - Integration (TUIRoomKit)
  - UI Customization (TUIRoomKit)
  - API Documentation(TUIRoomKit)
    - iOS&Mac
    - Android
    - Windows
    - Web
    - Electron
    - Flutter
  - FAQs
  - Error Code
- Interactive Live Audio Streaming
  - Integrating TUIVoiceRoom (Android)
  - Integrating TUIVoiceRoom (iOS)
  - TUIVoiceRoom APIs
    - TRTCVoiceRoom (iOS)
    - TRTCVoiceRoom (Android)
- Interactive Video Streaming
- Online Karaoke
  - Quick Integration (TUIKaraoke)
    - iOS
    - Android
  - Solution Overview (TUIKaraoke)
    - Implementation Steps
    - Song Synchronization
      - iOS
      - Android
    - Lyric Synchronization
      - iOS
      - Android
    - Vocal Synchronization
      - iOS
      - Android
    - Mixing Stream Solution
      - iOS
      - Android
  - TUIKaraoke APIs
    - TRTCKaraoke (iOS)
    - TRTCKaraoke (Android)
  - FAQs
    - iOS
    - Android
Integration (No UI)
- 0. API Examples
- 1. Importing the SDK
- 2. Entering a Room
- 3. Subscribing to Audio/Video Streams
- 4. Publishing Audio/Video Streams
- 5. Exiting a Room
- 6. Sensing Network Quality
- 7. Enabling Screen Sharing
- 8. Sharing Computer Audio
- 9. Setting Video Quality
- 10. Rotating Videos
- 11.FAQs
  - FAQs for Beginners
Advanced Features
- Relay to CDN
- Enabling Advanced Permission Control
- RTMP Streaming with TRTC
- Testing Hardware Devices
  - Android&iOS&Windows&Mac
  - Web
- Testing Network Quality
  - Android&iOS&Windows&Mac
  - Web
- On-Cloud Recording
- Custom Capturing and Rendering
  - Android, iOS, Windows, and macOS
  - Web
- Custom Audio Capturing and Playback
  - Android, iOS, Windows, and macOS
  - Web
- Sending and Receiving Messages
- Event Callbacks
- Content Moderation
  - Specified-Room Moderation
- Access Management
- How to push stream to TRTC room with OBS WHIP
Sample Code
Client APIs
- iOS and macOS
- Android
- All Platforms (C++)
- Web
  - Overview
  - Error Codes
- Electron
  - Overview
  - Error Codes
- Flutter
  - Overview
  - Error Codes
- Unity
  - Overview
  - Error Codes
Server APIs
- History
- Introduction
- API Category
- Making API Requests
- Room Management APIs
- Call Quality Monitoring APIs
- Pull stream Relay Related interface
- Stream mixing and relay APIs
- On-cloud recording APIs
- Usage Statistics APIs
- Data Types
- Error Codes
- Appendix
  - Event ID Mapping Table
Console Guide
- Selection of Service region
- Application Management
- Package Management
- Usage Statistics
- Monitoring Dashboard
  - Call Data
  - Real-Time Monitoring
- Development Assistance
  - UserSig Generation and Verification
FAQs
Legacy Documentation
Service Level Agreement
TRTC Policy
- Privacy Policy
- Data Processing And Security Agreement
Glossary

Electron

Last updated: 2023-09-11 17:52:37Download PDF

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 and select RTC Engine on the left sidebar.
2. Click Start now, enter an application name such as APIExample. If you already have an application, click link existing application.
3. Add or edit tags according to your actual business needs and click Create application.
﻿
﻿
step 2. Get your SDKAppId and SecretKey
After your application created, you can get your SDKAppID and SecretKey on Basic informaction. SDKAppID and SecrentKey is needed for running demo.
﻿
﻿
Step 3. Download the sample code
Go to GitHub to download the sample code for your platform.
git clone https://github.com/LiteAVSDK/TRTC_Electron.git
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.
SECRETKEY: A placeholder by default. Set it to the actual key.
explain
The method for generating UserSig described in this document involves configuring SECRETKEY in the client code. In this method, SECRETKEY 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.