trtc-sdk-v5

TRTC Web SDK

An object-oriented WebRTC SDK library

English | 简体中文

Introduction

TRTC Web SDK is an object-oriented WebRTC SDK of Tencent Cloud's real-time communication solution. Web developers can use TRTC Web SDK to establish an audio/video calls or live streaming services on your website.

• Online Demo.
• Changelog.
• We offer SDKs for Web, Android, iOS, Windows, Flutter, explore more in trtc.io.

Environment Supports

TRTC Web SDK supports major modern browsers. For details, please refer to Browsers Supported.

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

Install

npm:

$ npm install trtc-sdk-v5 --save

yarn:

$ yarn add trtc-sdk-v5

Download manually：

1. download trtc.js.
2. copy trtc.js to your project.

Usage

Refer to the following two tutorials for a quick run-through of the demo and how to use the SDK to implement basic audio and video calling functionality.

• Demo Quick Run.
• Integration Quick Start.

Explore SDK API documents：TRTC Web SDK.

API Overview

• TRTC is the main entry for TRTC SDK, providing APIs such as create trtc instance(TRTC.create), TRTC.getCameraList, TRTC.getMicrophoneList, TRTC.isSupported.
• trtc instance, provides the core capability for real-time audio and video calls.
  • Enter room trtc.enterRoom
  • Exit room trtc.exitRoom
  • Turn on camera trtc.startLocalVideo
  • Turn on microphone trtc.startLocalAudio
  • Turn off camera trtc.stopLocalVideo
  • Turn off microphone trtc.stopLocalAudio
  • Play remote video trtc.startRemoteVideo
  • Stop playing remote video trtc.stopRemoteVideo
  • Mute/unmute remote audio trtc.muteRemoteAudio

Directory

├── README.md
├── package.json
├── trtc.js // sdk file(umd format)
├── trtc.esm.js // sdk file base on ES modules(esm format)
├── index.d.ts // ts declaration file
├── plugins // sdk plugins
└── assets // static resource directory (e.g., required for features like virtual background, AI noise reduction, etc., which need to be deployed on the server for the SDK to dynamically load resources)