GitHub

Source

useRemoteParticipant

The useRemoteParticipant hook returns the first RemoteParticipant by either identity or based on the participant kind.

Import

import { useRemoteParticipant } from "@livekit/components-react";

Remarks

To optimize performance, you can use the updateOnlyOn property to decide on what ParticipantEvents the hook updates.

Usage

const participant = useRemoteParticipant("Russ");

Properties

identitystring
options?UseRemoteParticipantOptions

Returns

RemoteParticipant | undefined;