Needlessly Provoking Marsupials

    trtc-js-sdk
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/trtc-js-sdk package

    4.11.7 • Public • Published

    TRTC Web SDK

    简介

    TRTC Web SDK 是腾讯云实时音视频通讯解决方案的 Web 端 SDK,它是通过 HTML 网页加载的 JavaScript 库。开发者可以使用 TRTC Web SDK 提供的 API 建立连接,控制实时音视频通话或者直播服务。

    TRTC Web SDK 支持市面上主流浏览器,详情参考:浏览器支持情况

    安装

    使用 npm:

    $ npm install trtc-js-sdk --save
    

    使用 yarn:

    $ yarn add trtc-js-sdk
    

    手动下载 sdk 包:

    1. 下载 webrtc_latest.zip
    2. base-js/js/trtc.js 复制到您的项目中。

    使用

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

    API 概要

    详细 API 文档可参考:TRTC Web SDK API 文档

    • TRTC 是整个 SDK 的主入口,提供创建客户端对象 Client 和创建本地流对象 LocalStream 的方法,以及浏览器兼容性检测,日志等级及日志上传控制。
    • Client 客户端对象,提供实时音视频通话的核心能力,包括进房 join() 及退房 leave(),发布本地流 publish() 及停止发布本地流 unpublish(),订阅远端流 subscribe() 及取消订阅远端流 unsubscribe()
    • Stream 音视频流对象,包括本地流 LocalStream 和远端流 RemoteStream 对象。Stream 对象中的方法为本地流及远端流通用方法。

    目录结构

    ├── README.md
    ├── package.json
    ├── trtc.js // npm 包入口文件
    ├── trtc.esm.js // 基于 es 模块的 sdk 包(自 4.11.7+ 版本支持)
    └── trtc.umd.js // 基于 umd 模块的 sdk 包(自 4.11.7+ 版本支持)
    

    模块说明

    trtc.js

    npm 包入口文件,umd 模块类型,包含 ES6 语法,以及所有依赖包。使用方法:

    • 在项目工程安装包后,通过 import TRTC from 'trtc-js-sdk'; 引入该文件。
    • 也可以通过 <script src="[完整路径]/trtc.js"></scirpt> 加载使用。

    trtc.esm.js

    ES Modules 类型,包含 ES6 语法,以及所有依赖包。体积小,不支持 ES6 的浏览器无法使用。可参考 ES6 兼容性

    自 4.11.7+ 版本提供该 sdk 文件。

    使用方法:

    • 在项目工程安装包后,通过 import TRTC from 'trtc-js-sdk/trtc.esm.js'; 引入该文件。

    trtc.umd.js

    umd 模块类型,ES5 语法,体积大,但兼容性更好。

    自 4.11.7+ 版本提供该 sdk 文件。

    使用方法:

    • 在项目工程安装包后,通过 import TRTC from 'trtc-js-sdk/trtc.umd.js'; 引入该文件。
    • 也可以通过 <script src="[完整路径]/trtc.umd.js"></scirpt> 加载使用。

    ChangeLog

    Install

    npm i trtc-js-sdk

    DownloadsWeekly Downloads

    1,569

    Version

    4.11.7

    License

    ISC

    Unpacked Size

    1.32 MB

    Total Files

    5

    Last publish

    Collaborators

    • anderlu
    • trtc