@cloudflare/realtimekit
TypeScript icon, indicating that this package has built-in type declarations

0.1.0 • Public • Published

Logo

RealtimeKit

A real-time video and audio SDK for building custom, collaborative communication experiences.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

About The Project

A real-time video and audio SDK for building custom, collaborative communication experiences.

Built With

Installation

npm install @cloudflare/realtimekit

Usage

A meeting object can be created using the RealtimeKit.init() method.

const meeting = await RealtimeKit.init({
    authToken: "<AuthTokenHere>",
    defaults: {
        audio: false,
        video: false,
    }
});

For React you can use the hooks wrapper package @cloudflare/realtimekit-react

The meeting object is used for all interaction with Cloudflare's servers. For example, the following code snippet is used for a user to join a room.

await meeting.join();

For more examples, please refer to the Documentation.

About

@cloudflare/realtimekit is created & maintained by Cloudflare, Inc.

The names and logos are trademarks of Cloudflare, Inc.

Readme

Keywords

none

Package Sidebar

Install

npm i @cloudflare/realtimekit

Weekly Downloads

1,806

Version

0.1.0

License

none

Unpacked Size

3.52 MB

Total Files

16

Last publish

Collaborators

  • rexscaria
  • dcruz_cf
  • xuranwang
  • jculvey
  • sejoker
  • vasturiano
  • pcostanzo
  • cf-radar
  • cf-ci-write
  • segments-write
  • thibmeu
  • xortive
  • gurjinder
  • cf-ci2
  • lvalenta
  • worenga
  • chiminator
  • third774
  • jasnell
  • terinjokes
  • celso
  • jsteinberger
  • geelen
  • gregbrimble
  • asapzacy
  • marksteyn
  • g4brym
  • wrangler-publisher
  • snigdha34
  • sgoodhew_cf
  • cf-media-manager
  • dash_service_account
  • lbarthonet
  • jacobbednarz
  • lerwincf
  • simonabadoiu
  • cms1919