Table of Contents

• About the Project
  • Built With
• Installation
• Usage
• About

About The Project

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

Built With

• Cloudflare
• Typescript

Installation

npm install @cloudflare/realtimekit-react

Usage

A meeting object can be created using the useRealtimeKitClient hook.

const [meeting, initMeeting] = useRealtimeKitClient();
useEffect(() => {
  await initMeeting({
    authToken: "<AuthTokenHere>",
    defaults: {
        audio: false,
        video: false,
    }
  });
}, []);

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.