@livekit/components-js-docs 0.0.0-20251021151641

package/generated-docs/react/participantloopprops.md

@@ -0,0 +1,23 @@
+---
+{
+  "title": "ParticipantLoopProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/ParticipantLoop.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# ParticipantLoopProps interface
+
+**Signature:**
+
+```typescript
+export interface ParticipantLoopProps
+```
+
+## Properties
+
+| Property                                                     | Type            | Description                                                                                 |
+| ------------------------------------------------------------ | --------------- | ------------------------------------------------------------------------------------------- |
+| [children](./react/participantloopprops.children.md)         | React.ReactNode | The template component to be used in the loop.                                              |
+| [participants](./react/participantloopprops.participants.md) | Participant\[\] | The participants to loop over. Use <code>useParticipants()</code> hook to get participants. |

package/generated-docs/react/participantloopprops.participants.md

@@ -0,0 +1,15 @@
+---
+{ "title": "ParticipantLoopProps.participants property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# ParticipantLoopProps.participants property
+
+The participants to loop over. Use `useParticipants()` hook to get participants.
+
+**Signature:**
+
+```typescript
+participants: Participant[];
+```

package/generated-docs/react/participantnameprops.md

@@ -0,0 +1,18 @@
+---
+{
+  "title": "ParticipantNameProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/participant/ParticipantName.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# ParticipantNameProps interface
+
+**Signature:**
+
+```typescript
+export interface ParticipantNameProps extends React.HTMLAttributes<HTMLSpanElement>, UseParticipantInfoOptions
+```
+
+**Extends:** React.HTMLAttributes&lt;HTMLSpanElement&gt;, [UseParticipantInfoOptions](./react/useparticipantinfooptions.md)

package/generated-docs/react/participanttileprops.disablespeakingindicator.md

@@ -0,0 +1,13 @@
+---
+{ "title": "ParticipantTileProps.disableSpeakingIndicator property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# ParticipantTileProps.disableSpeakingIndicator property
+
+**Signature:**
+
+```typescript
+disableSpeakingIndicator?: boolean;
+```

package/generated-docs/react/participanttileprops.md

@@ -0,0 +1,26 @@
+---
+{
+  "title": "ParticipantTileProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/participant/ParticipantTile.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# ParticipantTileProps interface
+
+**Signature:**
+
+```typescript
+export interface ParticipantTileProps extends React.HTMLAttributes<HTMLDivElement>
+```
+
+**Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;
+
+## Properties
+
+| Property                                                                              | Type                                      | Description                                  |
+| ------------------------------------------------------------------------------------- | ----------------------------------------- | -------------------------------------------- |
+| [disableSpeakingIndicator?](./react/participanttileprops.disablespeakingindicator.md) | boolean                                   | _(Optional)_                                 |
+| [onParticipantClick?](./react/participanttileprops.onparticipantclick.md)             | (event: ParticipantClickEvent) =&gt; void | _(Optional)_                                 |
+| [trackRef?](./react/participanttileprops.trackref.md)                                 | TrackReferenceOrPlaceholder               | _(Optional)_ The track reference to display. |

package/generated-docs/react/participanttileprops.onparticipantclick.md

@@ -0,0 +1,13 @@
+---
+{ "title": "ParticipantTileProps.onParticipantClick property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# ParticipantTileProps.onParticipantClick property
+
+**Signature:**
+
+```typescript
+onParticipantClick?: (event: ParticipantClickEvent) => void;
+```

package/generated-docs/react/participanttileprops.trackref.md

@@ -0,0 +1,15 @@
+---
+{ "title": "ParticipantTileProps.trackRef property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# ParticipantTileProps.trackRef property
+
+The track reference to display.
+
+**Signature:**
+
+```typescript
+trackRef?: TrackReferenceOrPlaceholder;
+```

package/generated-docs/react/prejoinprops.camlabel.md

@@ -0,0 +1,13 @@
+---
+{ "title": "PreJoinProps.camLabel property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# PreJoinProps.camLabel property
+
+**Signature:**
+
+```typescript
+camLabel?: string;
+```

package/generated-docs/react/prejoinprops.debug.md

@@ -0,0 +1,15 @@
+---
+{ "title": "PreJoinProps.debug property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# PreJoinProps.debug property
+
+Display a debug window for your convenience.
+
+**Signature:**
+
+```typescript
+debug?: boolean;
+```

package/generated-docs/react/prejoinprops.defaults.md

@@ -0,0 +1,15 @@
+---
+{ "title": "PreJoinProps.defaults property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# PreJoinProps.defaults property
+
+Prefill the input form with initial values.
+
+**Signature:**
+
+```typescript
+defaults?: Partial<LocalUserChoices>;
+```

package/generated-docs/react/prejoinprops.joinlabel.md

@@ -0,0 +1,13 @@
+---
+{ "title": "PreJoinProps.joinLabel property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# PreJoinProps.joinLabel property
+
+**Signature:**
+
+```typescript
+joinLabel?: string;
+```

package/generated-docs/react/prejoinprops.md

@@ -0,0 +1,36 @@
+---
+{
+  "title": "PreJoinProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/prefabs/PreJoin.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# PreJoinProps interface
+
+Props for the PreJoin component.
+
+**Signature:**
+
+```typescript
+export interface PreJoinProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'onSubmit' | 'onError'>
+```
+
+**Extends:** Omit&lt;React.HTMLAttributes&lt;HTMLDivElement&gt;, 'onSubmit' \| 'onError'&gt;
+
+## Properties
+
+| Property                                                          | Type                                     | Description                                                                                                                                |
+| ----------------------------------------------------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
+| [camLabel?](./react/prejoinprops.camlabel.md)                     | string                                   | _(Optional)_                                                                                                                               |
+| [debug?](./react/prejoinprops.debug.md)                           | boolean                                  | _(Optional)_ Display a debug window for your convenience.                                                                                  |
+| [defaults?](./react/prejoinprops.defaults.md)                     | Partial&lt;LocalUserChoices&gt;          | _(Optional)_ Prefill the input form with initial values.                                                                                   |
+| [joinLabel?](./react/prejoinprops.joinlabel.md)                   | string                                   | _(Optional)_                                                                                                                               |
+| [micLabel?](./react/prejoinprops.miclabel.md)                     | string                                   | _(Optional)_                                                                                                                               |
+| [onError?](./react/prejoinprops.onerror.md)                       | (error: Error) =&gt; void                | _(Optional)_                                                                                                                               |
+| [onSubmit?](./react/prejoinprops.onsubmit.md)                     | (values: LocalUserChoices) =&gt; void    | _(Optional)_ This function is called with the <code>LocalUserChoices</code> if validation is passed.                                       |
+| [onValidate?](./react/prejoinprops.onvalidate.md)                 | (values: LocalUserChoices) =&gt; boolean | _(Optional)_ Provide your custom validation function. Only if validation is successful the user choices are past to the onSubmit callback. |
+| [persistUserChoices?](./react/prejoinprops.persistuserchoices.md) | boolean                                  | _(Optional)_ If true, user choices are persisted across sessions.                                                                          |
+| [userLabel?](./react/prejoinprops.userlabel.md)                   | string                                   | _(Optional)_                                                                                                                               |
+| [videoProcessor?](./react/prejoinprops.videoprocessor.md)         | TrackProcessor&lt;Track.Kind.Video&gt;   | _(Optional)_                                                                                                                               |

package/generated-docs/react/prejoinprops.miclabel.md

@@ -0,0 +1,13 @@
+---
+{ "title": "PreJoinProps.micLabel property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# PreJoinProps.micLabel property
+
+**Signature:**
+
+```typescript
+micLabel?: string;
+```

package/generated-docs/react/prejoinprops.onerror.md

@@ -0,0 +1,13 @@
+---
+{ "title": "PreJoinProps.onError property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# PreJoinProps.onError property
+
+**Signature:**
+
+```typescript
+onError?: (error: Error) => void;
+```

package/generated-docs/react/prejoinprops.onsubmit.md

@@ -0,0 +1,15 @@
+---
+{ "title": "PreJoinProps.onSubmit property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# PreJoinProps.onSubmit property
+
+This function is called with the `LocalUserChoices` if validation is passed.
+
+**Signature:**
+
+```typescript
+onSubmit?: (values: LocalUserChoices) => void;
+```

package/generated-docs/react/prejoinprops.onvalidate.md

@@ -0,0 +1,15 @@
+---
+{ "title": "PreJoinProps.onValidate property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# PreJoinProps.onValidate property
+
+Provide your custom validation function. Only if validation is successful the user choices are past to the onSubmit callback.
+
+**Signature:**
+
+```typescript
+onValidate?: (values: LocalUserChoices) => boolean;
+```

package/generated-docs/react/prejoinprops.persistuserchoices.md

@@ -0,0 +1,21 @@
+---
+{ "title": "PreJoinProps.persistUserChoices property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# PreJoinProps.persistUserChoices property
+
+{% callout type="note" variation="normal" %}
+
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+
+{% /callout %}
+
+If true, user choices are persisted across sessions.
+
+**Signature:**
+
+```typescript
+persistUserChoices?: boolean;
+```

package/generated-docs/react/prejoinprops.userlabel.md

@@ -0,0 +1,13 @@
+---
+{ "title": "PreJoinProps.userLabel property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# PreJoinProps.userLabel property
+
+**Signature:**
+
+```typescript
+userLabel?: string;
+```

package/generated-docs/react/prejoinprops.videoprocessor.md

@@ -0,0 +1,13 @@
+---
+{ "title": "PreJoinProps.videoProcessor property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# PreJoinProps.videoProcessor property
+
+**Signature:**
+
+```typescript
+videoProcessor?: TrackProcessor<Track.Kind.Video>;
+```

package/generated-docs/react/roomaudiorendererprops.md

@@ -0,0 +1,23 @@
+---
+{
+  "title": "RoomAudioRendererProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/RoomAudioRenderer.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# RoomAudioRendererProps interface
+
+**Signature:**
+
+```typescript
+export interface RoomAudioRendererProps
+```
+
+## Properties
+
+| Property                                            | Type    | Description                                                                                                                                           |
+| --------------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [muted?](./react/roomaudiorendererprops.muted.md)   | boolean | _(Optional)_ If set to <code>true</code>, mutes all audio tracks rendered by the component.                                                           |
+| [volume?](./react/roomaudiorendererprops.volume.md) | number  | _(Optional)_ Sets the volume for all audio tracks rendered by this component. By default, the range is between <code>0.0</code> and <code>1.0</code>. |

package/generated-docs/react/roomaudiorendererprops.muted.md

@@ -0,0 +1,25 @@
+---
+{ "title": "RoomAudioRendererProps.muted property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# RoomAudioRendererProps.muted property
+
+{% callout type="note" variation="normal" %}
+
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+
+{% /callout %}
+
+If set to `true`<!-- -->, mutes all audio tracks rendered by the component.
+
+**Signature:**
+
+```typescript
+muted?: boolean;
+```
+
+## Remarks
+
+If set to `true`<!-- -->, the server will stop sending audio track data to the client.

package/generated-docs/react/roomaudiorendererprops.volume.md

@@ -0,0 +1,15 @@
+---
+{ "title": "RoomAudioRendererProps.volume property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# RoomAudioRendererProps.volume property
+
+Sets the volume for all audio tracks rendered by this component. By default, the range is between `0.0` and `1.0`<!-- -->.
+
+**Signature:**
+
+```typescript
+volume?: number;
+```

package/generated-docs/react/roomnameprops.childrenposition.md

@@ -0,0 +1,13 @@
+---
+{ "title": "RoomNameProps.childrenPosition property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# RoomNameProps.childrenPosition property
+
+**Signature:**
+
+```typescript
+childrenPosition?: 'before' | 'after';
+```

package/generated-docs/react/roomnameprops.md

@@ -0,0 +1,24 @@
+---
+{
+  "title": "RoomNameProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/RoomName.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# RoomNameProps interface
+
+**Signature:**
+
+```typescript
+export interface RoomNameProps extends React.HTMLAttributes<HTMLSpanElement>
+```
+
+**Extends:** React.HTMLAttributes&lt;HTMLSpanElement&gt;
+
+## Properties
+
+| Property                                                       | Type                | Description  |
+| -------------------------------------------------------------- | ------------------- | ------------ |
+| [childrenPosition?](./react/roomnameprops.childrenposition.md) | 'before' \| 'after' | _(Optional)_ |

package/generated-docs/react/trackloopprops.children.md

@@ -0,0 +1,15 @@
+---
+{ "title": "TrackLoopProps.children property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# TrackLoopProps.children property
+
+The template component to be used in the loop.
+
+**Signature:**
+
+```typescript
+children: React.ReactNode;
+```

package/generated-docs/react/trackloopprops.md

@@ -0,0 +1,23 @@
+---
+{
+  "title": "TrackLoopProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/TrackLoop.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# TrackLoopProps interface
+
+**Signature:**
+
+```typescript
+export interface TrackLoopProps
+```
+
+## Properties
+
+| Property                                       | Type                                                  | Description                                                                                          |
+| ---------------------------------------------- | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
+| [children](./react/trackloopprops.children.md) | React.ReactNode                                       | The template component to be used in the loop.                                                       |
+| [tracks](./react/trackloopprops.tracks.md)     | TrackReference\[\] \| TrackReferenceOrPlaceholder\[\] | Track references to loop over. You can the use <code>useTracks()</code> hook to get TrackReferences. |

package/generated-docs/react/trackloopprops.tracks.md

@@ -0,0 +1,15 @@
+---
+{ "title": "TrackLoopProps.tracks property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# TrackLoopProps.tracks property
+
+Track references to loop over. You can the use `useTracks()` hook to get TrackReferences.
+
+**Signature:**
+
+```typescript
+tracks: TrackReference[] | TrackReferenceOrPlaceholder[];
+```

package/generated-docs/react/trackmutedindicatorprops.md

@@ -0,0 +1,25 @@
+---
+{
+  "title": "TrackMutedIndicatorProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/participant/TrackMutedIndicator.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# TrackMutedIndicatorProps interface
+
+**Signature:**
+
+```typescript
+export interface TrackMutedIndicatorProps extends React.HTMLAttributes<HTMLDivElement>
+```
+
+**Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;
+
+## Properties
+
+| Property                                                 | Type                             | Description  |
+| -------------------------------------------------------- | -------------------------------- | ------------ |
+| [show?](./react/trackmutedindicatorprops.show.md)        | 'always' \| 'muted' \| 'unmuted' | _(Optional)_ |
+| [trackRef](./react/trackmutedindicatorprops.trackref.md) | TrackReferenceOrPlaceholder      |              |

package/generated-docs/react/trackmutedindicatorprops.show.md

@@ -0,0 +1,13 @@
+---
+{ "title": "TrackMutedIndicatorProps.show property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# TrackMutedIndicatorProps.show property
+
+**Signature:**
+
+```typescript
+show?: 'always' | 'muted' | 'unmuted';
+```

package/generated-docs/react/trackmutedindicatorprops.trackref.md

@@ -0,0 +1,13 @@
+---
+{ "title": "TrackMutedIndicatorProps.trackRef property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# TrackMutedIndicatorProps.trackRef property
+
+**Signature:**
+
+```typescript
+trackRef: TrackReferenceOrPlaceholder;
+```

package/generated-docs/react/tracktoggleprops.captureoptions.md

@@ -0,0 +1,13 @@
+---
+{ "title": "TrackToggleProps.captureOptions property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# TrackToggleProps.captureOptions property
+
+**Signature:**
+
+```typescript
+captureOptions?: CaptureOptionsBySource<T>;
+```

package/generated-docs/react/tracktoggleprops.initialstate.md

@@ -0,0 +1,13 @@
+---
+{ "title": "TrackToggleProps.initialState property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# TrackToggleProps.initialState property
+
+**Signature:**
+
+```typescript
+initialState?: boolean;
+```

package/generated-docs/react/tracktoggleprops.md

@@ -0,0 +1,30 @@
+---
+{
+  "title": "TrackToggleProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/controls/TrackToggle.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# TrackToggleProps interface
+
+**Signature:**
+
+```typescript
+export interface TrackToggleProps<T extends ToggleSource> extends Omit<React.ButtonHTMLAttributes<HTMLButtonElement>, 'onChange'>
+```
+
+**Extends:** Omit&lt;React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt;, 'onChange'&gt;
+
+## Properties
+
+| Property                                                      | Type                                                    | Description                                                                                                                                                                                                                           |
+| ------------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [captureOptions?](./react/tracktoggleprops.captureoptions.md) | CaptureOptionsBySource&lt;T&gt;                         | _(Optional)_                                                                                                                                                                                                                          |
+| [initialState?](./react/tracktoggleprops.initialstate.md)     | boolean                                                 | _(Optional)_                                                                                                                                                                                                                          |
+| [onChange?](./react/tracktoggleprops.onchange.md)             | (enabled: boolean, isUserInitiated: boolean) =&gt; void | _(Optional)_ Function that is called when the enabled state of the toggle changes. The second function argument <code>isUserInitiated</code> is <code>true</code> if the change was initiated by a user interaction, such as a click. |
+| [onDeviceError?](./react/tracktoggleprops.ondeviceerror.md)   | (error: Error) =&gt; void                               | _(Optional)_                                                                                                                                                                                                                          |
+| [publishOptions?](./react/tracktoggleprops.publishoptions.md) | TrackPublishOptions                                     | _(Optional)_                                                                                                                                                                                                                          |
+| [showIcon?](./react/tracktoggleprops.showicon.md)             | boolean                                                 | _(Optional)_                                                                                                                                                                                                                          |
+| [source](./react/tracktoggleprops.source.md)                  | T                                                       |                                                                                                                                                                                                                                       |

package/generated-docs/react/tracktoggleprops.onchange.md

@@ -0,0 +1,15 @@
+---
+{ "title": "TrackToggleProps.onChange property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# TrackToggleProps.onChange property
+
+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.
+
+**Signature:**
+
+```typescript
+onChange?: (enabled: boolean, isUserInitiated: boolean) => void;
+```