jiuyiUniapp/jiuyi/node_modules/tuicall-engine-webrtc/README-zh_CN.md

TUICallEngine Web SDK

English | 简体中文

简介

TUICallEngine 是基于腾讯云 即时通信 IM 和 实时音视频 TRTC 两项付费 PaaS 服务构建出的音视频通信 SDK，支持双人和多人场景下的音视频通话。

• 在线 Demo
• 更新日志
• 我们提供适用于 Web、Android、iOS、小程序、Flutter 的 SDK，更多信息请参见 trtc.io。

环境支持

TUICallEngine Web SDK 支持市面上主流浏览器，详情参考：浏览器支持情况。

请务必使用 HTTPS 协议或者 localhost 来部署您的 Web App，否则会出现找不到 navigator.mediaDevices 错误！

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

安装

使用 npm:

$ npm install tuicall-engine-webrtc --save

使用 yarn:

$ yarn add tuicall-engine-webrtc

手动下载 sdk 包：

1. 下载 tuicall-engine-webrtc.js。
2. 将 tuicall-engine-webrtc.js 复制到你的项目中。

使用

参考下述两个教程，可快速跑通 Demo 及了解如何使用 SDK 实现基础音视频通话功能。

• 实现双人通话
• TUICallEngine Github Demo

TUICallEngine API 文档详见：TUICallEngine Web SDK。

API 概要

• TUICallEngine 是整个 SDK 的主入口，提供创建 tuiCallEngine 对象 TUICallEngine.createInstance。登录 tuiCallEngine.login。发起 1v1 通话 tuiCallEngine.call。发起群组通话 tuiCallEngine.groupCall。
• tuiCallEngine 对象，提供实时音视频通话的核心能力。
  • 开始 1v1 通话 call
  • 接通 accept
  • 拒绝 reject
  • 挂断 hangup
  • 打开摄像头 openCamera
  • 打开麦克风 openMicrophone
  • 关闭摄像头 closeCamera
  • 关闭麦克风 closeMicrophone
  • 播放远端视频 startRemoteView
  • 停止播放远端视频 stopRemoteView

目录结构

├── README-zh_CN.md
├── README.md
├── index.d.ts // 类型声明文件
├── package.json
└── tuicall-engine-webrtc.js // 基于 es 模块的 sdk 包