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](#about-the-project)
* [Built With](#built-with)
* [Installation](#installation)
* [Usage](#usage)
* [About](#about)
## About The Project
A real-time video and audio SDK for building custom, collaborative communication experiences.
### Built With
* [Cloudflare](https://cloudflare.com)
* [Typescript](https://typescriptlang.org)
## Installation
```sh
npm install @cloudflare/realtimekit
```
## Usage
A `meeting` object can be created using the `RealtimeKitClient.init()` method.
```ts
const meeting = await RealtimeKit.init({
authToken: "",
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.
```ts
await meeting.join();
```
_For more examples, please refer to the [documentation](https://developers.cloudflare.com/realtime/realtimekit/)._
## About
`@cloudflare/realtimekit` is created & maintained by Cloudflare, Inc.
The names and logos are trademarks of Cloudflare, Inc.