MediaDeviceMenu

The MediaDeviceMenu component is a button that opens a menu that lists all media devices and allows the user to select them.

Import

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

Remarks

This component is implemented with the MediaDeviceSelect LiveKit components.

Usage

<LiveKitRoom>
  <MediaDeviceMenu />
</LiveKitRoom>

Properties

initialSelectionstringOptional

(Optional)

kindMediaDeviceKindOptional

(Optional)

onActiveDeviceChange(kind: MediaDeviceKind, deviceId: string) => voidOptional

(Optional)

requestPermissionsbooleanOptional

(Optional) this will call getUserMedia if the permissions are not yet given to enumerate the devices with device labels. in some browsers multiple calls to getUserMedia result in multiple permission prompts. It's generally advised only flip this to true, once a (preview) track has been acquired successfully with the appropriate permissions.

tracksPartial<Record<MediaDeviceKind, LocalAudioTrack | LocalVideoTrack | undefined>>Optional

(Optional)