@tencentcloud/call-engine-wx/README.md

Tencent Cloud TUICallEngine SDK for Wechat

<p align="center">
  <a href="https://trtc.io/">
    <img width="200" src="https://web.sdk.qcloud.com/trtc/webrtc/assets/trtc.io-logo.png">
  </a>
</p>

<h1 align="center" style="margin-top: -40px">TUICallEngine WX SDK</h1>

<div align="center">

An object-oriented TUICallEngine SDK library  

![NPM verison](https://img.shields.io/npm/v/@tencentcloud/call-engine-wx) [![NPM downloads](https://img.shields.io/npm/dw/@tencentcloud/call-engine-wx)](https://www.npmjs.com/package/@tencentcloud/call-engine-wx) [![Typescript Supported](https://img.shields.io/badge/Typescript-Supported-blue)](https://www.npmjs.com/package/@tencentcloud/call-engine-wx) [![Documents](https://img.shields.io/badge/-Documents-blue)](https://cloud.tencent.com/document/product/647/78761) [![Stars](https://img.shields.io/github/stars/tencentyun/TUICallKit?style=social)](https://github.com/tencentyun/TUICallKit) 

</div>

<div align="center"> English | <a href="https://github.com/Tencent-RTC/rtc-call-engine/tree/main/Web/demo-vue3" target="_blank"> 简体中文</a> </div>


## Install
npm:
```
$ npm install @tencentcloud/call-engine-wx --save
```

yarn:
```
$ yarn add @tencentcloud/call-engine-wx
```

Download manually：

1. download [@tencentcloud/call-engine-wx](https://www.unpkg.com/@tencentcloud/call-engine-wx@latest).
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](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/tutorial-00-%E5%AE%9E%E7%8E%B0%E5%8F%8C%E4%BA%BA%E9%80%9A%E8%AF%9D.html)
- [TUICallEngine Github Demo](https://github.com/Tencent-RTC/rtc-call-engine/tree/main/Web/demo-vue3)

Explore SDK documents：[TUICallEngine WX SDK](https://cloud.tencent.com/document/product/647/78761)


## API Overview
- [tuiCallEngine](https://cloud.tencent.com/document/product/647/78761#createinstance) instance, provides the core capability for real-time audio and video calls.
  - Start single or group calls [calls](https://cloud.tencent.com/document/product/647/78761#calls)
  - Accept call [accept](https://cloud.tencent.com/document/product/647/78761#accept)
  - Reject call [reject](https://cloud.tencent.com/document/product/647/78761#reject)
  - Hangup call [hangup](https://cloud.tencent.com/document/product/647/78761#hangup)
  - Turn on camera [openCamera](https://cloud.tencent.com/document/product/647/78761#opencamera)
  - Turn on microphone [openMicrophone](https://cloud.tencent.com/document/product/647/78761#openmicrophone)
  - Turn off camera [closeCamera](https://cloud.tencent.com/document/product/647/78761#closecamera)
  - Turn off microphone [closeMicrophone](https://cloud.tencent.com/document/product/647/78761#closemicrophone)
  - Play remote video [startRemoteView](https://cloud.tencent.com/document/product/647/78761#startremoteView)
  - Stop playing remote video [stopRemoteView](https://cloud.tencent.com/document/product/647/78761#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
```
`