@livekit/components-js-docs 0.0.0-20251021151641

package/generated-docs/core/recordingstatusobservable.md

@@ -0,0 +1,16 @@
+---
+{
+  "title": "recordingStatusObservable",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/room.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# recordingStatusObservable
+
+**Signature:**
+
+```typescript
+export declare function recordingStatusObservable(room: Room): Observable<boolean>;
+```

package/generated-docs/core/requireonlyone.md

@@ -0,0 +1,19 @@
+---
+{
+  "title": "RequireOnlyOne type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/types.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# RequireOnlyOne type
+
+**Signature:**
+
+```typescript
+export type RequireOnlyOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> &
+  {
+    [K in Keys]-?: Required<Pick<T, K>> & Partial<Record<Exclude<Keys, K>, undefined>>;
+  }[Keys];
+```

package/generated-docs/core/roomaudioplaybackallowedobservable.md

@@ -0,0 +1,18 @@
+---
+{
+  "title": "roomAudioPlaybackAllowedObservable",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/room.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# roomAudioPlaybackAllowedObservable
+
+**Signature:**
+
+```typescript
+export declare function roomAudioPlaybackAllowedObservable(room: Room): Observable<{
+  canPlayAudio: boolean;
+}>;
+```

package/generated-docs/core/roomeventselector.md

@@ -0,0 +1,19 @@
+---
+{
+  "title": "roomEventSelector",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/room.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# roomEventSelector
+
+**Signature:**
+
+```typescript
+export declare function roomEventSelector<T extends RoomEvent>(
+  room: Room,
+  event: T
+): Observable<Parameters<RoomEventCallbacks[T]>>;
+```

package/generated-docs/core/roominfoobserver.md

@@ -0,0 +1,19 @@
+---
+{
+  "title": "roomInfoObserver",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/room.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# roomInfoObserver
+
+**Signature:**
+
+```typescript
+export declare function roomInfoObserver(room: Room): Observable<{
+  name: string;
+  metadata: string | undefined;
+}>;
+```

package/generated-docs/core/roomobserver.md

@@ -0,0 +1,16 @@
+---
+{
+  "title": "roomObserver",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/room.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# roomObserver
+
+**Signature:**
+
+```typescript
+export declare function roomObserver(room: Room): Observable<Room>;
+```

package/generated-docs/core/roomvideoplaybackallowedobservable.md

@@ -0,0 +1,18 @@
+---
+{
+  "title": "roomVideoPlaybackAllowedObservable",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/room.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# roomVideoPlaybackAllowedObservable
+
+**Signature:**
+
+```typescript
+export declare function roomVideoPlaybackAllowedObservable(room: Room): Observable<{
+  canPlayVideo: boolean;
+}>;
+```

package/generated-docs/core/saveuserchoices.md

@@ -0,0 +1,24 @@
+---
+{
+  "title": "saveUserChoices",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/persistent-storage/user-choices.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# saveUserChoices
+
+{% callout type="note" variation="normal" %}
+
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+
+{% /callout %}
+
+Saves user choices to local storage.
+
+**Signature:**
+
+```typescript
+export declare function saveUserChoices(userChoices: LocalUserChoices, preventSave?: boolean): void;
+```

package/generated-docs/core/screenshareobserver.md

@@ -0,0 +1,16 @@
+---
+{
+  "title": "screenShareObserver",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/room.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# screenShareObserver
+
+**Signature:**
+
+```typescript
+export declare function screenShareObserver(room: Room): Observable<ScreenShareTrackMap>;
+```

package/generated-docs/core/screensharetrackmap.md

@@ -0,0 +1,19 @@
+---
+{
+  "title": "ScreenShareTrackMap type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/room.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# ScreenShareTrackMap type
+
+**Signature:**
+
+```typescript
+export type ScreenShareTrackMap = Array<{
+  participant: Participant;
+  tracks: Array<TrackPublication>;
+}>;
+```

package/generated-docs/core/selectgridlayout.md

@@ -0,0 +1,21 @@
+---
+{
+  "title": "selectGridLayout",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/grid-layouts.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# selectGridLayout
+
+**Signature:**
+
+```typescript
+export declare function selectGridLayout(
+  layoutDefinitions: GridLayoutDefinition[],
+  participantCount: number,
+  width: number,
+  height: number
+): GridLayoutInfo;
+```

package/generated-docs/core/sendmessage.md

@@ -0,0 +1,22 @@
+---
+{
+  "title": "sendMessage",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/dataChannel.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# sendMessage
+
+Publish data from the LocalParticipant.
+
+**Signature:**
+
+```typescript
+export declare function sendMessage(
+  localParticipant: LocalParticipant,
+  payload: Uint8Array,
+  options?: DataPublishOptions
+): Promise<void>;
+```

package/generated-docs/core/setdifference.md

@@ -0,0 +1,16 @@
+---
+{
+  "title": "setDifference",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/set-helper.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setDifference
+
+**Signature:**
+
+```typescript
+export declare function setDifference<T>(setA: Set<T>, setB: Set<T>): Set<T>;
+```

package/generated-docs/core/setlogextension.md

@@ -0,0 +1,21 @@
+---
+{
+  "title": "setLogExtension",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/logger.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setLogExtension
+
+Set the log extension for both the `@livekit/components-react` package and the `@livekit-client` package. To set the `@livekit-client` log extension, use the `liveKitClientLogExtension` prop on the `options` object.
+
+**Signature:**
+
+```typescript
+export declare function setLogExtension(
+  extension: LogExtension,
+  options?: SetLogExtensionOptions
+): void;
+```

package/generated-docs/core/setloglevel.md

@@ -0,0 +1,18 @@
+---
+{
+  "title": "setLogLevel",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/logger.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setLogLevel
+
+Set the log level for both the `@livekit/components-react` package and the `@livekit-client` package. To set the `@livekit-client` log independently, use the `liveKitClientLogLevel` prop on the `options` object.
+
+**Signature:**
+
+```typescript
+export declare function setLogLevel(level: LogLevel, options?: SetLogLevelOptions): void;
+```

package/generated-docs/core/setmediadeviceoptions.md

@@ -0,0 +1,18 @@
+---
+{
+  "title": "SetMediaDeviceOptions type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/mediaDeviceSelect.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# SetMediaDeviceOptions type
+
+**Signature:**
+
+```typescript
+export type SetMediaDeviceOptions = {
+  exact?: boolean;
+};
+```

package/generated-docs/core/setupchat.md

@@ -0,0 +1,23 @@
+---
+{
+  "title": "setupChat",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/chat.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupChat
+
+**Signature:**
+
+```typescript
+export declare function setupChat(
+  room: Room,
+  options?: ChatOptions
+): {
+  messageObservable: import("rxjs").Observable<ReceivedChatMessage[]>;
+  isSendingObservable: BehaviorSubject<boolean>;
+  send: (message: string, options?: SendTextOptions) => Promise<ReceivedChatMessage>;
+};
+```

package/generated-docs/core/setupchatmessagehandler.md

@@ -0,0 +1,34 @@
+---
+{
+  "title": "setupChatMessageHandler",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/dataChannel.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupChatMessageHandler
+
+**Signature:**
+
+```typescript
+export declare function setupChatMessageHandler(room: Room): {
+  chatObservable: Observable<
+    [
+      message: ChatMessage,
+      participant?: LocalParticipant | import("livekit-client").RemoteParticipant | undefined
+    ]
+  >;
+  send: (text: string, options: SendTextOptions) => Promise<ReceivedChatMessage>;
+  edit: (
+    text: string,
+    originalMsg: ChatMessage
+  ) => Promise<{
+    readonly message: string;
+    readonly editTimestamp: number;
+    readonly id: string;
+    readonly timestamp: number;
+    readonly attachedFiles?: Array<File>;
+  }>;
+};
+```

package/generated-docs/core/setupchattoggle.md

@@ -0,0 +1,18 @@
+---
+{
+  "title": "setupChatToggle",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/chatToggle.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupChatToggle
+
+**Signature:**
+
+```typescript
+export declare function setupChatToggle(): {
+  className: string;
+};
+```

package/generated-docs/core/setupclearpinbutton.md

@@ -0,0 +1,18 @@
+---
+{
+  "title": "setupClearPinButton",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/clearPinButton.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupClearPinButton
+
+**Signature:**
+
+```typescript
+export declare function setupClearPinButton(): {
+  className: string;
+};
+```

package/generated-docs/core/setupconnectionqualityindicator.md

@@ -0,0 +1,19 @@
+---
+{
+  "title": "setupConnectionQualityIndicator",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/connectionQualityIndicator.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupConnectionQualityIndicator
+
+**Signature:**
+
+```typescript
+export declare function setupConnectionQualityIndicator(participant: Participant): {
+  className: "lk-connection-quality";
+  connectionQualityObserver: import("rxjs").Observable<import("livekit-client").ConnectionQuality>;
+};
+```

package/generated-docs/core/setupdatamessagehandler.md

@@ -0,0 +1,28 @@
+---
+{
+  "title": "setupDataMessageHandler",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/dataChannel.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupDataMessageHandler
+
+**Signature:**
+
+```typescript
+export declare function setupDataMessageHandler<T extends string>(
+  room: Room,
+  topic?: T | [T, ...T[]],
+  onMessage?: (msg: ReceivedDataMessage<T>) => void
+): {
+  messageObservable: Observable<{
+    payload: Uint8Array<ArrayBufferLike>;
+    topic: T;
+    from: import("livekit-client").RemoteParticipant | undefined;
+  }>;
+  isSendingObservable: Observable<boolean>;
+  send: (payload: Uint8Array, options?: DataPublishOptions) => Promise<void>;
+};
+```

package/generated-docs/core/setupdeviceselector.md

@@ -0,0 +1,24 @@
+---
+{
+  "title": "setupDeviceSelector",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/mediaDeviceSelect.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupDeviceSelector
+
+**Signature:**
+
+```typescript
+export declare function setupDeviceSelector(
+  kind: MediaDeviceKind,
+  room: Room,
+  localTrack?: LocalAudioTrack | LocalVideoTrack
+): {
+  className: string;
+  activeDeviceObservable: import("rxjs").Observable<string>;
+  setActiveMediaDevice: (id: string, options?: SetMediaDeviceOptions) => Promise<void>;
+};
+```

package/generated-docs/core/setupdisconnectbutton.md

@@ -0,0 +1,19 @@
+---
+{
+  "title": "setupDisconnectButton",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/disconnectButton.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupDisconnectButton
+
+**Signature:**
+
+```typescript
+export declare function setupDisconnectButton(room: Room): {
+  className: string;
+  disconnect: (stopTracks?: boolean) => void;
+};
+```

package/generated-docs/core/setupfocustoggle.md

@@ -0,0 +1,18 @@
+---
+{
+  "title": "setupFocusToggle",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/focusToggle.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupFocusToggle
+
+**Signature:**
+
+```typescript
+export declare function setupFocusToggle(): {
+  className: string;
+};
+```

package/generated-docs/core/setuplivekitroom.md

@@ -0,0 +1,18 @@
+---
+{
+  "title": "setupLiveKitRoom",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/room.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupLiveKitRoom
+
+**Signature:**
+
+```typescript
+export declare function setupLiveKitRoom(): {
+  className: string;
+};
+```

package/generated-docs/core/setupmanualtoggle.md

@@ -0,0 +1,21 @@
+---
+{
+  "title": "setupManualToggle",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/mediaToggle.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupManualToggle
+
+**Signature:**
+
+```typescript
+export declare function setupManualToggle(): {
+  className: string;
+  toggle: (forceState?: boolean) => Promise<void>;
+  enabledObserver: Observable<boolean>;
+  pendingObserver: Observable<boolean>;
+};
+```

package/generated-docs/core/setupmediatoggle.md

@@ -0,0 +1,22 @@
+---
+{
+  "title": "setupMediaToggle",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/mediaToggle.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupMediaToggle
+
+**Signature:**
+
+```typescript
+export declare function setupMediaToggle<T extends ToggleSource>(
+  source: T,
+  room: Room,
+  options?: CaptureOptionsBySource<T>,
+  publishOptions?: TrackPublishOptions,
+  onError?: (error: Error) => void
+): MediaToggleType<T>;
+```

package/generated-docs/core/setupmediatrack.md

@@ -0,0 +1,19 @@
+---
+{
+  "title": "setupMediaTrack",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/mediaTrack.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupMediaTrack
+
+**Signature:**
+
+```typescript
+export declare function setupMediaTrack(trackIdentifier: TrackIdentifier): {
+  className: string;
+  trackObserver: import("rxjs").Observable<import("livekit-client").TrackPublication | undefined>;
+};
+```

package/generated-docs/core/setupparticipantname.md

@@ -0,0 +1,32 @@
+---
+{
+  "title": "setupParticipantName",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/participantName.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupParticipantName
+
+**Signature:**
+
+```typescript
+export declare function setupParticipantName(participant: Participant): {
+  className: string;
+  infoObserver:
+    | import("rxjs").Observable<
+        | {
+            name: string | undefined;
+            identity: string;
+            metadata: string | undefined;
+          }
+        | {
+            name: string | undefined;
+            identity: string;
+            metadata: string | undefined;
+          }
+      >
+    | undefined;
+};
+```

package/generated-docs/core/setupparticipanttile.md

@@ -0,0 +1,18 @@
+---
+{
+  "title": "setupParticipantTile",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/participantTile.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupParticipantTile
+
+**Signature:**
+
+```typescript
+export declare function setupParticipantTile(): {
+  className: string;
+};
+```