Docs
Get started

Installation

Install the browser, React and Node packages.

Packages

PackageRuns inPurpose
@relayrtc/reactBrowserReact providers, hooks and media loading UI.
@relayrtc/clientBrowserRoom connection, capture, subscriptions and events. React depends on this package.
@relayrtc/nodeNode.js serverREST management and webhook verification.

React

Use React 18.3.1 or React 19 and TypeScript if you want typed options.

Shell
pnpm add @relayrtc/react @relayrtc/client
React
import { RelayProvider, RelayRoom, useRoom } from '@relayrtc/react'

Node.js

Use Node.js 22 or newer.

Shell
pnpm add @relayrtc/node
TypeScript
import { RelayServer, verifyWebhookRequest } from '@relayrtc/node'

Plain browser client

Use this package when you want to manage the room without React.

Shell
pnpm add @relayrtc/client
TypeScript
import { RelayClient } from '@relayrtc/client'