RelayrtcDocs
Get started
Documentation
Developer documentation

Get started
with RelayRTC

Add audio, video, screen sharing and messaging to your application.

React
import { RelayProvider, RelayRoom } from '@relayrtc/react'
 
export function Call({ token, signalingUrl, children }) {
  return (
    <RelayProvider signalingUrl={signalingUrl}>
      <RelayRoom token={token}>
        {children}
      </RelayRoom>
    </RelayProvider>
  )
}

Choose your starting point

Use installation to choose your SDKs. To run the services yourself, start with self-hosting.

Your first room

Your backend creates a room and issues one participant token per caller. Each browser joins with its token, then enables devices and receives the other participants' media.

The first-call guide covers that complete flow, including capture controls, local preview, remote video/audio and blocked autoplay.

Build calls

Live streaming

Streaming guides cover ROOM, WHIP and RTMP sources, broadcast runs, private playback, recordings, clips, DVR and composition. Follow each feature's package and deployment requirements; current source interfaces can be newer than the published SDK baseline.

Integrate your backend

Use webhooks to receive signed resource events and usage reports to inspect participant time and service traffic. Keep management keys on your server and authorize application users before issuing room tokens or playback grants.

Self-hosting

The deployment guide covers the service topology and configuration. For connection or playback problems, start with troubleshooting calls.