Function: usePeers()

usePeers<PeerMetadata, ServerMetadata>(): object

Defined in: packages/react-client/src/hooks/usePeers.ts:60

Hook allows to access id, tracks and metadata of the local and remote peers.

Type Parameters

Type Parameter	Default type	Description
PeerMetadata	Record<string, unknown>	Type of metadata set by peer while connecting to a room.
ServerMetadata	Record<string, unknown>	Type of metadata set by the server while creating a peer.

Returns

object

localPeer

localPeer: null | PeerWithTracks<PeerMetadata, ServerMetadata>

The local peer with distinguished tracks (camera, microphone, screen share). Will be null if the local peer is not found.

peers

peers: PeerWithTracks<PeerMetadata, ServerMetadata>[] = remotePeers

Deprecated

Use remotePeers instead Legacy array containing remote peers. This property will be removed in future versions.

remotePeers

remotePeers: PeerWithTracks<PeerMetadata, ServerMetadata>[]

Array of remote peers with distinguished tracks (camera, microphone, screen share).