@livekit/components-js-docs 0.0.0-20251021151641

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

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

package/generated-docs/react/usetrackshookreturntype.md

@@ -0,0 +1,20 @@
+---
+{
+  "title": "UseTracksHookReturnType type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTracks.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseTracksHookReturnType type
+
+**Signature:**
+
+```typescript
+export type UseTracksHookReturnType<T> = T extends Track.Source[]
+  ? TrackReference[]
+  : T extends TrackSourceWithOptions[]
+    ? TrackReferenceOrPlaceholder[]
+    : never;
+```

package/generated-docs/react/usetracksoptions.md

@@ -0,0 +1,20 @@
+---
+{
+  "title": "UseTracksOptions type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTracks.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseTracksOptions type
+
+**Signature:**
+
+```typescript
+export type UseTracksOptions = {
+  updateOnlyOn?: RoomEvent[];
+  onlySubscribed?: boolean;
+  room?: Room;
+};
+```

package/generated-docs/react/usetracktoggleprops.md

@@ -0,0 +1,18 @@
+---
+{
+  "title": "UseTrackToggleProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTrackToggle.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseTrackToggleProps interface
+
+**Signature:**
+
+```typescript
+export interface UseTrackToggleProps<T extends ToggleSource> extends Omit<TrackToggleProps<T>, 'showIcon'>
+```
+
+**Extends:** Omit&lt;[TrackToggleProps](./react/tracktoggleprops.md)<!-- -->&lt;T&gt;, 'showIcon'&gt;

package/generated-docs/react/usevisualstableupdateoptions.customsortfunction.md

@@ -0,0 +1,15 @@
+---
+{ "title": "UseVisualStableUpdateOptions.customSortFunction property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseVisualStableUpdateOptions.customSortFunction property
+
+Overwrites the default sort function.
+
+**Signature:**
+
+```typescript
+customSortFunction?: (trackReferences: TrackReferenceOrPlaceholder[]) => TrackReferenceOrPlaceholder[];
+```

package/generated-docs/react/usevisualstableupdateoptions.md

@@ -0,0 +1,22 @@
+---
+{
+  "title": "UseVisualStableUpdateOptions interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useVisualStableUpdate.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseVisualStableUpdateOptions interface
+
+**Signature:**
+
+```typescript
+export interface UseVisualStableUpdateOptions
+```
+
+## Properties
+
+| Property                                                                          | Type                                                                                     | Description                                        |
+| --------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -------------------------------------------------- |
+| [customSortFunction?](./react/usevisualstableupdateoptions.customsortfunction.md) | (trackReferences: TrackReferenceOrPlaceholder\[\]) =&gt; TrackReferenceOrPlaceholder\[\] | _(Optional)_ Overwrites the default sort function. |

package/generated-docs/react/videoconferenceprops.chatmessagedecoder.md

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

package/generated-docs/react/videoconferenceprops.chatmessageencoder.md

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

package/generated-docs/react/videoconferenceprops.chatmessageformatter.md

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

package/generated-docs/react/videoconferenceprops.md

@@ -0,0 +1,27 @@
+---
+{
+  "title": "VideoConferenceProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/prefabs/VideoConference.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# VideoConferenceProps interface
+
+**Signature:**
+
+```typescript
+export interface VideoConferenceProps extends React.HTMLAttributes<HTMLDivElement>
+```
+
+**Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;
+
+## Properties
+
+| Property                                                                      | Type                                            | Description  |
+| ----------------------------------------------------------------------------- | ----------------------------------------------- | ------------ |
+| [chatMessageDecoder?](./react/videoconferenceprops.chatmessagedecoder.md)     | MessageDecoder                                  | _(Optional)_ |
+| [chatMessageEncoder?](./react/videoconferenceprops.chatmessageencoder.md)     | MessageEncoder                                  | _(Optional)_ |
+| [chatMessageFormatter?](./react/videoconferenceprops.chatmessageformatter.md) | [MessageFormatter](./react/messageformatter.md) | _(Optional)_ |
+| [SettingsComponent?](./react/videoconferenceprops.settingscomponent.md)       | React.ComponentType                             | _(Optional)_ |

package/generated-docs/react/videoconferenceprops.settingscomponent.md

@@ -0,0 +1,19 @@
+---
+{ "title": "VideoConferenceProps.SettingsComponent property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# VideoConferenceProps.SettingsComponent 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
+SettingsComponent?: React.ComponentType;
+```

package/generated-docs/react/videotrackprops.managesubscription.md

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

package/generated-docs/react/videotrackprops.md

@@ -0,0 +1,27 @@
+---
+{
+  "title": "VideoTrackProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/participant/VideoTrack.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# VideoTrackProps interface
+
+**Signature:**
+
+```typescript
+export interface VideoTrackProps extends React.VideoHTMLAttributes<HTMLVideoElement>
+```
+
+**Extends:** React.VideoHTMLAttributes&lt;HTMLVideoElement&gt;
+
+## Properties
+
+| Property                                                                               | Type                                    | Description                                              |
+| -------------------------------------------------------------------------------------- | --------------------------------------- | -------------------------------------------------------- |
+| [manageSubscription?](./react/videotrackprops.managesubscription.md)                   | boolean                                 | _(Optional)_                                             |
+| [onSubscriptionStatusChanged?](./react/videotrackprops.onsubscriptionstatuschanged.md) | (subscribed: boolean) =&gt; void        | _(Optional)_                                             |
+| [onTrackClick?](./react/videotrackprops.ontrackclick.md)                               | (evt: ParticipantClickEvent) =&gt; void | _(Optional)_                                             |
+| [trackRef?](./react/videotrackprops.trackref.md)                                       | TrackReference                          | _(Optional)_ The track reference of the track to render. |

package/generated-docs/react/videotrackprops.onsubscriptionstatuschanged.md

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

package/generated-docs/react/videotrackprops.ontrackclick.md

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

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

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

package/generated-docs/react/voiceassistant.agent.md

@@ -0,0 +1,21 @@
+---
+{ "title": "VoiceAssistant.agent property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# VoiceAssistant.agent 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 agent participant.
+
+**Signature:**
+
+```typescript
+agent: RemoteParticipant | undefined;
+```

package/generated-docs/react/voiceassistant.agentattributes.md

@@ -0,0 +1,21 @@
+---
+{ "title": "VoiceAssistant.agentAttributes property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# VoiceAssistant.agentAttributes 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 agent's participant attributes.
+
+**Signature:**
+
+```typescript
+agentAttributes: RemoteParticipant["attributes"] | undefined;
+```

package/generated-docs/react/voiceassistant.agenttranscriptions.md

@@ -0,0 +1,21 @@
+---
+{ "title": "VoiceAssistant.agentTranscriptions property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# VoiceAssistant.agentTranscriptions 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 transcriptions of the agent's microphone track (if any).
+
+**Signature:**
+
+```typescript
+agentTranscriptions: ReceivedTranscriptionSegment[];
+```

package/generated-docs/react/voiceassistant.audiotrack.md

@@ -0,0 +1,21 @@
+---
+{ "title": "VoiceAssistant.audioTrack property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# VoiceAssistant.audioTrack 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 microphone track published by the agent or associated avatar worker (if any).
+
+**Signature:**
+
+```typescript
+audioTrack: TrackReference | undefined;
+```

package/generated-docs/react/voiceassistant.md

@@ -0,0 +1,33 @@
+---
+{
+  "title": "VoiceAssistant interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useVoiceAssistant.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# VoiceAssistant 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 VoiceAssistant
+```
+
+## Properties
+
+| Property                                                             | Type                                           | Description                                                                                    |
+| -------------------------------------------------------------------- | ---------------------------------------------- | ---------------------------------------------------------------------------------------------- |
+| [agent](./react/voiceassistant.agent.md)                             | RemoteParticipant \| undefined                 | **_(BETA)_** The agent participant.                                                            |
+| [agentAttributes](./react/voiceassistant.agentattributes.md)         | RemoteParticipant\['attributes'\] \| undefined | **_(BETA)_** The agent's participant attributes.                                               |
+| [agentTranscriptions](./react/voiceassistant.agenttranscriptions.md) | ReceivedTranscriptionSegment\[\]               | **_(BETA)_** The transcriptions of the agent's microphone track (if any).                      |
+| [audioTrack](./react/voiceassistant.audiotrack.md)                   | TrackReference \| undefined                    | **_(BETA)_** The microphone track published by the agent or associated avatar worker (if any). |
+| [state](./react/voiceassistant.state.md)                             | [AgentState](./react/agentstate.md)            | **_(BETA)_** The current state of the agent.                                                   |
+| [videoTrack](./react/voiceassistant.videotrack.md)                   | TrackReference \| undefined                    | **_(BETA)_** The camera track published by the agent or associated avatar worker (if any).     |

package/generated-docs/react/voiceassistant.state.md

@@ -0,0 +1,21 @@
+---
+{ "title": "VoiceAssistant.state property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# VoiceAssistant.state 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 current state of the agent.
+
+**Signature:**
+
+```typescript
+state: AgentState;
+```

package/generated-docs/react/voiceassistant.videotrack.md

@@ -0,0 +1,21 @@
+---
+{ "title": "VoiceAssistant.videoTrack property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# VoiceAssistant.videoTrack 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 camera track published by the agent or associated avatar worker (if any).
+
+**Signature:**
+
+```typescript
+videoTrack: TrackReference | undefined;
+```

package/generated-docs/react/voiceassistantcontrolbarcontrols.md

@@ -0,0 +1,25 @@
+---
+{
+  "title": "VoiceAssistantControlBarControls type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/prefabs/VoiceAssistantControlBar.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# VoiceAssistantControlBarControls type
+
+{% 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 type VoiceAssistantControlBarControls = {
+  microphone?: boolean;
+  leave?: boolean;
+};
+```

package/generated-docs/react/voiceassistantcontrolbarprops.controls.md

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

package/generated-docs/react/voiceassistantcontrolbarprops.md

@@ -0,0 +1,32 @@
+---
+{
+  "title": "VoiceAssistantControlBarProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/prefabs/VoiceAssistantControlBar.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# VoiceAssistantControlBarProps 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 VoiceAssistantControlBarProps extends React.HTMLAttributes<HTMLDivElement>
+```
+
+**Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;
+
+## Properties
+
+| Property                                                                     | Type                                                                            | Description                                                                                                                                                                        |
+| ---------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [controls?](./react/voiceassistantcontrolbarprops.controls.md)               | [VoiceAssistantControlBarControls](./react/voiceassistantcontrolbarcontrols.md) | **_(BETA)_** _(Optional)_                                                                                                                                                          |
+| [onDeviceError?](./react/voiceassistantcontrolbarprops.ondeviceerror.md)     | (error: { source: Track.Source; error: Error; }) =&gt; void                     | **_(BETA)_** _(Optional)_                                                                                                                                                          |
+| [saveUserChoices?](./react/voiceassistantcontrolbarprops.saveuserchoices.md) | boolean                                                                         | **_(BETA)_** _(Optional)_ If <code>true</code>, the user's device choices will be persisted. This will enables the user to have the same device choices when they rejoin the room. |

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

@@ -0,0 +1,22 @@
+---
+{ "title": "VoiceAssistantControlBarProps.onDeviceError property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# VoiceAssistantControlBarProps.onDeviceError property
+
+{% 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
+onDeviceError?: (error: {
+        source: Track.Source;
+        error: Error;
+    }) => void;
+```

package/generated-docs/react/voiceassistantcontrolbarprops.saveuserchoices.md

@@ -0,0 +1,21 @@
+---
+{ "title": "VoiceAssistantControlBarProps.saveUserChoices property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# VoiceAssistantControlBarProps.saveUserChoices property
+
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
+
+If `true`<!-- -->, the user's device choices will be persisted. This will enables the user to have the same device choices when they rejoin the room.
+
+**Signature:**
+
+```typescript
+saveUserChoices?: boolean;
+```

package/package.json

@@ -0,0 +1,23 @@
+{
+  "name": "@livekit/components-js-docs",
+  "version": "0.0.0-20251021151641",
+  "description": "Automatically generated documentation pages for LiveKit Components JS. Intended to be consumed by the documentation page.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/livekit/components-js.git",
+    "directory": "/docs/beta-docs"
+  },
+  "dependencies": {
+    "@livekit/components-react": "0.0.0-20251021151641"
+  },
+  "author": "",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/livekit/components-js/issues"
+  },
+  "homepage": "https://github.com/livekit/components-js#readme",
+  "files": [
+    "generated-docs",
+    "meta-data.json"
+  ]
+}