LiveKit LogoDocs
Real-timeEgress/IngressCloudReference

useLocalParticipant

The useLocalParticipant hook the state of the local participant.

Import

import { useLocalParticipant } from '@livekit/components-react';

Parameters

#
options?UseLocalParticipantOptions

Returns

{
isMicrophoneEnabled: boolean;
isScreenShareEnabled: boolean;
isCameraEnabled: boolean;
microphoneTrack: TrackPublication | undefined;
cameraTrack: TrackPublication | undefined;
lastMicrophoneError: Error | undefined;
lastCameraError: Error | undefined;
localParticipant: LocalParticipant;
}

On this page

ImportParametersReturns

Previous

Chevron IconuseLiveKitRoom
LiveKit Logo

Product

SFU

SDKs

Cloud Dashboard

Cloud Status

GitHub Logo