@livekit/components-js-docs 0.0.0-20251021151641

package/generated-docs/react/useparticipantsoptions.md

@@ -0,0 +1,23 @@
+---
+{
+  "title": "UseParticipantsOptions interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useParticipants.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseParticipantsOptions interface
+
+**Signature:**
+
+```typescript
+export interface UseParticipantsOptions
+```
+
+## Properties
+
+| Property                                                        | Type          | Description                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| --------------------------------------------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [room?](./react/useparticipantsoptions.room.md)                 | Room          | _(Optional)_ The room to use. If not provided, the hook will use the room from the context.                                                                                                                                                                                                                                                                                                                                      |
+| [updateOnlyOn?](./react/useparticipantsoptions.updateonlyon.md) | RoomEvent\[\] | _(Optional)_ To optimize performance, you can use the <code>updateOnlyOn</code> property to decide on what RoomEvents the hook updates. By default it updates on all relevant RoomEvents to keep the returned participants array up to date. The minimal set of non-overwriteable <code>RoomEvents</code> is: <code>[RoomEvent.ParticipantConnected, RoomEvent.ParticipantDisconnected, RoomEvent.ConnectionStateChanged]</code> |

package/generated-docs/react/useparticipantsoptions.room.md

@@ -0,0 +1,15 @@
+---
+{ "title": "UseParticipantsOptions.room property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseParticipantsOptions.room property
+
+The room to use. If not provided, the hook will use the room from the context.
+
+**Signature:**
+
+```typescript
+room?: Room;
+```

package/generated-docs/react/useparticipantsoptions.updateonlyon.md

@@ -0,0 +1,15 @@
+---
+{ "title": "UseParticipantsOptions.updateOnlyOn property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseParticipantsOptions.updateOnlyOn property
+
+To optimize performance, you can use the `updateOnlyOn` property to decide on what RoomEvents the hook updates. By default it updates on all relevant RoomEvents to keep the returned participants array up to date. The minimal set of non-overwriteable `RoomEvents` is: `[RoomEvent.ParticipantConnected, RoomEvent.ParticipantDisconnected, RoomEvent.ConnectionStateChanged]`
+
+**Signature:**
+
+```typescript
+updateOnlyOn?: RoomEvent[];
+```

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

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

package/generated-docs/react/useparticipanttileprops.htmlprops.md

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

package/generated-docs/react/useparticipanttileprops.md

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

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

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

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

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

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

@@ -0,0 +1,21 @@
+---
+{ "title": "UsePersistentUserChoicesOptions.defaults property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UsePersistentUserChoicesOptions.defaults 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 %}
+
+The default value to use if reading from local storage returns no results or fails.
+
+**Signature:**
+
+```typescript
+defaults?: Partial<LocalUserChoices>;
+```

package/generated-docs/react/usepersistentuserchoicesoptions.md

@@ -0,0 +1,32 @@
+---
+{
+  "title": "UsePersistentUserChoicesOptions interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/usePersistentUserChoices.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UsePersistentUserChoicesOptions interface
+
+{% callout type="note" variation="normal" %}
+
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+
+{% /callout %}
+
+Options for the `usePersistentDeviceSettings` hook.
+
+**Signature:**
+
+```typescript
+export interface UsePersistentUserChoicesOptions
+```
+
+## Properties
+
+| Property                                                               | Type                            | Description                                                                                                         |
+| ---------------------------------------------------------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
+| [defaults?](./react/usepersistentuserchoicesoptions.defaults.md)       | Partial&lt;LocalUserChoices&gt; | _(Optional)_ The default value to use if reading from local storage returns no results or fails.                    |
+| [preventLoad?](./react/usepersistentuserchoicesoptions.preventload.md) | boolean                         | _(Optional)_ Whether to prevent loading user choices from persistent storage and use <code>defaults</code> instead. |
+| [preventSave?](./react/usepersistentuserchoicesoptions.preventsave.md) | boolean                         | _(Optional)_ Whether to prevent saving to persistent storage.                                                       |

package/generated-docs/react/usepersistentuserchoicesoptions.preventload.md

@@ -0,0 +1,21 @@
+---
+{ "title": "UsePersistentUserChoicesOptions.preventLoad property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UsePersistentUserChoicesOptions.preventLoad 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 %}
+
+Whether to prevent loading user choices from persistent storage and use `defaults` instead.
+
+**Signature:**
+
+```typescript
+preventLoad?: boolean;
+```

package/generated-docs/react/usepersistentuserchoicesoptions.preventsave.md

@@ -0,0 +1,21 @@
+---
+{ "title": "UsePersistentUserChoicesOptions.preventSave property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UsePersistentUserChoicesOptions.preventSave 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 %}
+
+Whether to prevent saving to persistent storage.
+
+**Signature:**
+
+```typescript
+preventSave?: boolean;
+```

package/generated-docs/react/useremoteparticipantoptions.md

@@ -0,0 +1,22 @@
+---
+{
+  "title": "UseRemoteParticipantOptions interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useRemoteParticipant.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseRemoteParticipantOptions interface
+
+**Signature:**
+
+```typescript
+export interface UseRemoteParticipantOptions
+```
+
+## Properties
+
+| Property                                                             | Type                 | Description                                                                                                                                                                                                                                                      |
+| -------------------------------------------------------------------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [updateOnlyOn?](./react/useremoteparticipantoptions.updateonlyon.md) | ParticipantEvent\[\] | _(Optional)_ To optimize performance, you can use the <code>updateOnlyOn</code> property to decide on what <code>ParticipantEvents</code> the hook updates. By default it updates on all relevant ParticipantEvents to keep the returned participant up to date. |

package/generated-docs/react/useremoteparticipantoptions.updateonlyon.md

@@ -0,0 +1,15 @@
+---
+{ "title": "UseRemoteParticipantOptions.updateOnlyOn property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseRemoteParticipantOptions.updateOnlyOn property
+
+To optimize performance, you can use the `updateOnlyOn` property to decide on what `ParticipantEvents` the hook updates. By default it updates on all relevant ParticipantEvents to keep the returned participant up to date.
+
+**Signature:**
+
+```typescript
+updateOnlyOn?: ParticipantEvent[];
+```

package/generated-docs/react/useremoteparticipantsoptions.md

@@ -0,0 +1,23 @@
+---
+{
+  "title": "UseRemoteParticipantsOptions interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useRemoteParticipants.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseRemoteParticipantsOptions interface
+
+**Signature:**
+
+```typescript
+export interface UseRemoteParticipantsOptions
+```
+
+## Properties
+
+| Property                                                              | Type          | Description                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| --------------------------------------------------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [room?](./react/useremoteparticipantsoptions.room.md)                 | Room          | _(Optional)_ The room to use. If not provided, the hook will use the room from the context.                                                                                                                                                                                                                                                                                                                                      |
+| [updateOnlyOn?](./react/useremoteparticipantsoptions.updateonlyon.md) | RoomEvent\[\] | _(Optional)_ To optimize performance, you can use the <code>updateOnlyOn</code> property to decide on what RoomEvents the hook updates. By default it updates on all relevant RoomEvents to keep the returned participants array up to date. The minimal set of non-overwriteable <code>RoomEvents</code> is: <code>[RoomEvent.ParticipantConnected, RoomEvent.ParticipantDisconnected, RoomEvent.ConnectionStateChanged]</code> |

package/generated-docs/react/useremoteparticipantsoptions.room.md

@@ -0,0 +1,15 @@
+---
+{ "title": "UseRemoteParticipantsOptions.room property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseRemoteParticipantsOptions.room property
+
+The room to use. If not provided, the hook will use the room from the context.
+
+**Signature:**
+
+```typescript
+room?: Room;
+```

package/generated-docs/react/useremoteparticipantsoptions.updateonlyon.md

@@ -0,0 +1,15 @@
+---
+{ "title": "UseRemoteParticipantsOptions.updateOnlyOn property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseRemoteParticipantsOptions.updateOnlyOn property
+
+To optimize performance, you can use the `updateOnlyOn` property to decide on what RoomEvents the hook updates. By default it updates on all relevant RoomEvents to keep the returned participants array up to date. The minimal set of non-overwriteable `RoomEvents` is: `[RoomEvent.ParticipantConnected, RoomEvent.ParticipantDisconnected, RoomEvent.ConnectionStateChanged]`
+
+**Signature:**
+
+```typescript
+updateOnlyOn?: RoomEvent[];
+```

package/generated-docs/react/userinfo.identity.md

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

package/generated-docs/react/userinfo.md

@@ -0,0 +1,24 @@
+---
+{
+  "title": "UserInfo interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useToken.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UserInfo interface
+
+**Signature:**
+
+```typescript
+export interface UserInfo
+```
+
+## Properties
+
+| Property                                  | Type   | Description  |
+| ----------------------------------------- | ------ | ------------ |
+| [identity?](./react/userinfo.identity.md) | string | _(Optional)_ |
+| [metadata?](./react/userinfo.metadata.md) | string | _(Optional)_ |
+| [name?](./react/userinfo.name.md)         | string | _(Optional)_ |

package/generated-docs/react/userinfo.metadata.md

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

package/generated-docs/react/userinfo.name.md

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

package/generated-docs/react/useroominfooptions.md

@@ -0,0 +1,34 @@
+---
+{
+  "title": "UseRoomInfoOptions interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useRoomInfo.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseRoomInfoOptions interface
+
+The `useRoomInfo` hook returns the name and metadata of the given `Room`<!-- -->.
+
+**Signature:**
+
+```typescript
+export interface UseRoomInfoOptions
+```
+
+## Remarks
+
+Needs to be called inside a `RoomContext` or by passing a `Room` instance.
+
+## Usage
+
+```tsx
+const { name, metadata } = useRoomInfo();
+```
+
+## Properties
+
+| Property                                    | Type | Description  |
+| ------------------------------------------- | ---- | ------------ |
+| [room?](./react/useroominfooptions.room.md) | Room | _(Optional)_ |

package/generated-docs/react/useroominfooptions.room.md

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

package/generated-docs/react/usestartaudioprops.md

@@ -0,0 +1,29 @@
+---
+{
+  "title": "UseStartAudioProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useStartAudio.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseStartAudioProps interface
+
+{% callout type="note" variation="normal" %}
+
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+
+{% /callout %}
+
+**Signature:**
+
+```typescript
+export interface UseStartAudioProps
+```
+
+## Properties
+
+| Property                                     | Type                                                | Description  |
+| -------------------------------------------- | --------------------------------------------------- | ------------ |
+| [props](./react/usestartaudioprops.props.md) | React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt; |              |
+| [room?](./react/usestartaudioprops.room.md)  | Room                                                | _(Optional)_ |

package/generated-docs/react/usestartaudioprops.props.md

@@ -0,0 +1,19 @@
+---
+{ "title": "UseStartAudioProps.props property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseStartAudioProps.props 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 %}
+
+**Signature:**
+
+```typescript
+props: React.ButtonHTMLAttributes<HTMLButtonElement>;
+```

package/generated-docs/react/usestartaudioprops.room.md

@@ -0,0 +1,19 @@
+---
+{ "title": "UseStartAudioProps.room property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseStartAudioProps.room 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 %}
+
+**Signature:**
+
+```typescript
+room?: Room;
+```

package/generated-docs/react/usestartvideoprops.md

@@ -0,0 +1,29 @@
+---
+{
+  "title": "UseStartVideoProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useStartVideo.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseStartVideoProps interface
+
+{% callout type="note" variation="normal" %}
+
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+
+{% /callout %}
+
+**Signature:**
+
+```typescript
+export interface UseStartVideoProps
+```
+
+## Properties
+
+| Property                                     | Type                                                | Description  |
+| -------------------------------------------- | --------------------------------------------------- | ------------ |
+| [props](./react/usestartvideoprops.props.md) | React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt; |              |
+| [room?](./react/usestartvideoprops.room.md)  | Room                                                | _(Optional)_ |

package/generated-docs/react/usestartvideoprops.props.md

@@ -0,0 +1,19 @@
+---
+{ "title": "UseStartVideoProps.props property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseStartVideoProps.props 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 %}
+
+**Signature:**
+
+```typescript
+props: React.ButtonHTMLAttributes<HTMLButtonElement>;
+```

package/generated-docs/react/usestartvideoprops.room.md

@@ -0,0 +1,19 @@
+---
+{ "title": "UseStartVideoProps.room property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseStartVideoProps.room 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 %}
+
+**Signature:**
+
+```typescript
+room?: Room;
+```

package/generated-docs/react/useswipeoptions.md

@@ -0,0 +1,26 @@
+---
+{
+  "title": "UseSwipeOptions type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useSwipe.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseSwipeOptions type
+
+{% callout type="note" variation="normal" %}
+
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+
+{% /callout %}
+
+**Signature:**
+
+```typescript
+export type UseSwipeOptions = {
+  minSwipeDistance?: number;
+  onLeftSwipe?: () => void;
+  onRightSwipe?: () => void;
+};
+```

package/generated-docs/react/usetokenoptions.md

@@ -0,0 +1,22 @@
+---
+{
+  "title": "UseTokenOptions interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useToken.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseTokenOptions interface
+
+**Signature:**
+
+```typescript
+export interface UseTokenOptions
+```
+
+## Properties
+
+| Property                                         | Type                            | Description  |
+| ------------------------------------------------ | ------------------------------- | ------------ |
+| [userInfo?](./react/usetokenoptions.userinfo.md) | [UserInfo](./react/userinfo.md) | _(Optional)_ |