@livekit/components-js-docs 0.1.37 → 0.1.39

package/generated-docs/core/chatoptions.md

@@ -13,13 +13,13 @@
 
 ```typescript
 export type ChatOptions = {
-  messageEncoder?: (message: ChatMessage) => Uint8Array;
-  messageDecoder?: (message: Uint8Array) => ReceivedChatMessage;
+  messageEncoder?: (message: LegacyChatMessage) => Uint8Array;
+  messageDecoder?: (message: Uint8Array) => LegacyReceivedChatMessage;
   channelTopic?: string;
   updateChannelTopic?: string;
 };
 ```
 
-**References:** [ChatMessage](./core/chatmessage.md)<!-- -->, [ReceivedChatMessage](./core/receivedchatmessage.md)
+**References:** [LegacyChatMessage](./core/legacychatmessage.md)<!-- -->, [LegacyReceivedChatMessage](./core/legacyreceivedchatmessage.md)
 
 {% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/createchatobserver.md

@@ -0,0 +1,23 @@
+---
+{
+  "title": "createChatObserver",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/room.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# createChatObserver
+
+**Signature:**
+
+```typescript
+export declare function createChatObserver(
+  room: Room
+): Observable<
+  [
+    message: import("livekit-client").ChatMessage,
+    participant?: LocalParticipant | import("livekit-client").RemoteParticipant | undefined
+  ]
+>;
+```

package/generated-docs/core/index.md

@@ -20,7 +20,6 @@
 | [AudioSource](./core/audiosource.md)                                                                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [BaseDataMessage](./core/basedatamessage.md)                                                                    |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [CaptureOptionsBySource](./core/captureoptionsbysource.md)                                                      |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [ChatMessage](./core/chatmessage.md)                                                                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [ChatOptions](./core/chatoptions.md)                                                                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [computeMenuPosition(button, menu)](./core/computemenuposition.md)                                              |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [connectedParticipantObserver(room, identity, options)](./core/connectedparticipantobserver.md)                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
@@ -28,6 +27,7 @@
 | [connectedParticipantsObserver(room, options)](./core/connectedparticipantsobserver.md)                         |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [connectionStateObserver(room)](./core/connectionstateobserver.md)                                              |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [createActiveDeviceObservable(room, kind)](./core/createactivedeviceobservable.md)                              |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [createChatObserver(room)](./core/createchatobserver.md)                                                        |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [createConnectionQualityObserver(participant)](./core/createconnectionqualityobserver.md)                       |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [createDataObserver(room)](./core/createdataobserver.md)                                                        |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [createDefaultGrammar()](./core/createdefaultgrammar.md)                                                        |                                                                                                                                                                                                                                                                                                                                                                                                             |
@@ -58,6 +58,8 @@
 | [isSourceWitOptions(source)](./core/issourcewitoptions.md)                                                      |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [isTrackReferencePinned(trackReference, pinState)](./core/istrackreferencepinned.md)                            | Check if the <code>TrackReference</code> is pinned.                                                                                                                                                                                                                                                                                                                                                         |
 | [isTrackReferencePlaceholder(trackReference)](./core/istrackreferenceplaceholder.md)                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [LegacyChatMessage](./core/legacychatmessage.md)                                                                |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [LegacyReceivedChatMessage](./core/legacyreceivedchatmessage.md)                                                |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [loadUserChoices(defaults, preventLoad)](./core/loaduserchoices.md)                                             | Reads the user choices from local storage, or returns the default settings if none are found.                                                                                                                                                                                                                                                                                                               |
 | [LocalUserChoices](./core/localuserchoices.md)                                                                  | Represents the user's choices for video and audio input devices, as well as their username.                                                                                                                                                                                                                                                                                                                 |
 | [log](./core/log.md)                                                                                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
@@ -103,6 +105,7 @@
 | [setLogLevel(level, options)](./core/setloglevel.md)                                                            | Set the log level for both the <code>@livekit/components-react</code> package and the <code>@livekit-client</code> package. To set the <code>@livekit-client</code> log independently, use the <code>liveKitClientLogLevel</code> prop on the <code>options</code> object.                                                                                                                                  |
 | [SetMediaDeviceOptions](./core/setmediadeviceoptions.md)                                                        |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [setupChat(room, options)](./core/setupchat.md)                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [setupChatMessageHandler(room)](./core/setupchatmessagehandler.md)                                              |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [setupChatToggle()](./core/setupchattoggle.md)                                                                  |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [setupClearPinButton()](./core/setupclearpinbutton.md)                                                          |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [setupConnectionQualityIndicator(participant)](./core/setupconnectionqualityindicator.md)                       |                                                                                                                                                                                                                                                                                                                                                                                                             |

package/generated-docs/core/{chatmessage.id.md → legacychatmessage.ignore.md}

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

package/generated-docs/core/legacychatmessage.md

@@ -0,0 +1,24 @@
+---
+{
+  "title": "LegacyChatMessage interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/chat.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# LegacyChatMessage interface
+
+**Signature:**
+
+```typescript
+export interface LegacyChatMessage extends ChatMessage
+```
+
+**Extends:** ChatMessage
+
+## Properties
+
+| Property                                      | Type | Description  |
+| --------------------------------------------- | ---- | ------------ |
+| [ignore?](./core/legacychatmessage.ignore.md) | true | _(Optional)_ |

package/generated-docs/core/{chatmessage.message.md → legacyreceivedchatmessage.ignore.md}

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

package/generated-docs/core/legacyreceivedchatmessage.md

@@ -0,0 +1,24 @@
+---
+{
+  "title": "LegacyReceivedChatMessage interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/chat.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# LegacyReceivedChatMessage interface
+
+**Signature:**
+
+```typescript
+export interface LegacyReceivedChatMessage extends ReceivedChatMessage
+```
+
+**Extends:** [ReceivedChatMessage](./core/receivedchatmessage.md)
+
+## Properties
+
+| Property                                              | Type | Description  |
+| ----------------------------------------------------- | ---- | ------------ |
+| [ignore?](./core/legacyreceivedchatmessage.ignore.md) | true | _(Optional)_ |

package/generated-docs/core/messagedecoder.md

@@ -9,12 +9,20 @@
 
 # MessageDecoder type
 
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+the new chat API doesn't rely on encoders and decoders anymore and uses a dedicated chat API instead
+
+{% /callout %}
+
 **Signature:**
 
 ```typescript
-export type MessageDecoder = (message: Uint8Array) => ReceivedChatMessage;
+export type MessageDecoder = (message: Uint8Array) => LegacyReceivedChatMessage;
 ```
 
-**References:** [ReceivedChatMessage](./core/receivedchatmessage.md)
+**References:** [LegacyReceivedChatMessage](./core/legacyreceivedchatmessage.md)
 
 {% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/messageencoder.md

@@ -9,12 +9,20 @@
 
 # MessageEncoder type
 
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+the new chat API doesn't rely on encoders and decoders anymore and uses a dedicated chat API instead
+
+{% /callout %}
+
 **Signature:**
 
 ```typescript
-export type MessageEncoder = (message: ChatMessage) => Uint8Array;
+export type MessageEncoder = (message: LegacyChatMessage) => Uint8Array;
 ```
 
-**References:** [ChatMessage](./core/chatmessage.md)
+**References:** [LegacyChatMessage](./core/legacychatmessage.md)
 
 {% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/receivedchatmessage.md

@@ -15,13 +15,12 @@
 export interface ReceivedChatMessage extends ChatMessage
 ```
 
-**Extends:** [ChatMessage](./core/chatmessage.md)
+**Extends:** ChatMessage
 
 {% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 
-| Property                                                      | Type        | Description  |
-| ------------------------------------------------------------- | ----------- | ------------ |
-| [editTimestamp?](./core/receivedchatmessage.edittimestamp.md) | number      | _(Optional)_ |
-| [from?](./core/receivedchatmessage.from.md)                   | Participant | _(Optional)_ |
+| Property                                    | Type        | Description  |
+| ------------------------------------------- | ----------- | ------------ |
+| [from?](./core/receivedchatmessage.from.md) | Participant | _(Optional)_ |

package/generated-docs/core/setupchat.md

@@ -19,6 +19,14 @@ export declare function setupChat(
   messageObservable: import("rxjs").Observable<ReceivedChatMessage[]>;
   isSendingObservable: BehaviorSubject<boolean>;
   send: (message: string) => Promise<ChatMessage>;
-  update: (message: string, messageId: string) => Promise<ChatMessage>;
+  update: (
+    message: string,
+    originalMessageOrId: string | ChatMessage
+  ) => Promise<{
+    readonly message: string;
+    readonly editTimestamp: number;
+    readonly id: string;
+    readonly timestamp: number;
+  }>;
 };
 ```

package/generated-docs/core/setupchatmessagehandler.md

@@ -0,0 +1,33 @@
+---
+{
+  "title": "setupChatMessageHandler",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/dataChannel.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupChatMessageHandler
+
+**Signature:**
+
+```typescript
+export declare function setupChatMessageHandler(room: Room): {
+  chatObservable: Observable<
+    [
+      message: ChatMessage,
+      participant?: LocalParticipant | import("livekit-client").RemoteParticipant | undefined
+    ]
+  >;
+  send: (text: string) => Promise<ChatMessage>;
+  edit: (
+    text: string,
+    originalMsg: ChatMessage
+  ) => Promise<{
+    readonly message: string;
+    readonly editTimestamp: number;
+    readonly id: string;
+    readonly timestamp: number;
+  }>;
+};
+```

package/generated-docs/react/{voiceassistantstate.md → agentstate.md}

@@ -1,18 +1,20 @@
 ---
 {
-  "title": "VoiceAssistantState type",
+  "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. -->
 
-# VoiceAssistantState type
+# AgentState type
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 
 **Signature:**
 
 ```typescript
-export type VoiceAssistantState =
+export type AgentState =
   | "disconnected"
   | "connecting"
   | "initializing"

package/generated-docs/react/{chatmessage.id.md → allowmediaplaybackprops.label.md}

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

package/generated-docs/react/allowmediaplaybackprops.md

@@ -0,0 +1,26 @@
+---
+{
+  "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;
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+| Property                                           | Type   | Description  |
+| -------------------------------------------------- | ------ | ------------ |
+| [label?](./react/allowmediaplaybackprops.label.md) | string | _(Optional)_ |

package/generated-docs/react/barvisualizerprops.md

@@ -28,5 +28,5 @@ export interface BarVisualizerProps extends React.HTMLProps<HTMLDivElement>
 | [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)       | [VoiceAssistantState](./react/voiceassistantstate.md)                 | **_(BETA)_** _(Optional)_ If set, the visualizer will transition between different voice assistant states |
+| [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](./react/trackreferenceorplaceholder.md) | **_(BETA)_** _(Optional)_                                                                                 |

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

@@ -13,7 +13,7 @@ If set, the visualizer will transition between different voice assistant states
 **Signature:**
 
 ```typescript
-state?: VoiceAssistantState;
+state?: AgentState;
 ```
 
 {% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/component/barvisualizer.md

@@ -21,7 +21,7 @@ import { BarVisualizer } from "@livekit/components-react";
 
 ## Remarks
 
-For VoiceAssistant state transitions this component requires a voice assistant agent running with livekit-agents &gt;<!-- -->= 0.8.11
+For VoiceAssistant state transitions this component requires a voice assistant agent running with livekit-agents &gt;<!-- -->= 0.9.0
 
 ## Usage
 

package/generated-docs/react/component/controlbar.md

@@ -47,7 +47,7 @@ _(Optional)_
 {% /parameter %}
 
 {% parameter name="saveUserChoices" type="boolean" optional=true %}
-_(Optional)_ 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.
+_(Optional)_ If `true`<!-- -->, the user's device choices will be persisted. This will enable the user to have the same device choices when they rejoin the room.
 
 {% /parameter %}
 

package/generated-docs/react/component/participantloop.md

@@ -27,7 +27,7 @@ If you want to loop over individual tracks instead of participants, you can use
 const participants = useParticipants();
 <ParticipantLoop participants={participants}>
   <ParticipantName />
-<ParticipantLoop />
+</ParticipantLoop>;
 ```
 
 {% partial file="p_usage.md" variables={exampleCount: 1} /%}

package/generated-docs/react/component/prejoin.md

@@ -19,7 +19,7 @@ import { PreJoin } from "@livekit/components-react";
 
 ## Remarks
 
-This component is independent of the `LiveKitRoom` component and should not be nested within it. Because it only access the local media tracks this component is self contained and works without connection to the LiveKit server.
+This component is independent of the `LiveKitRoom` component and should not be nested within it. Because it only accesses the local media tracks this component is self-contained and works without connection to the LiveKit server.
 
 ## Usage
 

package/generated-docs/react/component/startmediabutton.md

@@ -0,0 +1,35 @@
+---
+{
+  "title": "StartMediaButton",
+  "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. -->
+
+# StartMediaButton
+
+The `StartMediaButton` component is only visible when the browser blocks media playback. This is due to some browser implemented autoplay policies. To start media playback, the user must perform a user-initiated event such as clicking this button. As soon as media playback starts, the button hides itself again.
+
+## Import
+
+```typescript
+import { StartMediaButton } from "@livekit/components-react";
+```
+
+## Usage
+
+```tsx
+<LiveKitRoom>
+  <StartMediaButton label="Click to allow media playback" />
+</LiveKitRoom>
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
+
+## Properties
+
+{% parameter name="label" type="string" optional=true %}
+_(Optional)_
+
+{% /parameter %}

package/generated-docs/react/component/trackloop.md

@@ -21,11 +21,11 @@ import { TrackLoop } from "@livekit/components-react";
 
 ```tsx
 const trackRefs = useTracks([Track.Source.Camera]);
-<TrackLoop tracks={trackRefs} >
- <TrackRefContext.Consumer>
-   {(trackRef) => trackRef && <VideoTrack trackRef={trackRef}/>}
- </TrackRefContext.Consumer>
-<TrackLoop />
+<TrackLoop tracks={trackRefs}>
+  <TrackRefContext.Consumer>
+    {(trackRef) => trackRef && <VideoTrack trackRef={trackRef} />}
+  </TrackRefContext.Consumer>
+</TrackLoop>;
 ```
 
 {% partial file="p_usage.md" variables={exampleCount: 1} /%}

package/generated-docs/react/component/videoconference.md

@@ -19,7 +19,7 @@ import { VideoConference } from "@livekit/components-react";
 
 ## Remarks
 
-The component is implemented with other LiveKit components like `FocusContextProvider`<!-- -->, `GridLayout`<!-- -->, `ControlBar`<!-- -->, `FocusLayoutContainer` and `FocusLayout`<!-- -->. You can use this components as a starting point for your own custom video conferencing application.
+The component is implemented with other LiveKit components like `FocusContextProvider`<!-- -->, `GridLayout`<!-- -->, `ControlBar`<!-- -->, `FocusLayoutContainer` and `FocusLayout`<!-- -->. You can use these components as a starting point for your own custom video conferencing application.
 
 ## Usage
 

package/generated-docs/react/component/voiceassistantcontrolbar.md

@@ -17,7 +17,15 @@
 import { VoiceAssistantControlBar } from "@livekit/components-react";
 ```
 
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+## Usage
+
+```tsx
+<LiveKitRoom ... >
+  <VoiceAssistantControlBar />
+</LiveKitRoom>
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 
 ## Properties
 
@@ -35,6 +43,6 @@ import { VoiceAssistantControlBar } from "@livekit/components-react";
 {% /parameter %}
 
 {% parameter name="saveUserChoices" type="boolean" optional=true %}
-_(Optional)_ 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.
+**_(BETA)_** _(Optional)_ 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.
 
 {% /parameter %}

package/generated-docs/react/controlbarprops.md

@@ -21,9 +21,9 @@ export interface ControlBarProps extends React.HTMLAttributes<HTMLDivElement>
 
 ## Properties
 
-| Property                                                       | Type                                                        | Description                                                                                                                                                           |
-| -------------------------------------------------------------- | ----------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [controls?](./react/controlbarprops.controls.md)               | [ControlBarControls](./react/controlbarcontrols.md)         | _(Optional)_                                                                                                                                                          |
-| [onDeviceError?](./react/controlbarprops.ondeviceerror.md)     | (error: { source: Track.Source; error: Error; }) =&gt; void | _(Optional)_                                                                                                                                                          |
-| [saveUserChoices?](./react/controlbarprops.saveuserchoices.md) | boolean                                                     | _(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. |
-| [variation?](./react/controlbarprops.variation.md)             | 'minimal' \| 'verbose' \| 'textOnly'                        | _(Optional)_                                                                                                                                                          |
+| Property                                                       | Type                                                        | Description                                                                                                                                                          |
+| -------------------------------------------------------------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [controls?](./react/controlbarprops.controls.md)               | [ControlBarControls](./react/controlbarcontrols.md)         | _(Optional)_                                                                                                                                                         |
+| [onDeviceError?](./react/controlbarprops.ondeviceerror.md)     | (error: { source: Track.Source; error: Error; }) =&gt; void | _(Optional)_                                                                                                                                                         |
+| [saveUserChoices?](./react/controlbarprops.saveuserchoices.md) | boolean                                                     | _(Optional)_ If <code>true</code>, the user's device choices will be persisted. This will enable the user to have the same device choices when they rejoin the room. |
+| [variation?](./react/controlbarprops.variation.md)             | 'minimal' \| 'verbose' \| 'textOnly'                        | _(Optional)_                                                                                                                                                         |

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

@@ -6,7 +6,7 @@
 
 # ControlBarProps.saveUserChoices property
 
-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.
+If `true`<!-- -->, the user's device choices will be persisted. This will enable the user to have the same device choices when they rejoin the room.
 
 **Signature:**
 

package/generated-docs/react/hook/usechat.md

@@ -17,10 +17,6 @@ The `useChat` hook provides chat functionality for a LiveKit room. It returns a
 import { useChat } from "@livekit/components-react";
 ```
 
-## Remarks
-
-It is possible to pass configurations for custom message encoding and decoding and non-default topics on which to send the messages.
-
 {% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
@@ -32,8 +28,13 @@ It is possible to pass configurations for custom message encoding and decoding a
 
 ```typescript
 {
-    send: (message: string) => Promise<import("@livekit/components-core").ChatMessage>;
-    update: (message: string, messageId: string) => Promise<import("@livekit/components-core").ChatMessage>;
+    send: (message: string) => Promise<import("livekit-client").ChatMessage>;
+    update: (message: string, originalMessageOrId: string | import("livekit-client").ChatMessage) => Promise<{
+        readonly message: string;
+        readonly editTimestamp: number;
+        readonly id: string;
+        readonly timestamp: number;
+    }>;
     chatMessages: ReceivedChatMessage[];
     isSending: boolean;
 }

package/generated-docs/react/hook/usevoiceassistant.md

@@ -9,7 +9,9 @@
 
 # useVoiceAssistant
 
-This hook looks for the first agent-participant in the room. It assumes that the agent participant is based on the LiveKit VoiceAssistant API and returns the most commonly used state vars when interacting with a VoiceAssistant.
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+
+This hook looks for the first agent-participant in the room.
 
 ## Import
 
@@ -19,9 +21,15 @@ import { useVoiceAssistant } from "@livekit/components-react";
 
 ## Remarks
 
-This hook requires a voice assistant agent running with livekit-agents &gt;<!-- -->= 0.8.11
+This hook requires an agent running with livekit-agents &gt;<!-- -->= 0.9.0
+
+## Usage
+
+```tsx
+const { state, audioTrack, agentTranscriptions, agentAttributes } = useVoiceAssistant();
+```
 
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 
 ## Returns