@livekit/components-js-docs 0.0.0-20251021151641

package/generated-docs/react/agentstate.md

@@ -0,0 +1,28 @@
+---
+{
+  "title": "AgentState type",
+  "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. -->
+
+# AgentState 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 AgentState =
+  | "disconnected"
+  | "connecting"
+  | "initializing"
+  | "listening"
+  | "thinking"
+  | "speaking";
+```

package/generated-docs/react/allowaudioplaybackprops.label.md

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

package/generated-docs/react/allowaudioplaybackprops.md

@@ -0,0 +1,24 @@
+---
+{
+  "title": "AllowAudioPlaybackProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/controls/StartAudio.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# AllowAudioPlaybackProps interface
+
+**Signature:**
+
+```typescript
+export interface AllowAudioPlaybackProps extends React.ButtonHTMLAttributes<HTMLButtonElement>
+```
+
+**Extends:** React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt;
+
+## Properties
+
+| Property                                          | Type   | Description |
+| ------------------------------------------------- | ------ | ----------- |
+| [label](./react/allowaudioplaybackprops.label.md) | string |             |

package/generated-docs/react/allowmediaplaybackprops.label.md

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

package/generated-docs/react/allowmediaplaybackprops.md

@@ -0,0 +1,24 @@
+---
+{
+  "title": "AllowMediaPlaybackProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/controls/StartMediaButton.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# AllowMediaPlaybackProps interface
+
+**Signature:**
+
+```typescript
+export interface AllowMediaPlaybackProps extends React.ButtonHTMLAttributes<HTMLButtonElement>
+```
+
+**Extends:** React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt;
+
+## Properties
+
+| Property                                           | Type   | Description  |
+| -------------------------------------------------- | ------ | ------------ |
+| [label?](./react/allowmediaplaybackprops.label.md) | string | _(Optional)_ |

package/generated-docs/react/audioconferenceprops.md

@@ -0,0 +1,18 @@
+---
+{
+  "title": "AudioConferenceProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/prefabs/AudioConference.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# AudioConferenceProps interface
+
+**Signature:**
+
+```typescript
+export interface AudioConferenceProps extends React.HTMLAttributes<HTMLDivElement>
+```
+
+**Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;

package/generated-docs/react/audiotrackprops.md

@@ -0,0 +1,27 @@
+---
+{
+  "title": "AudioTrackProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/participant/AudioTrack.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# AudioTrackProps interface
+
+**Signature:**
+
+```typescript
+export interface AudioTrackProps extends React.AudioHTMLAttributes<HTMLAudioElement>
+```
+
+**Extends:** React.AudioHTMLAttributes&lt;HTMLAudioElement&gt;
+
+## Properties
+
+| Property                                                                               | Type                             | Description                                                                                                              |
+| -------------------------------------------------------------------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
+| [muted?](./react/audiotrackprops.muted.md)                                             | boolean                          | _(Optional)_ Mutes the audio track if set to <code>true</code>.                                                          |
+| [onSubscriptionStatusChanged?](./react/audiotrackprops.onsubscriptionstatuschanged.md) | (subscribed: boolean) =&gt; void | _(Optional)_                                                                                                             |
+| [trackRef?](./react/audiotrackprops.trackref.md)                                       | TrackReference                   | _(Optional)_ The track reference of the track from which the audio is to be rendered.                                    |
+| [volume?](./react/audiotrackprops.volume.md)                                           | number                           | _(Optional)_ Sets the volume of the audio track. By default, the range is between <code>0.0</code> and <code>1.0</code>. |

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

@@ -0,0 +1,25 @@
+---
+{ "title": "AudioTrackProps.muted property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# AudioTrackProps.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 %}
+
+Mutes the audio track if set to `true`<!-- -->.
+
+**Signature:**
+
+```typescript
+muted?: boolean;
+```
+
+## Remarks
+
+If set to `true`<!-- -->, the server will stop sending audio track data to the client.

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

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

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

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

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

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

package/generated-docs/react/audiovisualizerprops.md

@@ -0,0 +1,30 @@
+---
+{
+  "title": "AudioVisualizerProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/participant/AudioVisualizer.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# AudioVisualizerProps interface
+
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated: Use BarVisualizer instead
+
+{% /callout %}
+
+**Signature:**
+
+```typescript
+export interface AudioVisualizerProps extends React.HTMLAttributes<SVGElement>
+```
+
+**Extends:** React.HTMLAttributes&lt;SVGElement&gt;
+
+## Properties
+
+| Property                                              | Type           | Description  |
+| ----------------------------------------------------- | -------------- | ------------ |
+| [trackRef?](./react/audiovisualizerprops.trackref.md) | TrackReference | _(Optional)_ |

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

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

package/generated-docs/react/audiowaveformoptions.barcount.md

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

package/generated-docs/react/audiowaveformoptions.md

@@ -0,0 +1,30 @@
+---
+{
+  "title": "AudioWaveformOptions interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTrackVolume.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# AudioWaveformOptions 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 AudioWaveformOptions
+```
+
+## Properties
+
+| Property                                                          | Type   | Description  |
+| ----------------------------------------------------------------- | ------ | ------------ |
+| [barCount?](./react/audiowaveformoptions.barcount.md)             | number | _(Optional)_ |
+| [updateInterval?](./react/audiowaveformoptions.updateinterval.md) | number | _(Optional)_ |
+| [volMultiplier?](./react/audiowaveformoptions.volmultiplier.md)   | number | _(Optional)_ |

package/generated-docs/react/audiowaveformoptions.updateinterval.md

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

package/generated-docs/react/audiowaveformoptions.volmultiplier.md

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

package/generated-docs/react/barvisualizeroptions.md

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

package/generated-docs/react/barvisualizerprops.barcount.md

@@ -0,0 +1,21 @@
+---
+{ "title": "BarVisualizerProps.barCount property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# BarVisualizerProps.barCount property
+
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
+
+Number of bars that show up in the visualizer
+
+**Signature:**
+
+```typescript
+barCount?: number;
+```

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

@@ -0,0 +1,21 @@
+---
+{ "title": "BarVisualizerProps.children property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# BarVisualizerProps.children 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 template component to be used in the visualizer.
+
+**Signature:**
+
+```typescript
+children?: React.ReactNode;
+```

package/generated-docs/react/barvisualizerprops.md

@@ -0,0 +1,34 @@
+---
+{
+  "title": "BarVisualizerProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/participant/BarVisualizer.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# BarVisualizerProps 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 BarVisualizerProps extends React.HTMLProps<HTMLDivElement>
+```
+
+**Extends:** React.HTMLProps&lt;HTMLDivElement&gt;
+
+## Properties
+
+| Property                                            | Type                                                    | Description                                                                                               |
+| --------------------------------------------------- | ------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
+| [barCount?](./react/barvisualizerprops.barcount.md) | number                                                  | **_(BETA)_** _(Optional)_ Number of bars that show up in the visualizer                                   |
+| [children?](./react/barvisualizerprops.children.md) | React.ReactNode                                         | **_(BETA)_** _(Optional)_ The template component to be used in the visualizer.                            |
+| [options?](./react/barvisualizerprops.options.md)   | [BarVisualizerOptions](./react/barvisualizeroptions.md) | **_(BETA)_** _(Optional)_                                                                                 |
+| [state?](./react/barvisualizerprops.state.md)       | [AgentState](./react/agentstate.md)                     | **_(BETA)_** _(Optional)_ If set, the visualizer will transition between different voice assistant states |
+| [trackRef?](./react/barvisualizerprops.trackref.md) | TrackReferenceOrPlaceholder                             | **_(BETA)_** _(Optional)_                                                                                 |

package/generated-docs/react/barvisualizerprops.options.md

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

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

@@ -0,0 +1,21 @@
+---
+{ "title": "BarVisualizerProps.state property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# BarVisualizerProps.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 %}
+
+If set, the visualizer will transition between different voice assistant states
+
+**Signature:**
+
+```typescript
+state?: AgentState;
+```

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

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

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

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

package/generated-docs/react/carousellayoutprops.md

@@ -0,0 +1,26 @@
+---
+{
+  "title": "CarouselLayoutProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/layout/CarouselLayout.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# CarouselLayoutProps interface
+
+**Signature:**
+
+```typescript
+export interface CarouselLayoutProps extends React.HTMLAttributes<HTMLMediaElement>
+```
+
+**Extends:** React.HTMLAttributes&lt;HTMLMediaElement&gt;
+
+## Properties
+
+| Property                                                   | Type                            | Description                                                                                                                                         |
+| ---------------------------------------------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [children](./react/carousellayoutprops.children.md)        | React.ReactNode                 |                                                                                                                                                     |
+| [orientation?](./react/carousellayoutprops.orientation.md) | 'vertical' \| 'horizontal'      | _(Optional)_ Place the tiles vertically or horizontally next to each other. If undefined orientation is guessed by the dimensions of the container. |
+| [tracks](./react/carousellayoutprops.tracks.md)            | TrackReferenceOrPlaceholder\[\] |                                                                                                                                                     |

package/generated-docs/react/carousellayoutprops.orientation.md

@@ -0,0 +1,15 @@
+---
+{ "title": "CarouselLayoutProps.orientation property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# CarouselLayoutProps.orientation property
+
+Place the tiles vertically or horizontally next to each other. If undefined orientation is guessed by the dimensions of the container.
+
+**Signature:**
+
+```typescript
+orientation?: 'vertical' | 'horizontal';
+```

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

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

package/generated-docs/react/chatentryprops.entry.md

@@ -0,0 +1,15 @@
+---
+{ "title": "ChatEntryProps.entry property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# ChatEntryProps.entry property
+
+The chat massage object to display.
+
+**Signature:**
+
+```typescript
+entry: ReceivedChatMessage;
+```

package/generated-docs/react/chatentryprops.hidename.md

@@ -0,0 +1,15 @@
+---
+{ "title": "ChatEntryProps.hideName property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# ChatEntryProps.hideName property
+
+Hide sender name. Useful when displaying multiple consecutive chat messages from the same person.
+
+**Signature:**
+
+```typescript
+hideName?: boolean;
+```

package/generated-docs/react/chatentryprops.hidetimestamp.md

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