@tencentcloud/call-engine-wx

TUICallEngine WX SDK

An object-oriented TUICallEngine SDK library

English | 简体中文

Install

npm:

$ npm install @tencentcloud/call-engine-wx --save

yarn:

$ yarn add @tencentcloud/call-engine-wx

Download manually：

1. download @tencentcloud/call-engine-wx.
2. copy @tencentcloud/call-engine-wx 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
• TUICallEngine Github Demo

Explore SDK documents：TUICallEngine WX SDK

API Overview

• 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

`