@livekit/components-js-docs 0.0.0-20251021151641

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

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

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

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

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

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

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

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

package/generated-docs/react/tracktranscriptionoptions.buffersize.md

@@ -0,0 +1,21 @@
+---
+{ "title": "TrackTranscriptionOptions.bufferSize property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# TrackTranscriptionOptions.bufferSize 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 %}
+
+how many transcription segments should be buffered in state
+
+**Signature:**
+
+```typescript
+bufferSize?: number;
+```

package/generated-docs/react/tracktranscriptionoptions.md

@@ -0,0 +1,29 @@
+---
+{
+  "title": "TrackTranscriptionOptions interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTrackTranscription.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# TrackTranscriptionOptions 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 TrackTranscriptionOptions
+```
+
+## Properties
+
+| Property                                                                 | Type                                               | Description                                                                      |
+| ------------------------------------------------------------------------ | -------------------------------------------------- | -------------------------------------------------------------------------------- |
+| [bufferSize?](./react/tracktranscriptionoptions.buffersize.md)           | number                                             | _(Optional)_ how many transcription segments should be buffered in state         |
+| [onTranscription?](./react/tracktranscriptionoptions.ontranscription.md) | (newSegments: TranscriptionSegment\[\]) =&gt; void | _(Optional)_ optional callback for retrieving newly incoming transcriptions only |

package/generated-docs/react/tracktranscriptionoptions.ontranscription.md

@@ -0,0 +1,21 @@
+---
+{ "title": "TrackTranscriptionOptions.onTranscription property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# TrackTranscriptionOptions.onTranscription 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 %}
+
+optional callback for retrieving newly incoming transcriptions only
+
+**Signature:**
+
+```typescript
+onTranscription?: (newSegments: TranscriptionSegment[]) => void;
+```

package/generated-docs/react/usechattoggleprops.md

@@ -0,0 +1,22 @@
+---
+{
+  "title": "UseChatToggleProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useChatToggle.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseChatToggleProps interface
+
+**Signature:**
+
+```typescript
+export interface UseChatToggleProps
+```
+
+## Properties
+
+| Property                                     | Type                                                | Description |
+| -------------------------------------------- | --------------------------------------------------- | ----------- |
+| [props](./react/usechattoggleprops.props.md) | React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt; |             |

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

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

package/generated-docs/react/usefocustoggleprops.md

@@ -0,0 +1,23 @@
+---
+{
+  "title": "UseFocusToggleProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useFocusToggle.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseFocusToggleProps interface
+
+**Signature:**
+
+```typescript
+export interface UseFocusToggleProps
+```
+
+## Properties
+
+| Property                                             | Type                                                | Description  |
+| ---------------------------------------------------- | --------------------------------------------------- | ------------ |
+| [props](./react/usefocustoggleprops.props.md)        | React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt; |              |
+| [trackRef?](./react/usefocustoggleprops.trackref.md) | TrackReferenceOrPlaceholder                         | _(Optional)_ |

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

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

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

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

package/generated-docs/react/useisencryptedoptions.md

@@ -0,0 +1,28 @@
+---
+{
+  "title": "UseIsEncryptedOptions interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useIsEncrypted.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseIsEncryptedOptions 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 UseIsEncryptedOptions
+```
+
+## Properties
+
+| Property                                       | Type | Description  |
+| ---------------------------------------------- | ---- | ------------ |
+| [room?](./react/useisencryptedoptions.room.md) | Room | _(Optional)_ |

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

@@ -0,0 +1,19 @@
+---
+{ "title": "UseIsEncryptedOptions.room property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseIsEncryptedOptions.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/useismutedoptions.md

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

package/generated-docs/react/useismutedoptions.participant.md

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

package/generated-docs/react/usekrispnoisefilteroptions.md

@@ -0,0 +1,28 @@
+---
+{
+  "title": "useKrispNoiseFilterOptions interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/cloud/krisp/useKrispNoiseFilter.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useKrispNoiseFilterOptions interface
+
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
+
+**Signature:**
+
+```typescript
+export interface useKrispNoiseFilterOptions
+```
+
+## Properties
+
+| Property                                                    | Type                        | Description                                                                                                  |
+| ----------------------------------------------------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------ |
+| [trackRef?](./react/usekrispnoisefilteroptions.trackref.md) | TrackReferenceOrPlaceholder | **_(BETA)_** _(Optional)_ The track reference to use for the noise filter (defaults: local microphone track) |

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

@@ -0,0 +1,21 @@
+---
+{ "title": "useKrispNoiseFilterOptions.trackRef property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useKrispNoiseFilterOptions.trackRef property
+
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
+
+The track reference to use for the noise filter (defaults: local microphone track)
+
+**Signature:**
+
+```typescript
+trackRef?: TrackReferenceOrPlaceholder;
+```

package/generated-docs/react/uselocalparticipantoptions.md

@@ -0,0 +1,22 @@
+---
+{
+  "title": "UseLocalParticipantOptions interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useLocalParticipant.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseLocalParticipantOptions interface
+
+**Signature:**
+
+```typescript
+export interface UseLocalParticipantOptions
+```
+
+## Properties
+
+| Property                                            | Type | Description                                                                                 |
+| --------------------------------------------------- | ---- | ------------------------------------------------------------------------------------------- |
+| [room?](./react/uselocalparticipantoptions.room.md) | Room | _(Optional)_ The room to use. If not provided, the hook will use the room from the context. |

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

@@ -0,0 +1,15 @@
+---
+{ "title": "UseLocalParticipantOptions.room property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseLocalParticipantOptions.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/usemediadeviceselectprops.kind.md

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

package/generated-docs/react/usemediadeviceselectprops.md

@@ -0,0 +1,26 @@
+---
+{
+  "title": "UseMediaDeviceSelectProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useMediaDeviceSelect.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseMediaDeviceSelectProps interface
+
+**Signature:**
+
+```typescript
+export interface UseMediaDeviceSelectProps
+```
+
+## Properties
+
+| Property                                                                       | Type                               | Description                                                                                                                                                                                                                                                                                                                                              |
+| ------------------------------------------------------------------------------ | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [kind](./react/usemediadeviceselectprops.kind.md)                              | MediaDeviceKind                    |                                                                                                                                                                                                                                                                                                                                                          |
+| [onError?](./react/usemediadeviceselectprops.onerror.md)                       | (e: Error) =&gt; void              | _(Optional)_ this callback gets called if an error is thrown when failing to select a device and also if a user denied permissions, eventhough the <code>requestPermissions</code> option is set to <code>true</code>. Most commonly this will emit a MediaDeviceError                                                                                   |
+| [requestPermissions?](./react/usemediadeviceselectprops.requestpermissions.md) | boolean                            | _(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. |
+| [room?](./react/usemediadeviceselectprops.room.md)                             | Room                               | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
+| [track?](./react/usemediadeviceselectprops.track.md)                           | LocalAudioTrack \| LocalVideoTrack | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |

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

@@ -0,0 +1,15 @@
+---
+{ "title": "UseMediaDeviceSelectProps.onError property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseMediaDeviceSelectProps.onError property
+
+this callback gets called if an error is thrown when failing to select a device and also if a user denied permissions, eventhough the `requestPermissions` option is set to `true`<!-- -->. Most commonly this will emit a MediaDeviceError
+
+**Signature:**
+
+```typescript
+onError?: (e: Error) => void;
+```

package/generated-docs/react/usemediadeviceselectprops.requestpermissions.md

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

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

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

package/generated-docs/react/usemediadeviceselectprops.track.md

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

package/generated-docs/react/useparticipantattributesoptions.md

@@ -0,0 +1,30 @@
+---
+{
+  "title": "UseParticipantAttributesOptions interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useParticipantAttributes.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseParticipantAttributesOptions interface
+
+The `useParticipantAttributes` hook returns the attributes of a given participant and allows to set them. It requires a `Participant` object passed as property or via the `ParticipantContext`<!-- -->.
+
+**Signature:**
+
+```typescript
+export interface UseParticipantAttributesOptions
+```
+
+## Usage
+
+```tsx
+const { attributes } = useParticipantAttributes({ participant });
+```
+
+## Properties
+
+| Property                                                               | Type        | Description  |
+| ---------------------------------------------------------------------- | ----------- | ------------ |
+| [participant?](./react/useparticipantattributesoptions.participant.md) | Participant | _(Optional)_ |

package/generated-docs/react/useparticipantattributesoptions.participant.md

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

package/generated-docs/react/useparticipantinfooptions.md

@@ -0,0 +1,30 @@
+---
+{
+  "title": "UseParticipantInfoOptions interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useParticipantInfo.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseParticipantInfoOptions interface
+
+The `useParticipantInfo` hook returns the identity, name, and metadata of a given participant. It requires a `Participant` object passed as property or via the `ParticipantContext`<!-- -->.
+
+**Signature:**
+
+```typescript
+export interface UseParticipantInfoOptions
+```
+
+## Usage
+
+```tsx
+const { identity, name, metadata } = useParticipantInfo({ participant });
+```
+
+## Properties
+
+| Property                                                         | Type        | Description  |
+| ---------------------------------------------------------------- | ----------- | ------------ |
+| [participant?](./react/useparticipantinfooptions.participant.md) | Participant | _(Optional)_ |

package/generated-docs/react/useparticipantinfooptions.participant.md

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

package/generated-docs/react/useparticipantpermissionsoptions.md

@@ -0,0 +1,30 @@
+---
+{
+  "title": "UseParticipantPermissionsOptions interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useParticipantPermissions.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseParticipantPermissionsOptions interface
+
+The `useParticipantPermissions` hook returns the permissions of a given participant.
+
+**Signature:**
+
+```typescript
+export interface UseParticipantPermissionsOptions
+```
+
+## Usage
+
+```tsx
+const permissions = useParticipantPermissions({ participant });
+```
+
+## Properties
+
+| Property                                                                | Type        | Description  |
+| ----------------------------------------------------------------------- | ----------- | ------------ |
+| [participant?](./react/useparticipantpermissionsoptions.participant.md) | Participant | _(Optional)_ |

package/generated-docs/react/useparticipantpermissionsoptions.participant.md

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