Function usePeers

usePeers<
    PeerMetadata = Record<string, unknown>,
    ServerMetadata = Record<string, unknown>,
>(): {
    localPeer: null | PeerWithTracks<PeerMetadata, ServerMetadata>;
    peers: PeerWithTracks<PeerMetadata, ServerMetadata>[];
    remotePeers: PeerWithTracks<PeerMetadata, ServerMetadata>[];
}
Hook allows to access id, tracks and metadata of the local and remote peers.
Type Parameters
- 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 {
    localPeer: null | PeerWithTracks<PeerMetadata, ServerMetadata>;
    peers: PeerWithTracks<PeerMetadata, ServerMetadata>[];
    remotePeers: PeerWithTracks<PeerMetadata, ServerMetadata>[];
}
- 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: PeerWithTracks<PeerMetadata, ServerMetadata>[]
  Deprecated
  Use remotePeers instead Legacy array containing remote peers. This property will be removed in future versions.
- remotePeers: PeerWithTracks<PeerMetadata, ServerMetadata>[]
  Array of remote peers with distinguished tracks (camera, microphone, screen share).
- Defined in packages/react-client/src/hooks/usePeers.ts:60