@trtc/call-engine-lite-js 3.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (10) hide show
  1. package/README-zh_CN.md +86 -0
  2. package/README.md +89 -0
  3. package/index.cjs.js +4 -0
  4. package/index.cjs.js.map +1 -0
  5. package/index.d.ts +1171 -0
  6. package/index.esm.js +4 -0
  7. package/index.esm.js.map +1 -0
  8. package/index.js +4 -0
  9. package/index.js.map +1 -0
  10. package/package.json +35 -0
package/README-zh_CN.md ADDED
@@ -0,0 +1,86 @@
1
+ <p align="center">
2
+ <a href="https://trtc.io/">
3
+ <img width="200" src="https://web.sdk.qcloud.com/trtc/webrtc/assets/trtc.io-logo.png">
4
+ </a>
5
+ </p>
6
+
7
+ <h1 align="center" style="margin-top: -40px">TUICallEngine Web SDK</h1>
8
+
9
+ <div align="center">
10
+
11
+ ![NPM verison](https://img.shields.io/npm/v/@trtc/call-engine-lite-js) [![NPM downloads](https://img.shields.io/npm/dw/@trtc/call-engine-lite-js)](https://www.npmjs.com/package/@trtc/call-engine-lite-js) [![Typescript Supported](https://img.shields.io/badge/Typescript-Supported-blue)](https://www.npmjs.com/package/@trtc/call-engine-lite-js) [![Documents](https://img.shields.io/badge/-Documents-blue)](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html) [![Stars](https://img.shields.io/github/stars/tencentyun/TUICallKit?style=social)](https://github.com/tencentyun/TUICallKit)
12
+
13
+ </div>
14
+
15
+ <div align="center"> English | <a href="https://github.com/tencentyun/TUICallKit/tree/main/Web/call-engine-demo-vue3" target="_blank"> 简体中文</a> </div>
16
+
17
+
18
+ ## 简介
19
+ TUICallEngine 是基于腾讯云 [即时通信 IM](https://cloud.tencent.com/document/product/269/42440) 和 [实时音视频 TRTC](https://cloud.tencent.com/document/product/647/16788) 两项付费 PaaS 服务构建出的音视频通信 SDK，支持双人和多人场景下的音视频通话。
20
+
21
+ - [在线 Demo](https://rtcube.cloud.tencent.com/prerelease/component/experience-center/index.html#/detail?scene=callkit)
22
+ - [更新日志](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/tutorial-20-CHANGELOG.html)
23
+ - 我们提供适用于 Web、Android、iOS、小程序、Flutter 的 SDK，更多信息请参见 [trtc.io](https://cloud.tencent.com/document/product/647/78742)。
24
+
25
+
26
+ ## 环境支持
27
+ TUICallEngine Web SDK 支持市面上主流浏览器，详情参考：[浏览器支持情况](https://web.sdk.qcloud.com/trtc/webrtc/v5/doc/zh-cn/tutorial-05-info-browser.html)。
28
+
29
+ ```text
30
+ 请务必使用 HTTPS 协议或者 localhost 来部署您的 Web App，否则会出现找不到 navigator.mediaDevices 错误！
31
+ ```
32
+
33
+ | [<img src="https://web.sdk.qcloud.com/trtc/webrtc/assets/logo/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Chrome | [<img src="https://web.sdk.qcloud.com/trtc/webrtc/assets/logo/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/> Edge | [<img src="https://web.sdk.qcloud.com/trtc/webrtc/assets/logo/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Firefox | [<img src="https://web.sdk.qcloud.com/trtc/webrtc/assets/logo/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Safari | [<img src="https://web.sdk.qcloud.com/trtc/webrtc/assets/logo/safari-ios_48x48.png" alt="iOS Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>iOS Safari | [<img src="https://web.sdk.qcloud.com/trtc/webrtc/assets/logo/opera_48x48.png" alt="Opera" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Opera |
34
+ | --------- | --------- | --------- | --------- | --------- | --------- |
35
+ | 56+ | 80+ | 56+ | 11+ | 11+ | 46+ |
36
+
37
+
38
+ ## 安装
39
+ 使用 npm:
40
+ ```
41
+ $ npm install @trtc/call-engine-lite-js --save
42
+ ```
43
+
44
+ 使用 yarn:
45
+ ```
46
+ $ yarn add @trtc/call-engine-lite-js
47
+ ```
48
+
49
+ 手动下载 sdk 包：
50
+ 1. 下载 [@trtc/call-engine-lite-js](https://www.unpkg.com/@trtc/call-engine-lite-js@latest)。
51
+ 2. 将 `@trtc/call-engine-lite-js` 复制到你的项目中。
52
+
53
+
54
+ ## 使用
55
+ 参考下述两个教程，可快速跑通 Demo 及了解如何使用 SDK 实现基础音视频通话功能。
56
+
57
+ - [实现双人通话](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/tutorial-00-%E5%AE%9E%E7%8E%B0%E5%8F%8C%E4%BA%BA%E9%80%9A%E8%AF%9D.html)
58
+
59
+ TUICallEngine API 文档详见：[TUICallEngine Web SDK](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html)。
60
+
61
+
62
+ ## API 概要
63
+ - [TUICallEngine](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html) 是整个 SDK 的主入口，提供创建 tuiCallEngine 对象 [TUICallEngine.createInstance](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#.createInstance)。登录 [tuiCallEngine.login](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#login)。发起 1v1（或多人） 通话 [tuiCallEngine.calls](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#calls)。
64
+ - [tuiCallEngine](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html) 对象，提供实时音视频通话的核心能力。
65
+ - 开始 1v1（或多人） 通话 [calls](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#calls)
66
+ - 接通 [accept](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#accept)
67
+ - 拒绝 [reject](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#reject)
68
+ - 挂断 [hangup](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#hangup)
69
+ - 打开摄像头 [openCamera](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#openCamera)
70
+ - 打开麦克风 [openMicrophone](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#openMicrophone)
71
+ - 关闭摄像头 [closeCamera](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#closeCamera)
72
+ - 关闭麦克风 [closeMicrophone](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#closeMicrophone)
73
+ - 播放远端视频 [startRemoteView](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#startRemoteView)
74
+ - 停止播放远端视频 [stopRemoteView](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/zh-cn/TUICallEngine.html#stopRemoteView)
75
+
76
+
77
+ ## 目录结构
78
+ ```
79
+ ├── README-zh_CN.md
80
+ ├── README.md
81
+ ├── index.js // 基于 umd 模块的 sdk 包
82
+ ├── index.esm.js // 基于 esm 模块的 sdk 包
83
+ ├── index.cjs.js // 基于 commonjs 模块的 sdk 包
84
+ ├── index.d.ts // 类型声明文件
85
+ └── package.json
86
+ ```
package/README.md ADDED
@@ -0,0 +1,89 @@
1
+ <p align="center">
2
+ <a href="https://trtc.io/">
3
+ <img width="200" src="https://web.sdk.qcloud.com/trtc/webrtc/assets/trtc.io-logo.png">
4
+ </a>
5
+ </p>
6
+
7
+ <h1 align="center" style="margin-top: -40px">TUICallEngine Web SDK</h1>
8
+
9
+ <div align="center">
10
+
11
+ An object-oriented TUICallEngine SDK library
12
+
13
+ ![NPM verison](https://img.shields.io/npm/v/@trtc/call-engine-lite-js) [![NPM downloads](https://img.shields.io/npm/dw/@trtc/call-engine-lite-js)](https://www.npmjs.com/package/@trtc/call-engine-lite-js) [![Typescript Supported](https://img.shields.io/badge/Typescript-Supported-blue)](https://www.npmjs.com/package/@trtc/call-engine-lite-js) [![Documents](https://img.shields.io/badge/-Documents-blue)](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html) [![Stars](https://img.shields.io/github/stars/tencentyun/TUICallKit?style=social)](https://github.com/tencentyun/TUICallKit)
14
+
15
+ </div>
16
+
17
+ <div align="center"> English | <a href="https://github.com/Tencent-RTC/rtc-call-engine/tree/main/Web/demo-vue3" target="_blank"> 简体中文</a> </div>
18
+
19
+
20
+ ## Introduction
21
+ TUICallEngine Web SDK is based on [Tencent Cloud's IM](https://cloud.tencent.com/document/product/269/42440) and [Tencent Cloud's real-time communication](https://cloud.tencent.com/document/product/647/16788) solution. Supports audio and video calls in two-person and multi-person scenarios.
22
+
23
+ - [Online Demo](https://trtc.io/demo/homepage/#/detail?scene=callkit)
24
+ - [Changelog](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/tutorial-20-CHANGELOG.html)
25
+ - We offer SDKs for Web, Android, iOS, MiniProgram, Flutter, explore more in [trtc.io](https://trtc.io/products/call).
26
+
27
+
28
+ ## Environment Supports
29
+ TUICallEngine Web SDK supports major modern browsers. For details, please refer to [Browsers Supported](https://web.sdk.qcloud.com/trtc/webrtc/v5/doc/en/tutorial-05-info-browser.html).
30
+
31
+ ```text
32
+ Please be sure to use HTTPS protocol or localhost to deploy your Web App, otherwise a navigator.mediaDevices not found error will occur!
33
+ ```
34
+
35
+ | [<img src="https://web.sdk.qcloud.com/trtc/webrtc/assets/logo/chrome_48x48.png" alt="Chrome" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Chrome | [<img src="https://web.sdk.qcloud.com/trtc/webrtc/assets/logo/edge_48x48.png" alt="IE / Edge" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/> Edge | [<img src="https://web.sdk.qcloud.com/trtc/webrtc/assets/logo/firefox_48x48.png" alt="Firefox" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Firefox | [<img src="https://web.sdk.qcloud.com/trtc/webrtc/assets/logo/safari_48x48.png" alt="Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Safari | [<img src="https://web.sdk.qcloud.com/trtc/webrtc/assets/logo/safari-ios_48x48.png" alt="iOS Safari" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>iOS Safari | [<img src="https://web.sdk.qcloud.com/trtc/webrtc/assets/logo/opera_48x48.png" alt="Opera" width="24px" height="24px" />](http://godban.github.io/browsers-support-badges/)<br/>Opera |
36
+ | --------- | --------- | --------- | --------- | --------- | --------- |
37
+ | 56+ | 80+ | 56+ | 11+ | 11+ | 46+ |
38
+
39
+
40
+ ## Install
41
+ npm:
42
+ ```
43
+ $ npm install @trtc/call-engine-lite-js --save
44
+ ```
45
+
46
+ yarn:
47
+ ```
48
+ $ yarn add @trtc/call-engine-lite-js
49
+ ```
50
+
51
+ Download manually：
52
+
53
+ 1. download [@trtc/call-engine-lite-js](https://www.unpkg.com/@trtc/call-engine-lite-js@latest).
54
+ 2. copy `@trtc/call-engine-lite-js` to your project.
55
+
56
+
57
+ ## Usage
58
+ 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.
59
+
60
+ - [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)
61
+
62
+ Explore SDK documents：[TUICallEngine Web SDK](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html)
63
+
64
+
65
+ ## API Overview
66
+ - [TUICallEngine](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html) is the main entry for TUICallEngine SDK, providing APIs such as create tuiCallEngine instance [TUICallEngine.createInstance](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#.createInstance), [tuiCallEngine.login](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#login), start single or group calls [tuiCallEngine.calls](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#calls).
67
+ - [tuiCallEngine](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html) instance, provides the core capability for real-time audio and video calls.
68
+ - Start single or group calls [calls](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#calls)
69
+ - Accept call [accept](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#accept)
70
+ - Reject call [reject](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#reject)
71
+ - Hangup call [hangup](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#hangup)
72
+ - Turn on camera [openCamera](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#openCamera)
73
+ - Turn on microphone [openMicrophone](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#openMicrophone)
74
+ - Turn off camera [closeCamera](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#closeCamera)
75
+ - Turn off microphone [closeMicrophone](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#closeMicrophone)
76
+ - Play remote video [startRemoteView](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#startRemoteView)
77
+ - Stop playing remote video [stopRemoteView](https://web.sdk.qcloud.com/component/trtccalling/doc/TUICallEngine/web/en/TUICallEngine.html#stopRemoteView)
78
+
79
+
80
+ ## Directory
81
+ ```
82
+ ├── README-zh_CN.md
83
+ ├── README.md
84
+ ├── index.js // sdk file base on UMD modules
85
+ ├── index.esm.js // sdk file base on ESM modules
86
+ ├── index.cjs.js // sdk file base on CommonJS modules
87
+ ├── index.d.ts // ts declaration file
88
+ └── package.json
89
+ ```