TrackToggle

With the TrackToggle component it is possible to mute and unmute your camera and microphone. The component uses an html button element under the hood so you can treat it like a button.

Import

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

Usage

<LiveKitRoom>
  <TrackToggle source={Track.Source.Microphone} />
  <TrackToggle source={Track.Source.Camera} />
</LiveKitRoom>

Properties

sourceTRequired

captureOptionsCaptureOptionsBySource<T>Optional

(Optional)

initialStatebooleanOptional

(Optional)

onChange(enabled: boolean, isUserInitiated: boolean) => voidOptional

(Optional) Function that is called when the enabled state of the toggle changes. The second function argument isUserInitiated is true if the change was initiated by a user interaction, such as a click.

onDeviceError(error: Error) => voidOptional

(Optional)

publishOptionsTrackPublishOptionsOptional

(Optional)

showIconbooleanOptional

(Optional)