React SDK

React hooks and components wrapping @relaykit/js. All hooks are client-only and marked with 'use client'.

Installation

npm install @relaykit/react

Provider

import { RelayKitProvider } from '@relaykit/react'

function App() {
  return (
    <RelayKitProvider apiKey="rk_live_xxxx" apiUrl="https://api.relaykit.live">
      <YourApp />
    </RelayKitProvider>
  )
}

Hooks

useRelayKit()

Access connect, disconnect, status, and room

useParticipants()

List of all remote participants

useLocalCamera()

isCameraEnabled, toggleCamera

useLocalMic()

isMicEnabled, toggleMic

useParticipantTracks(identity)

Audio and video tracks for a participant