RelayRoom | RelayRTC Docs

Import

import { RelayRoom } from '@relayrtc/react'

Requirements

Render inside RelayProvider. Only one RelayRoom owns a provider at a time.

Props

Prop	Type	Default	Purpose
token	string, null or undefined	Required prop	Token issued by your backend. Null/undefined waits without joining.
connect	boolean	true	Enable the automatic join.
children	ReactNode	Optional	Room UI; rendered while connecting too.
onConnected	`(room: Room) => void`	Optional	Called when a new room becomes available.
onDisconnected	`() => void`	Optional	Called when the previously available room is removed.
onError	`(error: RoomError) => void`	Optional	Observe room errors.

Example

<RelayRoom
  token={participantToken}
  onConnected={(room) => console.log('Joined', room.id)}
  onDisconnected={() => console.log('Left')}
>
  <YourCall />
</RelayRoom>

Token changes

Changing the token starts a new join lifecycle. Unmounting cancels an in-flight join and releases room ownership.

Joining does not enable local capture. Call camera or microphone controls after the room is connected.