useParticipants

Import

import { useParticipants } from '@relayrtc/react'

Requirements

Call this hook inside RelayProvider, in a React function component or custom hook. A joined room is needed for live data and actions.

Returns

Example

const participants = useParticipants({ includeLocal: false })
 
return participants.map((person) => (
  <p key={person.id}>{person.name}</p>
))

Options and behavior

includeLocal defaults to true. With false, only remote participants are returned. Remote participants also expose a tracks map. The list is empty before joining.