jiuyiUniapp/jiuyi/node_modules/trtc-sdk-v5/README-zh_CN.md

TRTC Web SDK

一款面向对象的 WebRTC SDK。

简体中文 | English

简介

TRTC Web SDK 是腾讯云实时音视频通讯解决方案的 Web 端 SDK，它是通过 HTML 网页加载的 JavaScript 库。Web 开发者可以使用 TRTC Web SDK 提供的 API，在您的业务网站上实现实时音视频通话、直播等功能。

• 在线 Demo

环境支持

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

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

安装

使用 npm:

$ npm install trtc-sdk-v5 --save

使用 yarn:

$ yarn add trtc-sdk-v5

手动下载 sdk 包：

1. 下载 trtc.js
2. 将 trtc.js 复制到您的项目中。

使用

通过 import 引入或者 script 引入

import TRTC from 'trtc-sdk-v5';
// or
<script src="trtc.js"></script>

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

• 快速跑通 Demo
• 基础音视频通话

API 概要

• TRTC 是整个 SDK 的主入口，提供创建 TRTC 对象 TRTC、获取摄像头列表、麦克风列表、检查浏览器兼容性、控制日志等级及日志上传等功能。
• TRTC TRTC对象，提供实时音视频通话的核心能力:
  • 进房 enterRoom
  • 退房 exitRoom
  • 发布/预览本地视频 startLocalVideo
  • 发布/预览本地音频 startLocalAudio
  • 取消发布/预览本地视频 stopLocalVideo
  • 取消发布/预览本地音频 stopLocalAudio
  • 观看远端视频 startRemoteVideo
  • 取消观看视频 stopRemoteVideo
  • 静音/取消静音远端音频 muteRemoteAudio

目录结构

├── README.md
├── package.json
├── trtc.js // npm 包入口文件（umd 格式）
├── trtc.esm.js // 基于 es 模块的 sdk 包（esm 格式）
├── index.d.ts // 类型声明文件
└── plugins // 插件目录

Changelog

• 变更日志