Needful Program Management

    trtc-js-sdk
    TypeScript icon, indicating that this package has built-in type declarations

    4.15.0 • Public • Published

    TRTC Web SDK

    An object-oriented WebRTC SDK library

    NPM version NPM downloads trtc.js Typescript Supported Documents Stars

    English | 简体中文

    Introduction

    TRTC Web SDK is an object-oriented WebRTC SDK of Tencent Cloud's real-time communication solution. Web developers can use TRTC Web SDK to establish an audio/video calls or live streaming services on your website.

    Environment Supports

    TRTC Web SDK supports major modern browsers. For details, please refer to Browsers Supported.

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

    Install

    npm:

    $ npm install trtc-js-sdk --save
    

    yarn:

    $ yarn add trtc-js-sdk
    

    Download manually:

    1. download webrtc_latest.zip.
    2. copy base-js/js/trtc.js 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.

    Explore SDK documents:TRTC Web SDK

    API Overview

    • TRTC is the main entry to the entire TRTC SDK. You can use TRTC APIs to create a client object (Client) and local stream object (LocalStream), check a browser's compatibility, set log levels, and upload logs.
    • A client object Client provides the core TRTC call capabilities, including entering a room join(), leaving a room leave(), publishing a local stream publish(), unpublishing a local stream unpublish(), subscribing to a remote stream subscribe(), and unsubscribing from a remote stream unsubscribe().
    • Audio/video objects Stream include local stream LocalStream and remote stream RemoteStream objects. The APIs in Stream are general APIs for the local and remote streams.

    Directory

    ├── README.md
    ├── package.json
    ├── trtc.js // sdk file
    ├── trtc.esm.js // sdk file base on ES modules(support v4.11.7+)
    ├── trtc.umd.js // sdk file base on UMD modules(support v4.11.7+)
    └── index.d.ts // ts declaration file(support v4.11.12+)
    

    Difference between sdk files

    trtc.js

    Default entry file, base on UMD modules, ES6 included.

    Usage:

    • import TRTC from 'trtc-js-sdk'
    • or <script src="[path]/trtc.js"></scirpt>

    trtc.esm.js

    ES6 included, base on ES Modules. Smaller file size, not usable by browsers that do not support ES6. Refer to: Compatibility of ES6.

    support v4.11.7+

    Usage:

    • import TRTC from 'trtc-js-sdk/trtc.esm.js'

    trtc.umd.js

    ES5 included(without ES6 syntax). Larger file size, but better compatibility.

    support v4.11.7+

    Usage:

    • import TRTC from 'trtc-js-sdk/trtc.umd.js'
    • or <script src="[path]/trtc.umd.js"></scirpt>

    Changelog

    Install

    npm i trtc-js-sdk

    DownloadsWeekly Downloads

    1,350

    Version

    4.15.0

    License

    ISC

    Unpacked Size

    2.26 MB

    Total Files

    8

    Last publish

    Collaborators

    • anderlu
    • rychouwei
    • rgzhao
    • langhuihui
    • dawnrking
    • raingxm
    • jiushu530
    • tencent-cloud-rtc