@livekit/components-js-docs 0.1.68 → 0.1.70

package/generated-docs/react/messagescallbacks.md

@@ -0,0 +1,26 @@
+---
+{
+  "title": "MessagesCallbacks type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useSessionMessages.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# MessagesCallbacks 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 MessagesCallbacks = {
+  [MessagesEvent.MessageReceived]: (message: ReceivedMessage) => void;
+};
+```
+
+**References:** [MessagesEvent.MessageReceived](./react/messagesevent.md)<!-- -->, [ReceivedMessage](./core/receivedmessage.md)

package/generated-docs/react/messagesevent.md

@@ -0,0 +1,28 @@
+---
+{
+  "title": "MessagesEvent enum",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useSessionMessages.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# MessagesEvent enum
+
+{% 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 declare enum MessagesEvent
+```
+
+## Enumeration Members
+
+| Member          | Value                                    | Description                                                                                           |
+| --------------- | ---------------------------------------- | ----------------------------------------------------------------------------------------------------- |
+| MessageReceived | <code>&quot;messageReceived&quot;</code> | **_(BETA)_** Emits when a new message is received from a participant args: (message: ReceivedMessage) |

package/generated-docs/react/meta-data.json

@@ -1 +1 @@
-{"components":[{"filename":"audioconference.md","title":"AudioConference"},{"filename":"audiotrack.md","title":"AudioTrack"},{"filename":"audiovisualizer.md","title":"AudioVisualizer"},{"filename":"barvisualizer.md","title":"BarVisualizer"},{"filename":"carousellayout.md","title":"CarouselLayout"},{"filename":"chat.md","title":"Chat"},{"filename":"chatentry.md","title":"ChatEntry"},{"filename":"chattoggle.md","title":"ChatToggle"},{"filename":"clearpinbutton.md","title":"ClearPinButton"},{"filename":"connectionqualityindicator.md","title":"ConnectionQualityIndicator"},{"filename":"connectionstate.md","title":"ConnectionState"},{"filename":"connectionstatetoast.md","title":"ConnectionStateToast"},{"filename":"controlbar.md","title":"ControlBar"},{"filename":"disconnectbutton.md","title":"DisconnectButton"},{"filename":"focuslayout.md","title":"FocusLayout"},{"filename":"focuslayoutcontainer.md","title":"FocusLayoutContainer"},{"filename":"focustoggle.md","title":"FocusToggle"},{"filename":"gridlayout.md","title":"GridLayout"},{"filename":"layoutcontext.md","title":"LayoutContext"},{"filename":"layoutcontextprovider.md","title":"LayoutContextProvider"},{"filename":"livekitroom.md","title":"LiveKitRoom"},{"filename":"mediadevicemenu.md","title":"MediaDeviceMenu"},{"filename":"mediadeviceselect.md","title":"MediaDeviceSelect"},{"filename":"participantaudiotile.md","title":"ParticipantAudioTile"},{"filename":"participantcontext.md","title":"ParticipantContext"},{"filename":"participantcontextifneeded.md","title":"ParticipantContextIfNeeded"},{"filename":"participantloop.md","title":"ParticipantLoop"},{"filename":"participantname.md","title":"ParticipantName"},{"filename":"participanttile.md","title":"ParticipantTile"},{"filename":"prejoin.md","title":"PreJoin"},{"filename":"roomaudiorenderer.md","title":"RoomAudioRenderer"},{"filename":"roomcontext.md","title":"RoomContext"},{"filename":"roomname.md","title":"RoomName"},{"filename":"startaudio.md","title":"StartAudio"},{"filename":"startmediabutton.md","title":"StartMediaButton"},{"filename":"toast.md","title":"Toast"},{"filename":"trackloop.md","title":"TrackLoop"},{"filename":"trackmutedindicator.md","title":"TrackMutedIndicator"},{"filename":"trackrefcontext.md","title":"TrackRefContext"},{"filename":"tracktoggle.md","title":"TrackToggle"},{"filename":"videoconference.md","title":"VideoConference"},{"filename":"videotrack.md","title":"VideoTrack"},{"filename":"voiceassistantcontrolbar.md","title":"VoiceAssistantControlBar"}],"hooks":[{"filename":"useaudioplayback.md","title":"useAudioPlayback"},{"filename":"useaudiowaveform.md","title":"useAudioWaveform"},{"filename":"usechat.md","title":"useChat"},{"filename":"usechattoggle.md","title":"useChatToggle"},{"filename":"useclearpinbutton.md","title":"useClearPinButton"},{"filename":"useconnectionqualityindicator.md","title":"useConnectionQualityIndicator"},{"filename":"useconnectionstate.md","title":"useConnectionState"},{"filename":"usecreatelayoutcontext.md","title":"useCreateLayoutContext"},{"filename":"usedatachannel.md","title":"useDataChannel"},{"filename":"usedisconnectbutton.md","title":"useDisconnectButton"},{"filename":"useensurecreatelayoutcontext.md","title":"useEnsureCreateLayoutContext"},{"filename":"useensurelayoutcontext.md","title":"useEnsureLayoutContext"},{"filename":"useensureparticipant.md","title":"useEnsureParticipant"},{"filename":"useensureroom.md","title":"useEnsureRoom"},{"filename":"useensuretrackref.md","title":"useEnsureTrackRef"},{"filename":"usefacingmode.md","title":"useFacingMode"},{"filename":"usefocustoggle.md","title":"useFocusToggle"},{"filename":"usegridlayout.md","title":"useGridLayout"},{"filename":"useisencrypted.md","title":"useIsEncrypted"},{"filename":"useismuted.md","title":"useIsMuted"},{"filename":"useisrecording.md","title":"useIsRecording"},{"filename":"useisspeaking.md","title":"useIsSpeaking"},{"filename":"usekrispnoisefilter.md","title":"useKrispNoiseFilter"},{"filename":"uselayoutcontext.md","title":"useLayoutContext"},{"filename":"uselivekitroom.md","title":"useLiveKitRoom"},{"filename":"uselocalparticipant.md","title":"useLocalParticipant"},{"filename":"uselocalparticipantpermissions.md","title":"useLocalParticipantPermissions"},{"filename":"usemaybelayoutcontext.md","title":"useMaybeLayoutContext"},{"filename":"usemaybeparticipantcontext.md","title":"useMaybeParticipantContext"},{"filename":"usemayberoomcontext.md","title":"useMaybeRoomContext"},{"filename":"usemaybetrackrefcontext.md","title":"useMaybeTrackRefContext"},{"filename":"usemediadevices.md","title":"useMediaDevices"},{"filename":"usemediadeviceselect.md","title":"useMediaDeviceSelect"},{"filename":"usemultibandtrackvolume.md","title":"useMultibandTrackVolume"},{"filename":"usepagination.md","title":"usePagination"},{"filename":"useparticipantattribute.md","title":"useParticipantAttribute"},{"filename":"useparticipantattributes.md","title":"useParticipantAttributes"},{"filename":"useparticipantcontext.md","title":"useParticipantContext"},{"filename":"useparticipantinfo.md","title":"useParticipantInfo"},{"filename":"useparticipantpermissions.md","title":"useParticipantPermissions"},{"filename":"useparticipants.md","title":"useParticipants"},{"filename":"useparticipanttile.md","title":"useParticipantTile"},{"filename":"useparticipanttracks.md","title":"useParticipantTracks"},{"filename":"usepersistentuserchoices.md","title":"usePersistentUserChoices"},{"filename":"usepinnedtracks.md","title":"usePinnedTracks"},{"filename":"usepreviewdevice.md","title":"usePreviewDevice"},{"filename":"usepreviewtracks.md","title":"usePreviewTracks"},{"filename":"useremoteparticipant.md","title":"useRemoteParticipant"},{"filename":"useremoteparticipants.md","title":"useRemoteParticipants"},{"filename":"useroomcontext.md","title":"useRoomContext"},{"filename":"useroominfo.md","title":"useRoomInfo"},{"filename":"usesequentialroomconnectdisconnect.md","title":"useSequentialRoomConnectDisconnect"},{"filename":"usesortedparticipants.md","title":"useSortedParticipants"},{"filename":"usespeakingparticipants.md","title":"useSpeakingParticipants"},{"filename":"usestartaudio.md","title":"useStartAudio"},{"filename":"usestartvideo.md","title":"useStartVideo"},{"filename":"useswipe.md","title":"useSwipe"},{"filename":"usetextstream.md","title":"useTextStream"},{"filename":"usetoken.md","title":"useToken"},{"filename":"usetrackbyname.md","title":"useTrackByName"},{"filename":"usetrackmutedindicator.md","title":"useTrackMutedIndicator"},{"filename":"usetrackrefcontext.md","title":"useTrackRefContext"},{"filename":"usetracks.md","title":"useTracks"},{"filename":"usetracktoggle.md","title":"useTrackToggle"},{"filename":"usetracktranscription.md","title":"useTrackTranscription"},{"filename":"usetrackvolume.md","title":"useTrackVolume"},{"filename":"usetranscriptions.md","title":"useTranscriptions"},{"filename":"usevisualstableupdate.md","title":"useVisualStableUpdate"},{"filename":"usevoiceassistant.md","title":"useVoiceAssistant"}]}
+{"components":[{"filename":"audioconference.md","title":"AudioConference"},{"filename":"audiotrack.md","title":"AudioTrack"},{"filename":"audiovisualizer.md","title":"AudioVisualizer"},{"filename":"barvisualizer.md","title":"BarVisualizer"},{"filename":"carousellayout.md","title":"CarouselLayout"},{"filename":"chat.md","title":"Chat"},{"filename":"chatentry.md","title":"ChatEntry"},{"filename":"chattoggle.md","title":"ChatToggle"},{"filename":"clearpinbutton.md","title":"ClearPinButton"},{"filename":"connectionqualityindicator.md","title":"ConnectionQualityIndicator"},{"filename":"connectionstate.md","title":"ConnectionState"},{"filename":"connectionstatetoast.md","title":"ConnectionStateToast"},{"filename":"controlbar.md","title":"ControlBar"},{"filename":"disconnectbutton.md","title":"DisconnectButton"},{"filename":"focuslayout.md","title":"FocusLayout"},{"filename":"focuslayoutcontainer.md","title":"FocusLayoutContainer"},{"filename":"focustoggle.md","title":"FocusToggle"},{"filename":"gridlayout.md","title":"GridLayout"},{"filename":"layoutcontext.md","title":"LayoutContext"},{"filename":"layoutcontextprovider.md","title":"LayoutContextProvider"},{"filename":"livekitroom.md","title":"LiveKitRoom"},{"filename":"mediadevicemenu.md","title":"MediaDeviceMenu"},{"filename":"mediadeviceselect.md","title":"MediaDeviceSelect"},{"filename":"participantaudiotile.md","title":"ParticipantAudioTile"},{"filename":"participantcontext.md","title":"ParticipantContext"},{"filename":"participantcontextifneeded.md","title":"ParticipantContextIfNeeded"},{"filename":"participantloop.md","title":"ParticipantLoop"},{"filename":"participantname.md","title":"ParticipantName"},{"filename":"participanttile.md","title":"ParticipantTile"},{"filename":"prejoin.md","title":"PreJoin"},{"filename":"roomaudiorenderer.md","title":"RoomAudioRenderer"},{"filename":"roomcontext.md","title":"RoomContext"},{"filename":"roomname.md","title":"RoomName"},{"filename":"sessionprovider.md","title":"SessionProvider"},{"filename":"startaudio.md","title":"StartAudio"},{"filename":"startmediabutton.md","title":"StartMediaButton"},{"filename":"toast.md","title":"Toast"},{"filename":"trackloop.md","title":"TrackLoop"},{"filename":"trackmutedindicator.md","title":"TrackMutedIndicator"},{"filename":"trackrefcontext.md","title":"TrackRefContext"},{"filename":"tracktoggle.md","title":"TrackToggle"},{"filename":"videoconference.md","title":"VideoConference"},{"filename":"videotrack.md","title":"VideoTrack"},{"filename":"voiceassistantcontrolbar.md","title":"VoiceAssistantControlBar"}],"hooks":[{"filename":"useagent.md","title":"useAgent"},{"filename":"useaudioplayback.md","title":"useAudioPlayback"},{"filename":"useaudiowaveform.md","title":"useAudioWaveform"},{"filename":"usechat.md","title":"useChat"},{"filename":"usechattoggle.md","title":"useChatToggle"},{"filename":"useclearpinbutton.md","title":"useClearPinButton"},{"filename":"useconnectionqualityindicator.md","title":"useConnectionQualityIndicator"},{"filename":"useconnectionstate.md","title":"useConnectionState"},{"filename":"usecreatelayoutcontext.md","title":"useCreateLayoutContext"},{"filename":"usedatachannel.md","title":"useDataChannel"},{"filename":"usedisconnectbutton.md","title":"useDisconnectButton"},{"filename":"useensurecreatelayoutcontext.md","title":"useEnsureCreateLayoutContext"},{"filename":"useensurelayoutcontext.md","title":"useEnsureLayoutContext"},{"filename":"useensureparticipant.md","title":"useEnsureParticipant"},{"filename":"useensureroom.md","title":"useEnsureRoom"},{"filename":"useensuresession.md","title":"useEnsureSession"},{"filename":"useensuretrackref.md","title":"useEnsureTrackRef"},{"filename":"useevents.md","title":"useEvents"},{"filename":"usefacingmode.md","title":"useFacingMode"},{"filename":"usefocustoggle.md","title":"useFocusToggle"},{"filename":"usegridlayout.md","title":"useGridLayout"},{"filename":"useisencrypted.md","title":"useIsEncrypted"},{"filename":"useismuted.md","title":"useIsMuted"},{"filename":"useisrecording.md","title":"useIsRecording"},{"filename":"useisspeaking.md","title":"useIsSpeaking"},{"filename":"usekrispnoisefilter.md","title":"useKrispNoiseFilter"},{"filename":"uselayoutcontext.md","title":"useLayoutContext"},{"filename":"uselivekitroom.md","title":"useLiveKitRoom"},{"filename":"uselocalparticipant.md","title":"useLocalParticipant"},{"filename":"uselocalparticipantpermissions.md","title":"useLocalParticipantPermissions"},{"filename":"usemaybelayoutcontext.md","title":"useMaybeLayoutContext"},{"filename":"usemaybeparticipantcontext.md","title":"useMaybeParticipantContext"},{"filename":"usemayberoomcontext.md","title":"useMaybeRoomContext"},{"filename":"usemaybesessioncontext.md","title":"useMaybeSessionContext"},{"filename":"usemaybetrackrefcontext.md","title":"useMaybeTrackRefContext"},{"filename":"usemediadevices.md","title":"useMediaDevices"},{"filename":"usemediadeviceselect.md","title":"useMediaDeviceSelect"},{"filename":"usemultibandtrackvolume.md","title":"useMultibandTrackVolume"},{"filename":"usepagination.md","title":"usePagination"},{"filename":"useparticipantattribute.md","title":"useParticipantAttribute"},{"filename":"useparticipantattributes.md","title":"useParticipantAttributes"},{"filename":"useparticipantcontext.md","title":"useParticipantContext"},{"filename":"useparticipantinfo.md","title":"useParticipantInfo"},{"filename":"useparticipantpermissions.md","title":"useParticipantPermissions"},{"filename":"useparticipants.md","title":"useParticipants"},{"filename":"useparticipanttile.md","title":"useParticipantTile"},{"filename":"useparticipanttracks.md","title":"useParticipantTracks"},{"filename":"usepersistentuserchoices.md","title":"usePersistentUserChoices"},{"filename":"usepinnedtracks.md","title":"usePinnedTracks"},{"filename":"usepreviewdevice.md","title":"usePreviewDevice"},{"filename":"usepreviewtracks.md","title":"usePreviewTracks"},{"filename":"useremoteparticipant.md","title":"useRemoteParticipant"},{"filename":"useremoteparticipants.md","title":"useRemoteParticipants"},{"filename":"useroomcontext.md","title":"useRoomContext"},{"filename":"useroominfo.md","title":"useRoomInfo"},{"filename":"usesequentialroomconnectdisconnect.md","title":"useSequentialRoomConnectDisconnect"},{"filename":"usesession.md","title":"useSession"},{"filename":"usesessioncontext.md","title":"useSessionContext"},{"filename":"usesessionmessages.md","title":"useSessionMessages"},{"filename":"usesortedparticipants.md","title":"useSortedParticipants"},{"filename":"usespeakingparticipants.md","title":"useSpeakingParticipants"},{"filename":"usestartaudio.md","title":"useStartAudio"},{"filename":"usestartvideo.md","title":"useStartVideo"},{"filename":"useswipe.md","title":"useSwipe"},{"filename":"usetextstream.md","title":"useTextStream"},{"filename":"usetoken.md","title":"useToken"},{"filename":"usetrackbyname.md","title":"useTrackByName"},{"filename":"usetrackmutedindicator.md","title":"useTrackMutedIndicator"},{"filename":"usetrackrefcontext.md","title":"useTrackRefContext"},{"filename":"usetracks.md","title":"useTracks"},{"filename":"usetracktoggle.md","title":"useTrackToggle"},{"filename":"usetracktranscription.md","title":"useTrackTranscription"},{"filename":"usetrackvolume.md","title":"useTrackVolume"},{"filename":"usetranscriptions.md","title":"useTranscriptions"},{"filename":"usevisualstableupdate.md","title":"useVisualStableUpdate"},{"filename":"usevoiceassistant.md","title":"useVoiceAssistant"}]}

package/generated-docs/react/roomaudiorendererprops.md

@@ -20,4 +20,5 @@ export interface RoomAudioRendererProps
 | Property                                            | Type    | Description                                                                                                                                           |
 | --------------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
 | [muted?](./react/roomaudiorendererprops.muted.md)   | boolean | _(Optional)_ If set to <code>true</code>, mutes all audio tracks rendered by the component.                                                           |
+| [room?](./react/roomaudiorendererprops.room.md)     | Room    | _(Optional)_                                                                                                                                          |
 | [volume?](./react/roomaudiorendererprops.volume.md) | number  | _(Optional)_ Sets the volume for all audio tracks rendered by this component. By default, the range is between <code>0.0</code> and <code>1.0</code>. |

package/generated-docs/{core/receivedchatmessage.from.md → react/roomaudiorendererprops.room.md}

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

package/generated-docs/react/sessioncallbacks.md

@@ -0,0 +1,28 @@
+---
+{
+  "title": "SessionCallbacks type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useSession.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# SessionCallbacks 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 SessionCallbacks = {
+  [SessionEvent.ConnectionStateChanged]: (newAgentConnectionState: ConnectionState) => void;
+  [SessionEvent.MediaDevicesError]: (error: Error) => void;
+  [SessionEvent.EncryptionError]: (error: Error) => void;
+};
+```
+
+**References:** [SessionEvent.ConnectionStateChanged](./react/sessionevent.md)<!-- -->, [SessionEvent.MediaDevicesError](./react/sessionevent.md)<!-- -->, [SessionEvent.EncryptionError](./react/sessionevent.md)

package/generated-docs/react/sessionconnectoptions.md

@@ -0,0 +1,31 @@
+---
+{
+  "title": "SessionConnectOptions type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useSession.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# SessionConnectOptions 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 SessionConnectOptions = {
+  signal?: AbortSignal;
+  tracks?: {
+    microphone?: {
+      enabled?: boolean;
+      publishOptions?: TrackPublishOptions;
+    };
+  };
+  roomConnectOptions?: RoomConnectOptions;
+};
+```

package/generated-docs/react/sessionevent.md

@@ -0,0 +1,30 @@
+---
+{
+  "title": "SessionEvent enum",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useSession.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# SessionEvent enum
+
+{% 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 declare enum SessionEvent
+```
+
+## Enumeration Members
+
+| Member                 | Value                                           | Description                                                                                                                                                                                            |
+| ---------------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| ConnectionStateChanged | <code>&quot;connectionStateChanged&quot;</code> | **_(BETA)_**                                                                                                                                                                                           |
+| EncryptionError        | <code>&quot;encryptionError&quot;</code>        | **_(BETA)_** Emits when an error is received while decrypting frame received frame information. args: (error: Error)                                                                                   |
+| MediaDevicesError      | <code>&quot;mediaDevicesError&quot;</code>      | **_(BETA)_** Emits when an error is encountered while attempting to create a track. Use MediaDeviceFailure.getFailure(error) to get the reason of failure. args: (error: Error, kind: MediaDeviceKind) |

package/generated-docs/react/sessionproviderprops.md

@@ -0,0 +1,27 @@
+---
+{
+  "title": "SessionProviderProps type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/SessionProvider.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# SessionProviderProps 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 SessionProviderProps = {
+  session: UseSessionReturn;
+  children: React.ReactNode;
+};
+```
+
+**References:** [UseSessionReturn](./react/usesessionreturn.md)

package/generated-docs/react/switchactivedeviceoptions.md

@@ -0,0 +1,24 @@
+---
+{
+  "title": "SwitchActiveDeviceOptions type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useSession.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# SwitchActiveDeviceOptions 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 SwitchActiveDeviceOptions = {
+  exact?: boolean;
+};
+```

package/generated-docs/react/useagentreturn.md

@@ -0,0 +1,22 @@
+---
+{
+  "title": "UseAgentReturn type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useAgent.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseAgentReturn 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 UseAgentReturn = AgentStateCases & AgentActions;
+```

package/generated-docs/react/usesessionmessagesreturn.md

@@ -0,0 +1,31 @@
+---
+{
+  "title": "UseSessionMessagesReturn type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useSessionMessages.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseSessionMessagesReturn 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 UseSessionMessagesReturn = {
+  messages: Array<ReceivedMessage>;
+  isSending: boolean;
+  send: (message: string, options?: SendTextOptions) => Promise<ReceivedChatMessage>;
+  internal: {
+    emitter: TypedEventEmitter<MessagesCallbacks>;
+  };
+};
+```
+
+**References:** [ReceivedMessage](./core/receivedmessage.md)<!-- -->, [ReceivedChatMessage](./core/receivedchatmessage.md)<!-- -->, [MessagesCallbacks](./react/messagescallbacks.md)

package/generated-docs/react/usesessionreturn.md

@@ -0,0 +1,27 @@
+---
+{
+  "title": "UseSessionReturn type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useSession.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseSessionReturn 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 UseSessionReturn = (
+  | SessionStateConnecting
+  | SessionStateConnected
+  | SessionStateDisconnected
+) &
+  SessionActions;
+```

package/generated-docs/react/usespeakingparticipantsoptions.md

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

package/generated-docs/react/usetextstreamoptions.md

@@ -0,0 +1,24 @@
+---
+{
+  "title": "UseTextStreamOptions type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTextStream.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# UseTextStreamOptions 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 UseTextStreamOptions = {
+  room?: Room;
+};
+```

package/generated-docs/react/usetracktoggleprops.md

@@ -16,3 +16,9 @@ export interface UseTrackToggleProps<T extends ToggleSource> extends Omit<TrackT
 ```
 
 **Extends:** Omit&lt;[TrackToggleProps](./react/tracktoggleprops.md)<!-- -->&lt;T&gt;, 'showIcon'&gt;
+
+## Properties
+
+| Property                                     | Type | Description  |
+| -------------------------------------------- | ---- | ------------ |
+| [room?](./react/usetracktoggleprops.room.md) | Room | _(Optional)_ |

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

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

package/generated-docs/react/usetranscriptionsoptions.md

@@ -26,4 +26,5 @@ export interface UseTranscriptionsOptions
 | Property                                                                            | Type       | Description               |
 | ----------------------------------------------------------------------------------- | ---------- | ------------------------- |
 | [participantIdentities?](./react/usetranscriptionsoptions.participantidentities.md) | string\[\] | **_(BETA)_** _(Optional)_ |
+| [room?](./react/usetranscriptionsoptions.room.md)                                   | Room       | **_(BETA)_** _(Optional)_ |
 | [trackSids?](./react/usetranscriptionsoptions.tracksids.md)                         | string\[\] | **_(BETA)_** _(Optional)_ |

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@livekit/components-js-docs",
-  "version": "0.1.68",
+  "version": "0.1.70",
   "description": "Automatically generated documentation pages for LiveKit Components JS. Intended to be consumed by the documentation page.",
   "repository": {
     "type": "git",
@@ -8,7 +8,7 @@
     "directory": "/docs/beta-docs"
   },
   "dependencies": {
-    "@livekit/components-react": "2.9.15"
+    "@livekit/components-react": "2.9.17"
   },
   "author": "",
   "license": "Apache-2.0",
@@ -19,5 +19,8 @@
   "files": [
     "generated-docs",
     "meta-data.json"
-  ]
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
 }

package/generated-docs/core/receivedchatmessage.attributes.md

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