LiveKit LogoDocs
Real-timeEgress/IngressCloudReference

useTrackToggle

Import

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

Parameters

#
{ source, onChange, initialState, captureOptions, ...rest }UseTrackToggleProps<T>

Returns

{
toggle: ((forceState?: boolean | undefined) => void) | ((forceState?: boolean | undefined, captureOptions?: import("@livekit/components-core").CaptureOptionsBySource<T> | undefined) => Promise<void>);
enabled: boolean;
pending: boolean;
track: import("livekit-client").LocalTrackPublication | undefined;
buttonProps: React.ButtonHTMLAttributes<HTMLButtonElement>;
}

On this page

ImportParametersReturns

Previous

Chevron IconuseTracks
LiveKit Logo

Product

SFU

SDKs

Cloud Dashboard

Cloud Status

GitHub Logo