TUICallEngine Web SDK

Introduction

TUICallEngine Web SDK is based on Tencent Cloud's IM and Tencent Cloud's real-time communication solution. Supports audio and video calls in two-person and multi-person scenarios.

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

Environment Supports

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

``text
Please be sure to use HTTPS protocol or localhost to deploy your Web App, otherwise a navigator.mediaDevices not found error will occur!
`

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




Install


npm:
`
$ npm install @trtc/call-engine-lite-js --save
`

yarn:
`
$ yarn add @trtc/call-engine-lite-js
`

Download manually：

1. download @trtc/call-engine-lite-js.
2. copy @trtc/call-engine-lite-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

Explore SDK documents：TUICallEngine Web SDK

API Overview

- TUICallEngine is the main entry for TUICallEngine SDK, providing APIs such as create tuiCallEngine instance TUICallEngine.createInstance, tuiCallEngine.login, start single or group calls tuiCallEngine.calls.
- tuiCallEngine instance, provides the core capability for real-time audio and video calls.
- Start single or group calls calls
- Accept call accept
- Reject call reject
- Hangup call hangup
- Turn on camera openCamera
- Turn on microphone openMicrophone
- Turn off camera closeCamera
- Turn off microphone closeMicrophone
- Play remote video startRemoteView
- Stop playing remote video stopRemoteView

Directory

`
├── README-zh_CN.md
├── README.md
├── index.js // sdk file base on UMD modules
├── index.esm.js // sdk file base on ESM modules
├── index.cjs.js // sdk file base on CommonJS modules
├── index.d.ts // ts declaration file
└── package.json
``