@livekit/components-js-docs 0.1.68 → 0.1.69

package/generated-docs/react/index.md

@@ -35,9 +35,10 @@
 | [ParticipantLoop({ participants, ...props })](./react/component/participantloop.md)                                    | The <code>ParticipantLoop</code> component loops over an array of participants to create a context for every participant. This component takes exactly one child component as a template. By providing your own template as a child you have full control over the look and feel of your participant representations.               |
 | [ParticipantName(props)](./react/component/participantname.md)                                                         | The <code>ParticipantName</code> component displays the name of the participant as a string within an HTML span element. If no participant name is undefined the participant identity string is displayed.                                                                                                                          |
 | [ParticipantTile(props)](./react/component/participanttile.md)                                                         | The <code>ParticipantTile</code> component is the base utility wrapper for displaying a visual representation of a participant. This component can be used as a child of the <code>TrackLoop</code> component or by passing a track reference as property.                                                                          |
-| [RoomAudioRenderer({ volume, muted })](./react/component/roomaudiorenderer.md)                                         | The <code>RoomAudioRenderer</code> component is a drop-in solution for adding audio to your LiveKit app. It takes care of handling remote participants’ audio tracks and makes sure that microphones and screen share are audible.                                                                                                  |
+| [RoomAudioRenderer({ room, volume, muted })](./react/component/roomaudiorenderer.md)                                   | The <code>RoomAudioRenderer</code> component is a drop-in solution for adding audio to your LiveKit app. It takes care of handling remote participants’ audio tracks and makes sure that microphones and screen share are audible.                                                                                                  |
 | [RoomContext](./react/component/roomcontext.md)                                                                        |                                                                                                                                                                                                                                                                                                                                     |
 | [RoomName](./react/component/roomname.md)                                                                              | The <code>RoomName</code> component renders the name of the connected LiveKit room inside a span tag.                                                                                                                                                                                                                               |
+| [SessionProvider(props)](./react/component/sessionprovider.md)                                                         | **_(BETA)_** The <code>SessionProvider</code> component instantiates a SessionContext from the return of useSession                                                                                                                                                                                                                 |
 | [StartAudio(props)](./react/component/startaudio.md)                                                                   | The <code>StartAudio</code> component is only visible when the browser blocks audio playback. This is due to some browser implemented autoplay policies. To start audio playback, the user must perform a user-initiated event such as clicking this button. As soon as audio playback starts, the button hides itself again.       |
 | [StartMediaButton(props)](./react/component/startmediabutton.md)                                                       | The <code>StartMediaButton</code> 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. |
 | [Toast(props)](./react/component/toast.md)                                                                             | The <code>Toast</code> component is a rudimentary way to display a message to the user. This message should be short lived and not require user interaction. For example, displaying the current connection state like <code>ConnectionStateToast</code> does.                                                                      |
@@ -61,156 +62,178 @@
 
 ## Hooks
 
-| Hook                                                                                                                                         | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
-| -------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [useAudioPlayback(room)](./react/hook/useaudioplayback.md)                                                                                   | In many browsers to start audio playback, the user must perform a user-initiated event such as clicking a button. The <code>useAudioPlayback</code> hook returns an object with a boolean <code>canPlayAudio</code> flag that indicates whether audio playback is allowed in the current context, as well as a <code>startAudio</code> function that can be called in a button <code>onClick</code> callback to start audio playback in the current context.                |
-| [useAudioWaveform(trackOrTrackReference, options)](./react/hook/useaudiowaveform.md)                                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [useChat(options)](./react/hook/usechat.md)                                                                                                  | The <code>useChat</code> hook provides chat functionality for a LiveKit room.                                                                                                                                                                                                                                                                                                                                                                                               |
-| [useChatToggle({ props })](./react/hook/usechattoggle.md)                                                                                    | The <code>useChatToggle</code> hook provides state and functions for toggling the chat window.                                                                                                                                                                                                                                                                                                                                                                              |
-| [useClearPinButton(props)](./react/hook/useclearpinbutton.md)                                                                                | The <code>useClearPinButton</code> hook provides props for the [ClearPinButton()](./react/component/clearpinbutton.md) or your custom implementation of it component. It adds the <code>onClick</code> handler to signal the <code>LayoutContext</code> that the tile in focus should be cleared.                                                                                                                                                                           |
-| [useConnectionQualityIndicator(options)](./react/hook/useconnectionqualityindicator.md)                                                      | The <code>useConnectionQualityIndicator</code> hook provides props for the <code>ConnectionQualityIndicator</code> or your custom implementation of it component.                                                                                                                                                                                                                                                                                                           |
-| [useConnectionState(room)](./react/hook/useconnectionstate.md)                                                                               | The <code>useConnectionState</code> hook allows you to simply implement your own <code>ConnectionState</code> component.                                                                                                                                                                                                                                                                                                                                                    |
-| [useCreateLayoutContext()](./react/hook/usecreatelayoutcontext.md)                                                                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [useDataChannel(topic, onMessage)](./react/hook/usedatachannel.md)                                                                           | The <code>useDataChannel</code> hook returns the ability to send and receive messages. Pass an optional <code>topic</code> to narrow down which messages are returned in the messages array.                                                                                                                                                                                                                                                                                |
-| [useDataChannel(onMessage)](./react/hook/usedatachannel_1.md)                                                                                | Overload for <code>useDataChannel</code> without a topic. See [useDataChannel()](./react/hook/usedatachannel.md) for information and usage examples.                                                                                                                                                                                                                                                                                                                        |
-| [useDisconnectButton(props)](./react/hook/usedisconnectbutton.md)                                                                            | The <code>useDisconnectButton</code> hook is used to implement the <code>DisconnectButton</code> or your custom implementation of it. It adds onClick handler to the button to disconnect from the room.                                                                                                                                                                                                                                                                    |
-| [useEnsureCreateLayoutContext(layoutContext)](./react/hook/useensurecreatelayoutcontext.md)                                                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [useEnsureLayoutContext(layoutContext)](./react/hook/useensurelayoutcontext.md)                                                              | Ensures that a layout context is provided, either via context or explicitly as a parameter. If not inside a <code>LayoutContext</code> and no layout context is provided, an error is thrown.                                                                                                                                                                                                                                                                               |
-| [useEnsureParticipant(participant)](./react/hook/useensureparticipant.md)                                                                    | Ensures that a participant is provided, either via context or explicitly as a parameter. If not inside a <code>ParticipantContext</code> and no participant is provided, an error is thrown.                                                                                                                                                                                                                                                                                |
-| [useEnsureRoom(room)](./react/hook/useensureroom.md)                                                                                         | Ensures that a room is provided, either via context or explicitly as a parameter. If no room is provided, an error is thrown.                                                                                                                                                                                                                                                                                                                                               |
-| [useEnsureTrackRef(trackRef)](./react/hook/useensuretrackref.md)                                                                             | Ensures that a track reference is provided, either via context or explicitly as a parameter. If not inside a <code>TrackRefContext</code> and no track reference is provided, an error is thrown.                                                                                                                                                                                                                                                                           |
-| [useFacingMode(trackReference)](./react/hook/usefacingmode.md)                                                                               | Try to determine the <code>facingMode</code> of a local participant video track.                                                                                                                                                                                                                                                                                                                                                                                            |
-| [useFocusToggle({ trackRef, props })](./react/hook/usefocustoggle.md)                                                                        | The <code>useFocusToggle</code> hook is used to implement the <code>FocusToggle</code> or your custom implementation of it. The <code>TrackReferenceOrPlaceholder</code> is used to register a onClick handler and to identify the track to focus on.                                                                                                                                                                                                                       |
-| [useGridLayout(gridElement, trackCount, options)](./react/hook/usegridlayout.md)                                                             | The <code>useGridLayout</code> hook tries to select the best layout to fit all tiles. If the available screen space is not enough, it will reduce the number of maximum visible tiles and select a layout that still works visually within the given limitations. As the order of tiles changes over time, the hook tries to keep visual updates to a minimum while trying to display important tiles such as speaking participants or screen shares.                       |
-| [useIsEncrypted(participant, options)](./react/hook/useisencrypted.md)                                                                       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [useIsMuted(trackRef)](./react/hook/useismuted.md)                                                                                           | The <code>useIsMuted</code> hook is used to implement the <code>TrackMutedIndicator</code> or your custom implementation of it. It returns a <code>boolean</code> that indicates if the track is muted or not.                                                                                                                                                                                                                                                              |
-| [useIsRecording(room)](./react/hook/useisrecording.md)                                                                                       | The <code>useIsRecording</code> hook returns a <code>boolean</code> that indicates if the room is currently being recorded.                                                                                                                                                                                                                                                                                                                                                 |
-| [useIsSpeaking(participant)](./react/hook/useisspeaking.md)                                                                                  | The <code>useIsSpeaking</code> hook returns a <code>boolean</code> that indicates if the participant is speaking or not.                                                                                                                                                                                                                                                                                                                                                    |
-| [useKrispNoiseFilter(options)](./react/hook/usekrispnoisefilter.md)                                                                          | <p>**_(BETA)_** Enable the Krisp enhanced noise cancellation feature for local audio tracks.</p><p>Defaults to the localParticipant's microphone track publication, but you can override this behavior by passing in a different track reference.</p>                                                                                                                                                                                                                       |
-| [useLayoutContext()](./react/hook/uselayoutcontext.md)                                                                                       | Ensures that a layout context is provided via context. If no layout context is provided, an error is thrown.                                                                                                                                                                                                                                                                                                                                                                |
-| [useLiveKitRoom(props)](./react/hook/uselivekitroom.md)                                                                                      | The <code>useLiveKitRoom</code> hook is used to implement the <code>LiveKitRoom</code> or your custom implementation of it. It returns a <code>Room</code> instance and HTML props that should be applied to the root element of the component.                                                                                                                                                                                                                             |
-| [useLocalParticipant(options)](./react/hook/uselocalparticipant.md)                                                                          | The <code>useLocalParticipant</code> hook returns the local participant and the associated state around the participant.                                                                                                                                                                                                                                                                                                                                                    |
-| [useLocalParticipantPermissions()](./react/hook/uselocalparticipantpermissions.md)                                                           | The <code>useLocalParticipantPermissions</code> hook returns the local participant's permissions.                                                                                                                                                                                                                                                                                                                                                                           |
-| [useMaybeLayoutContext()](./react/hook/usemaybelayoutcontext.md)                                                                             | Returns a layout context from the <code>LayoutContext</code> if it exists, otherwise <code>undefined</code>.                                                                                                                                                                                                                                                                                                                                                                |
-| [useMaybeParticipantContext()](./react/hook/usemaybeparticipantcontext.md)                                                                   | Returns a participant from the <code>ParticipantContext</code> if it exists, otherwise <code>undefined</code>.                                                                                                                                                                                                                                                                                                                                                              |
-| [useMaybeRoomContext()](./react/hook/usemayberoomcontext.md)                                                                                 | Returns the room context if it exists, otherwise undefined.                                                                                                                                                                                                                                                                                                                                                                                                                 |
-| [useMaybeTrackRefContext()](./react/hook/usemaybetrackrefcontext.md)                                                                         | Returns a track reference from the <code>TrackRefContext</code> if it exists, otherwise <code>undefined</code>.                                                                                                                                                                                                                                                                                                                                                             |
-| [useMediaDevices({ kind, onError, })](./react/hook/usemediadevices.md)                                                                       | The <code>useMediaDevices</code> hook returns the list of media devices of a given kind.                                                                                                                                                                                                                                                                                                                                                                                    |
-| [useMediaDeviceSelect({ kind, room, track, requestPermissions, onError, })](./react/hook/usemediadeviceselect.md)                            | The <code>useMediaDeviceSelect</code> hook is used to implement the <code>MediaDeviceSelect</code> component and returns o.a. the list of devices of a given kind (audioinput or videoinput), the currently active device and a function to set the the active device.                                                                                                                                                                                                      |
-| [useMultibandTrackVolume(trackOrTrackReference, options)](./react/hook/usemultibandtrackvolume.md)                                           | Hook for tracking the volume of an audio track across multiple frequency bands using the Web Audio API.                                                                                                                                                                                                                                                                                                                                                                     |
-| [usePagination(itemPerPage, trackReferences)](./react/hook/usepagination.md)                                                                 | The <code>usePagination</code> hook implements simple pagination logic for use with arrays.                                                                                                                                                                                                                                                                                                                                                                                 |
-| [useParticipantAttribute(attributeKey, options)](./react/hook/useparticipantattribute.md)                                                    | The <code>useParticipantAttribute</code> hook returns the latest value of a given attribute key of a participant. It requires a <code>Participant</code> object passed as property in the <code>UseParticipantAttributesOptions</code> or via the <code>ParticipantContext</code>.                                                                                                                                                                                          |
-| [useParticipantAttributes(props)](./react/hook/useparticipantattributes.md)                                                                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [useParticipantContext()](./react/hook/useparticipantcontext.md)                                                                             | Ensures that a participant is provided via context. If not inside a <code>ParticipantContext</code>, an error is thrown.                                                                                                                                                                                                                                                                                                                                                    |
-| [useParticipantInfo(props)](./react/hook/useparticipantinfo.md)                                                                              |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [useParticipantPermissions(options)](./react/hook/useparticipantpermissions.md)                                                              |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [useParticipants(options)](./react/hook/useparticipants.md)                                                                                  | The <code>useParticipants</code> hook returns all participants (local and remote) of the current room.                                                                                                                                                                                                                                                                                                                                                                      |
-| [useParticipantTile({ trackRef, onParticipantClick, disableSpeakingIndicator, htmlProps, })](./react/hook/useparticipanttile.md)             | The <code>useParticipantTile</code> hook is used to implement the <code>ParticipantTile</code> and returns the props needed to render the tile.                                                                                                                                                                                                                                                                                                                             |
-| [useParticipantTracks(sources, participantIdentity)](./react/hook/useparticipanttracks.md)                                                   | <code>useParticipantTracks</code> is a custom React that allows you to get tracks of a specific participant only, by specifiying the participant's identity. If the participant identity is not passed the hook will try to get the participant from a participant context.                                                                                                                                                                                                 |
-| [usePersistentUserChoices(options)](./react/hook/usepersistentuserchoices.md)                                                                | A hook that provides access to user choices stored in local storage, such as selected media devices and their current state (on or off), as well as the user name.                                                                                                                                                                                                                                                                                                          |
-| [usePinnedTracks(layoutContext)](./react/hook/usepinnedtracks.md)                                                                            | The <code>usePinnedTracks</code> hook returns a array of the pinned tracks of the current room.                                                                                                                                                                                                                                                                                                                                                                             |
-| [usePreviewDevice(enabled, deviceId, kind)](./react/hook/usepreviewdevice.md)                                                                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [usePreviewTracks(options, onError)](./react/hook/usepreviewtracks.md)                                                                       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [useRemoteParticipant(identifier, options)](./react/hook/useremoteparticipant.md)                                                            | The <code>useRemoteParticipant</code> hook returns the first RemoteParticipant by either identity and/or based on the participant kind.                                                                                                                                                                                                                                                                                                                                     |
-| [useRemoteParticipant(identity, options)](./react/hook/useremoteparticipant_1.md)                                                            | The <code>useRemoteParticipant</code> hook returns the first RemoteParticipant by either identity or based on the participant kind.                                                                                                                                                                                                                                                                                                                                         |
-| [useRemoteParticipants(options)](./react/hook/useremoteparticipants.md)                                                                      | The <code>useRemoteParticipants</code> hook returns all remote participants (without the local) of the current room.                                                                                                                                                                                                                                                                                                                                                        |
-| [useRoomContext()](./react/hook/useroomcontext.md)                                                                                           | Ensures that a room is provided via context. If no room is provided, an error is thrown.                                                                                                                                                                                                                                                                                                                                                                                    |
-| [useRoomInfo(options)](./react/hook/useroominfo.md)                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [useSequentialRoomConnectDisconnect(room)](./react/hook/usesequentialroomconnectdisconnect.md)                                               | When calling room.disconnect() as part of a React useEffect cleanup function, it is possible for a room.connect(...) in the effect body to start running while the room.disconnect() is still running. This hook sequentializes these two operations, so they always happen in order and never overlap.                                                                                                                                                                     |
-| [useSortedParticipants(participants)](./react/hook/usesortedparticipants.md)                                                                 | The <code>useSortedParticipants</code> hook returns the participants sorted by importance.                                                                                                                                                                                                                                                                                                                                                                                  |
-| [useSpeakingParticipants()](./react/hook/usespeakingparticipants.md)                                                                         | The <code>useSpeakingParticipants</code> hook returns only the active speakers of all participants.                                                                                                                                                                                                                                                                                                                                                                         |
-| [useStartAudio({ room, props })](./react/hook/usestartaudio.md)                                                                              | In many browsers to start audio playback, the user must perform a user-initiated event such as clicking a button. The <code>useStatAudio</code> hook returns an object with a boolean <code>canPlayAudio</code> flag that indicates whether audio playback is allowed in the current context, as well as a <code>startAudio</code> function that can be called in a button <code>onClick</code> callback to start audio playback in the current context.                    |
-| [useStartVideo({ room, props })](./react/hook/usestartvideo.md)                                                                              | In some browsers to start video playback in low power mode, the user must perform a user-initiated event such as clicking a button. The <code>useStartVideo</code> hook returns an object with a boolean <code>canPlayVideo</code> flag that indicates whether video playback is allowed in the current context, as well as a <code>startVideo</code> function that can be called in a button <code>onClick</code> callback to start video playback in the current context. |
-| [useSwipe(element, options)](./react/hook/useswipe.md)                                                                                       | Simple implementation to detect horizontal swipe actions. Accepts callbacks for on right and left swipes.                                                                                                                                                                                                                                                                                                                                                                   |
-| [useTextStream(topic)](./react/hook/usetextstream.md)                                                                                        | **_(BETA)_**                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
-| [useToken(tokenEndpoint, roomName, options)](./react/hook/usetoken.md)                                                                       | The <code>useToken</code> hook fetches a token from the given token endpoint with the given user info.                                                                                                                                                                                                                                                                                                                                                                      |
-| [useTrackByName(name, participant)](./react/hook/usetrackbyname.md)                                                                          | This function <code>useTrackByName</code> allows you to access a track by referencing its track name. Inside the function, it ensures that the a valid <code>participant</code> reference is available by checking for both a passed participant argument and, if not available, a valid participant context.                                                                                                                                                               |
-| [useTrackMutedIndicator(trackRef)](./react/hook/usetrackmutedindicator.md)                                                                   | The <code>useTrackMutedIndicator</code> hook is used to implement the <code>TrackMutedIndicator</code> component and returns the muted state of the given track.                                                                                                                                                                                                                                                                                                            |
-| [useTrackRefContext()](./react/hook/usetrackrefcontext.md)                                                                                   | Ensures that a track reference is provided via context. If not inside a <code>TrackRefContext</code>, an error is thrown.                                                                                                                                                                                                                                                                                                                                                   |
-| [useTracks(sources, options)](./react/hook/usetracks.md)                                                                                     | The <code>useTracks</code> hook returns an array of <code>TrackReference</code> or <code>TrackReferenceOrPlaceholder</code> depending on the provided <code>sources</code> property. If only subscribed tracks are desired, set the <code>onlySubscribed</code> property to <code>true</code>.                                                                                                                                                                              |
-| [useTrackToggle({ source, onChange, initialState, captureOptions, publishOptions, onDeviceError, ...rest })](./react/hook/usetracktoggle.md) | The <code>useTrackToggle</code> hook is used to implement the <code>TrackToggle</code> component and returns state and functionality of the given track.                                                                                                                                                                                                                                                                                                                    |
-| [useTrackTranscription(trackRef, options)](./react/hook/usetracktranscription.md)                                                            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [useTrackVolume(trackOrTrackReference, options)](./react/hook/usetrackvolume.md)                                                             | Hook for tracking the volume of an audio track using the Web Audio API.                                                                                                                                                                                                                                                                                                                                                                                                     |
-| [useTranscriptions(opts)](./react/hook/usetranscriptions.md)                                                                                 | **_(BETA)_** useTranscriptions is a hook that returns the transcriptions for the given participant identities and track sids, if no options are provided, it will return all transcriptions                                                                                                                                                                                                                                                                                 |
-| [useVisualStableUpdate(trackReferences, maxItemsOnPage, options)](./react/hook/usevisualstableupdate.md)                                     | The <code>useVisualStableUpdate</code> hook is used to prevent visually jarring jumps and shifts of elements in an array. The algorithm only starts to update when there are more items than visually fit on a page. If this is the case, it will make sure that speaking participants move to the first page and are always visible.                                                                                                                                       |
-| [useVoiceAssistant()](./react/hook/usevoiceassistant.md)                                                                                     | **_(BETA)_** This hook looks for the first agent-participant in the room.                                                                                                                                                                                                                                                                                                                                                                                                   |
+| Hook                                                                                                                                               | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| -------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [useAgent(session)](./react/hook/useagent.md)                                                                                                      | **_(BETA)_** useAgent encapculates all agent state, normalizing some quirks around how LiveKit Agents work.                                                                                                                                                                                                                                                                                                                                                                 |
+| [useAudioPlayback(room)](./react/hook/useaudioplayback.md)                                                                                         | In many browsers to start audio playback, the user must perform a user-initiated event such as clicking a button. The <code>useAudioPlayback</code> hook returns an object with a boolean <code>canPlayAudio</code> flag that indicates whether audio playback is allowed in the current context, as well as a <code>startAudio</code> function that can be called in a button <code>onClick</code> callback to start audio playback in the current context.                |
+| [useAudioWaveform(trackOrTrackReference, options)](./react/hook/useaudiowaveform.md)                                                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [useChat(options)](./react/hook/usechat.md)                                                                                                        | The <code>useChat</code> hook provides chat functionality for a LiveKit room.                                                                                                                                                                                                                                                                                                                                                                                               |
+| [useChatToggle({ props })](./react/hook/usechattoggle.md)                                                                                          | The <code>useChatToggle</code> hook provides state and functions for toggling the chat window.                                                                                                                                                                                                                                                                                                                                                                              |
+| [useClearPinButton(props)](./react/hook/useclearpinbutton.md)                                                                                      | The <code>useClearPinButton</code> hook provides props for the [ClearPinButton()](./react/component/clearpinbutton.md) or your custom implementation of it component. It adds the <code>onClick</code> handler to signal the <code>LayoutContext</code> that the tile in focus should be cleared.                                                                                                                                                                           |
+| [useConnectionQualityIndicator(options)](./react/hook/useconnectionqualityindicator.md)                                                            | The <code>useConnectionQualityIndicator</code> hook provides props for the <code>ConnectionQualityIndicator</code> or your custom implementation of it component.                                                                                                                                                                                                                                                                                                           |
+| [useConnectionState(room)](./react/hook/useconnectionstate.md)                                                                                     | The <code>useConnectionState</code> hook allows you to simply implement your own <code>ConnectionState</code> component.                                                                                                                                                                                                                                                                                                                                                    |
+| [useCreateLayoutContext()](./react/hook/usecreatelayoutcontext.md)                                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [useDataChannel(topic, onMessage)](./react/hook/usedatachannel.md)                                                                                 | The <code>useDataChannel</code> hook returns the ability to send and receive messages. Pass an optional <code>topic</code> to narrow down which messages are returned in the messages array.                                                                                                                                                                                                                                                                                |
+| [useDataChannel(onMessage)](./react/hook/usedatachannel_1.md)                                                                                      | Overload for <code>useDataChannel</code> without a topic. See [useDataChannel()](./react/hook/usedatachannel.md) for information and usage examples.                                                                                                                                                                                                                                                                                                                        |
+| [useDisconnectButton(props)](./react/hook/usedisconnectbutton.md)                                                                                  | The <code>useDisconnectButton</code> hook is used to implement the <code>DisconnectButton</code> or your custom implementation of it. It adds onClick handler to the button to disconnect from the room.                                                                                                                                                                                                                                                                    |
+| [useEnsureCreateLayoutContext(layoutContext)](./react/hook/useensurecreatelayoutcontext.md)                                                        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [useEnsureLayoutContext(layoutContext)](./react/hook/useensurelayoutcontext.md)                                                                    | Ensures that a layout context is provided, either via context or explicitly as a parameter. If not inside a <code>LayoutContext</code> and no layout context is provided, an error is thrown.                                                                                                                                                                                                                                                                               |
+| [useEnsureParticipant(participant)](./react/hook/useensureparticipant.md)                                                                          | Ensures that a participant is provided, either via context or explicitly as a parameter. If not inside a <code>ParticipantContext</code> and no participant is provided, an error is thrown.                                                                                                                                                                                                                                                                                |
+| [useEnsureRoom(room)](./react/hook/useensureroom.md)                                                                                               | Ensures that a room is provided, either via context or explicitly as a parameter. If no room is provided, an error is thrown.                                                                                                                                                                                                                                                                                                                                               |
+| [useEnsureSession(session)](./react/hook/useensuresession.md)                                                                                      | **_(BETA)_** Ensures that a session is provided, either via context or explicitly as a parameter. If no session is provided, an error is thrown.                                                                                                                                                                                                                                                                                                                            |
+| [useEnsureTrackRef(trackRef)](./react/hook/useensuretrackref.md)                                                                                   | Ensures that a track reference is provided, either via context or explicitly as a parameter. If not inside a <code>TrackRefContext</code> and no track reference is provided, an error is thrown.                                                                                                                                                                                                                                                                           |
+| [useEvents(instance, event, handlerFn, dependencies)](./react/hook/useevents.md)                                                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [useFacingMode(trackReference)](./react/hook/usefacingmode.md)                                                                                     | Try to determine the <code>facingMode</code> of a local participant video track.                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useFocusToggle({ trackRef, props })](./react/hook/usefocustoggle.md)                                                                              | The <code>useFocusToggle</code> hook is used to implement the <code>FocusToggle</code> or your custom implementation of it. The <code>TrackReferenceOrPlaceholder</code> is used to register a onClick handler and to identify the track to focus on.                                                                                                                                                                                                                       |
+| [useGridLayout(gridElement, trackCount, options)](./react/hook/usegridlayout.md)                                                                   | The <code>useGridLayout</code> hook tries to select the best layout to fit all tiles. If the available screen space is not enough, it will reduce the number of maximum visible tiles and select a layout that still works visually within the given limitations. As the order of tiles changes over time, the hook tries to keep visual updates to a minimum while trying to display important tiles such as speaking participants or screen shares.                       |
+| [useIsEncrypted(participant, options)](./react/hook/useisencrypted.md)                                                                             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [useIsMuted(trackRef)](./react/hook/useismuted.md)                                                                                                 | The <code>useIsMuted</code> hook is used to implement the <code>TrackMutedIndicator</code> or your custom implementation of it. It returns a <code>boolean</code> that indicates if the track is muted or not.                                                                                                                                                                                                                                                              |
+| [useIsRecording(room)](./react/hook/useisrecording.md)                                                                                             | The <code>useIsRecording</code> hook returns a <code>boolean</code> that indicates if the room is currently being recorded.                                                                                                                                                                                                                                                                                                                                                 |
+| [useIsSpeaking(participant)](./react/hook/useisspeaking.md)                                                                                        | The <code>useIsSpeaking</code> hook returns a <code>boolean</code> that indicates if the participant is speaking or not.                                                                                                                                                                                                                                                                                                                                                    |
+| [useKrispNoiseFilter(options)](./react/hook/usekrispnoisefilter.md)                                                                                | <p>**_(BETA)_** Enable the Krisp enhanced noise cancellation feature for local audio tracks.</p><p>Defaults to the localParticipant's microphone track publication, but you can override this behavior by passing in a different track reference.</p>                                                                                                                                                                                                                       |
+| [useLayoutContext()](./react/hook/uselayoutcontext.md)                                                                                             | Ensures that a layout context is provided via context. If no layout context is provided, an error is thrown.                                                                                                                                                                                                                                                                                                                                                                |
+| [useLiveKitRoom(props)](./react/hook/uselivekitroom.md)                                                                                            | The <code>useLiveKitRoom</code> hook is used to implement the <code>LiveKitRoom</code> or your custom implementation of it. It returns a <code>Room</code> instance and HTML props that should be applied to the root element of the component.                                                                                                                                                                                                                             |
+| [useLocalParticipant(options)](./react/hook/uselocalparticipant.md)                                                                                | The <code>useLocalParticipant</code> hook returns the local participant and the associated state around the participant.                                                                                                                                                                                                                                                                                                                                                    |
+| [useLocalParticipantPermissions()](./react/hook/uselocalparticipantpermissions.md)                                                                 | The <code>useLocalParticipantPermissions</code> hook returns the local participant's permissions.                                                                                                                                                                                                                                                                                                                                                                           |
+| [useMaybeLayoutContext()](./react/hook/usemaybelayoutcontext.md)                                                                                   | Returns a layout context from the <code>LayoutContext</code> if it exists, otherwise <code>undefined</code>.                                                                                                                                                                                                                                                                                                                                                                |
+| [useMaybeParticipantContext()](./react/hook/usemaybeparticipantcontext.md)                                                                         | Returns a participant from the <code>ParticipantContext</code> if it exists, otherwise <code>undefined</code>.                                                                                                                                                                                                                                                                                                                                                              |
+| [useMaybeRoomContext()](./react/hook/usemayberoomcontext.md)                                                                                       | Returns the room context if it exists, otherwise undefined.                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| [useMaybeSessionContext()](./react/hook/usemaybesessioncontext.md)                                                                                 | **_(BETA)_** Returns the session context if it exists, otherwise undefined.                                                                                                                                                                                                                                                                                                                                                                                                 |
+| [useMaybeTrackRefContext()](./react/hook/usemaybetrackrefcontext.md)                                                                               | Returns a track reference from the <code>TrackRefContext</code> if it exists, otherwise <code>undefined</code>.                                                                                                                                                                                                                                                                                                                                                             |
+| [useMediaDevices({ kind, onError, })](./react/hook/usemediadevices.md)                                                                             | The <code>useMediaDevices</code> hook returns the list of media devices of a given kind.                                                                                                                                                                                                                                                                                                                                                                                    |
+| [useMediaDeviceSelect({ kind, room, track, requestPermissions, onError, })](./react/hook/usemediadeviceselect.md)                                  | The <code>useMediaDeviceSelect</code> hook is used to implement the <code>MediaDeviceSelect</code> component and returns o.a. the list of devices of a given kind (audioinput or videoinput), the currently active device and a function to set the the active device.                                                                                                                                                                                                      |
+| [useMultibandTrackVolume(trackOrTrackReference, options)](./react/hook/usemultibandtrackvolume.md)                                                 | Hook for tracking the volume of an audio track across multiple frequency bands using the Web Audio API.                                                                                                                                                                                                                                                                                                                                                                     |
+| [usePagination(itemPerPage, trackReferences)](./react/hook/usepagination.md)                                                                       | The <code>usePagination</code> hook implements simple pagination logic for use with arrays.                                                                                                                                                                                                                                                                                                                                                                                 |
+| [useParticipantAttribute(attributeKey, options)](./react/hook/useparticipantattribute.md)                                                          | The <code>useParticipantAttribute</code> hook returns the latest value of a given attribute key of a participant. It requires a <code>Participant</code> object passed as property in the <code>UseParticipantAttributesOptions</code> or via the <code>ParticipantContext</code>.                                                                                                                                                                                          |
+| [useParticipantAttributes(props)](./react/hook/useparticipantattributes.md)                                                                        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [useParticipantContext()](./react/hook/useparticipantcontext.md)                                                                                   | Ensures that a participant is provided via context. If not inside a <code>ParticipantContext</code>, an error is thrown.                                                                                                                                                                                                                                                                                                                                                    |
+| [useParticipantInfo(props)](./react/hook/useparticipantinfo.md)                                                                                    |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [useParticipantPermissions(options)](./react/hook/useparticipantpermissions.md)                                                                    |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [useParticipants(options)](./react/hook/useparticipants.md)                                                                                        | The <code>useParticipants</code> hook returns all participants (local and remote) of the current room.                                                                                                                                                                                                                                                                                                                                                                      |
+| [useParticipantTile({ trackRef, onParticipantClick, disableSpeakingIndicator, htmlProps, })](./react/hook/useparticipanttile.md)                   | The <code>useParticipantTile</code> hook is used to implement the <code>ParticipantTile</code> and returns the props needed to render the tile.                                                                                                                                                                                                                                                                                                                             |
+| [useParticipantTracks(sources, optionsOrParticipantIdentity)](./react/hook/useparticipanttracks.md)                                                | <code>useParticipantTracks</code> is a custom React that allows you to get tracks of a specific participant only, by specifiying the participant's identity. If the participant identity is not passed the hook will try to get the participant from a participant context.                                                                                                                                                                                                 |
+| [usePersistentUserChoices(options)](./react/hook/usepersistentuserchoices.md)                                                                      | A hook that provides access to user choices stored in local storage, such as selected media devices and their current state (on or off), as well as the user name.                                                                                                                                                                                                                                                                                                          |
+| [usePinnedTracks(layoutContext)](./react/hook/usepinnedtracks.md)                                                                                  | The <code>usePinnedTracks</code> hook returns a array of the pinned tracks of the current room.                                                                                                                                                                                                                                                                                                                                                                             |
+| [usePreviewDevice(enabled, deviceId, kind)](./react/hook/usepreviewdevice.md)                                                                      |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [usePreviewTracks(options, onError)](./react/hook/usepreviewtracks.md)                                                                             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [useRemoteParticipant(identifier, options)](./react/hook/useremoteparticipant.md)                                                                  | The <code>useRemoteParticipant</code> hook returns the first RemoteParticipant by either identity and/or based on the participant kind.                                                                                                                                                                                                                                                                                                                                     |
+| [useRemoteParticipant(identity, options)](./react/hook/useremoteparticipant_1.md)                                                                  | The <code>useRemoteParticipant</code> hook returns the first RemoteParticipant by either identity or based on the participant kind.                                                                                                                                                                                                                                                                                                                                         |
+| [useRemoteParticipants(options)](./react/hook/useremoteparticipants.md)                                                                            | The <code>useRemoteParticipants</code> hook returns all remote participants (without the local) of the current room.                                                                                                                                                                                                                                                                                                                                                        |
+| [useRoomContext()](./react/hook/useroomcontext.md)                                                                                                 | Ensures that a room is provided via context. If no room is provided, an error is thrown.                                                                                                                                                                                                                                                                                                                                                                                    |
+| [useRoomInfo(options)](./react/hook/useroominfo.md)                                                                                                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [useSequentialRoomConnectDisconnect(room)](./react/hook/usesequentialroomconnectdisconnect.md)                                                     | When calling room.disconnect() as part of a React useEffect cleanup function, it is possible for a room.connect(...) in the effect body to start running while the room.disconnect() is still running. This hook sequentializes these two operations, so they always happen in order and never overlap.                                                                                                                                                                     |
+| [useSession(tokenSource, options)](./react/hook/usesession.md)                                                                                     | **_(BETA)_** A Session represents a managed connection to a Room which can contain Agents.                                                                                                                                                                                                                                                                                                                                                                                  |
+| [useSession(tokenSource, options)](./react/hook/usesession_1.md)                                                                                   | **_(BETA)_** A Session represents a managed connection to a Room which can contain Agents.                                                                                                                                                                                                                                                                                                                                                                                  |
+| [useSessionContext()](./react/hook/usesessioncontext.md)                                                                                           | **_(BETA)_** Ensures that a session is provided via context. If no session is provided, an error is thrown.                                                                                                                                                                                                                                                                                                                                                                 |
+| [useSessionMessages(session)](./react/hook/usesessionmessages.md)                                                                                  | **_(BETA)_**                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [useSortedParticipants(participants)](./react/hook/usesortedparticipants.md)                                                                       | The <code>useSortedParticipants</code> hook returns the participants sorted by importance.                                                                                                                                                                                                                                                                                                                                                                                  |
+| [useSpeakingParticipants(options)](./react/hook/usespeakingparticipants.md)                                                                        | The <code>useSpeakingParticipants</code> hook returns only the active speakers of all participants.                                                                                                                                                                                                                                                                                                                                                                         |
+| [useStartAudio({ room, props })](./react/hook/usestartaudio.md)                                                                                    | In many browsers to start audio playback, the user must perform a user-initiated event such as clicking a button. The <code>useStatAudio</code> hook returns an object with a boolean <code>canPlayAudio</code> flag that indicates whether audio playback is allowed in the current context, as well as a <code>startAudio</code> function that can be called in a button <code>onClick</code> callback to start audio playback in the current context.                    |
+| [useStartVideo({ room, props })](./react/hook/usestartvideo.md)                                                                                    | In some browsers to start video playback in low power mode, the user must perform a user-initiated event such as clicking a button. The <code>useStartVideo</code> hook returns an object with a boolean <code>canPlayVideo</code> flag that indicates whether video playback is allowed in the current context, as well as a <code>startVideo</code> function that can be called in a button <code>onClick</code> callback to start video playback in the current context. |
+| [useSwipe(element, options)](./react/hook/useswipe.md)                                                                                             | Simple implementation to detect horizontal swipe actions. Accepts callbacks for on right and left swipes.                                                                                                                                                                                                                                                                                                                                                                   |
+| [useTextStream(topic, options)](./react/hook/usetextstream.md)                                                                                     | **_(BETA)_**                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [useToken(tokenEndpoint, roomName, options)](./react/hook/usetoken.md)                                                                             | The <code>useToken</code> hook fetches a token from the given token endpoint with the given user info.                                                                                                                                                                                                                                                                                                                                                                      |
+| [useTrackByName(name, participant)](./react/hook/usetrackbyname.md)                                                                                | This function <code>useTrackByName</code> allows you to access a track by referencing its track name. Inside the function, it ensures that the a valid <code>participant</code> reference is available by checking for both a passed participant argument and, if not available, a valid participant context.                                                                                                                                                               |
+| [useTrackMutedIndicator(trackRef)](./react/hook/usetrackmutedindicator.md)                                                                         | The <code>useTrackMutedIndicator</code> hook is used to implement the <code>TrackMutedIndicator</code> component and returns the muted state of the given track.                                                                                                                                                                                                                                                                                                            |
+| [useTrackRefContext()](./react/hook/usetrackrefcontext.md)                                                                                         | Ensures that a track reference is provided via context. If not inside a <code>TrackRefContext</code>, an error is thrown.                                                                                                                                                                                                                                                                                                                                                   |
+| [useTracks(sources, options)](./react/hook/usetracks.md)                                                                                           | The <code>useTracks</code> hook returns an array of <code>TrackReference</code> or <code>TrackReferenceOrPlaceholder</code> depending on the provided <code>sources</code> property. If only subscribed tracks are desired, set the <code>onlySubscribed</code> property to <code>true</code>.                                                                                                                                                                              |
+| [useTrackToggle({ source, onChange, initialState, captureOptions, publishOptions, onDeviceError, room, ...rest })](./react/hook/usetracktoggle.md) | The <code>useTrackToggle</code> hook is used to implement the <code>TrackToggle</code> component and returns state and functionality of the given track.                                                                                                                                                                                                                                                                                                                    |
+| [useTrackTranscription(trackRef, options)](./react/hook/usetracktranscription.md)                                                                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [useTrackVolume(trackOrTrackReference, options)](./react/hook/usetrackvolume.md)                                                                   | Hook for tracking the volume of an audio track using the Web Audio API.                                                                                                                                                                                                                                                                                                                                                                                                     |
+| [useTranscriptions(opts)](./react/hook/usetranscriptions.md)                                                                                       | **_(BETA)_** useTranscriptions is a hook that returns the transcriptions for the given participant identities and track sids, if no options are provided, it will return all transcriptions                                                                                                                                                                                                                                                                                 |
+| [useVisualStableUpdate(trackReferences, maxItemsOnPage, options)](./react/hook/usevisualstableupdate.md)                                           | The <code>useVisualStableUpdate</code> hook is used to prevent visually jarring jumps and shifts of elements in an array. The algorithm only starts to update when there are more items than visually fit on a page. If this is the case, it will make sure that speaking participants move to the first page and are always visible.                                                                                                                                       |
+| [useVoiceAssistant()](./react/hook/usevoiceassistant.md)                                                                                           | **_(BETA)_** This hook looks for the first agent-participant in the room.                                                                                                                                                                                                                                                                                                                                                                                                   |
 
 ## Others
 
-| Other                                                                                             | Description                                                                                                                                                                                                                       |
-| ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [AgentState](./react/agentstate.md)                                                               | **_(BETA)_**                                                                                                                                                                                                                      |
-| [AllowAudioPlaybackProps](./react/allowaudioplaybackprops.md)                                     |                                                                                                                                                                                                                                   |
-| [AllowMediaPlaybackProps](./react/allowmediaplaybackprops.md)                                     |                                                                                                                                                                                                                                   |
-| [AudioConferenceProps](./react/audioconferenceprops.md)                                           |                                                                                                                                                                                                                                   |
-| [AudioTrackProps](./react/audiotrackprops.md)                                                     |                                                                                                                                                                                                                                   |
-| [AudioVisualizerProps](./react/audiovisualizerprops.md)                                           |                                                                                                                                                                                                                                   |
-| [AudioWaveformOptions](./react/audiowaveformoptions.md)                                           |                                                                                                                                                                                                                                   |
-| [BarVisualizerOptions](./react/barvisualizeroptions.md)                                           | **_(BETA)_**                                                                                                                                                                                                                      |
-| [BarVisualizerProps](./react/barvisualizerprops.md)                                               | **_(BETA)_**                                                                                                                                                                                                                      |
-| [CarouselLayoutProps](./react/carousellayoutprops.md)                                             |                                                                                                                                                                                                                                   |
-| [ChatEntryProps](./react/chatentryprops.md)                                                       | ChatEntry composes the HTML div element under the hood, so you can pass all its props. These are the props specific to the ChatEntry component:                                                                                   |
-| [ChatProps](./react/chatprops.md)                                                                 |                                                                                                                                                                                                                                   |
-| [ChatToggleProps](./react/chattoggleprops.md)                                                     |                                                                                                                                                                                                                                   |
-| [ClearPinButtonProps](./react/clearpinbuttonprops.md)                                             |                                                                                                                                                                                                                                   |
-| [ConnectionQualityIndicatorOptions](./react/connectionqualityindicatoroptions.md)                 |                                                                                                                                                                                                                                   |
-| [ConnectionQualityIndicatorProps](./react/connectionqualityindicatorprops.md)                     |                                                                                                                                                                                                                                   |
-| [ConnectionStateToastProps](./react/connectionstatetoastprops.md)                                 |                                                                                                                                                                                                                                   |
-| [ConnectionStatusProps](./react/connectionstatusprops.md)                                         |                                                                                                                                                                                                                                   |
-| [ControlBarControls](./react/controlbarcontrols.md)                                               |                                                                                                                                                                                                                                   |
-| [ControlBarProps](./react/controlbarprops.md)                                                     |                                                                                                                                                                                                                                   |
-| [DisconnectButtonProps](./react/disconnectbuttonprops.md)                                         |                                                                                                                                                                                                                                   |
-| [FocusLayoutContainerProps](./react/focuslayoutcontainerprops.md)                                 |                                                                                                                                                                                                                                   |
-| [FocusLayoutProps](./react/focuslayoutprops.md)                                                   |                                                                                                                                                                                                                                   |
-| [FocusToggleProps](./react/focustoggleprops.md)                                                   |                                                                                                                                                                                                                                   |
-| [formatChatMessageLinks(message)](./react/formatchatmessagelinks.md)                              |                                                                                                                                                                                                                                   |
-| [GridLayoutProps](./react/gridlayoutprops.md)                                                     |                                                                                                                                                                                                                                   |
-| [LayoutContextProviderProps](./react/layoutcontextproviderprops.md)                               |                                                                                                                                                                                                                                   |
-| [LayoutContextType](./react/layoutcontexttype.md)                                                 |                                                                                                                                                                                                                                   |
-| [LiveKitRoomProps](./react/livekitroomprops.md)                                                   |                                                                                                                                                                                                                                   |
-| [MediaDeviceMenuProps](./react/mediadevicemenuprops.md)                                           |                                                                                                                                                                                                                                   |
-| [MediaDeviceSelectProps](./react/mediadeviceselectprops.md)                                       |                                                                                                                                                                                                                                   |
-| [MessageFormatter](./react/messageformatter.md)                                                   |                                                                                                                                                                                                                                   |
-| [MultiBandTrackVolumeOptions](./react/multibandtrackvolumeoptions.md)                             | Interface for configuring options for the useMultibandTrackVolume hook.                                                                                                                                                           |
-| [ParticipantLoopProps](./react/participantloopprops.md)                                           |                                                                                                                                                                                                                                   |
-| [ParticipantNameProps](./react/participantnameprops.md)                                           |                                                                                                                                                                                                                                   |
-| [ParticipantTileProps](./react/participanttileprops.md)                                           |                                                                                                                                                                                                                                   |
-| [PreJoinProps](./react/prejoinprops.md)                                                           | Props for the PreJoin component.                                                                                                                                                                                                  |
-| [RoomAudioRendererProps](./react/roomaudiorendererprops.md)                                       |                                                                                                                                                                                                                                   |
-| [RoomNameProps](./react/roomnameprops.md)                                                         |                                                                                                                                                                                                                                   |
-| [TrackLoopProps](./react/trackloopprops.md)                                                       |                                                                                                                                                                                                                                   |
-| [TrackMutedIndicatorProps](./react/trackmutedindicatorprops.md)                                   |                                                                                                                                                                                                                                   |
-| [TrackToggleProps](./react/tracktoggleprops.md)                                                   |                                                                                                                                                                                                                                   |
-| [TrackTranscriptionOptions](./react/tracktranscriptionoptions.md)                                 |                                                                                                                                                                                                                                   |
-| [UseChatToggleProps](./react/usechattoggleprops.md)                                               |                                                                                                                                                                                                                                   |
-| [UseFocusToggleProps](./react/usefocustoggleprops.md)                                             |                                                                                                                                                                                                                                   |
-| [UseIsEncryptedOptions](./react/useisencryptedoptions.md)                                         |                                                                                                                                                                                                                                   |
-| [UseIsMutedOptions](./react/useismutedoptions.md)                                                 |                                                                                                                                                                                                                                   |
-| [useKrispNoiseFilterOptions](./react/usekrispnoisefilteroptions.md)                               | **_(BETA)_**                                                                                                                                                                                                                      |
-| [UseLocalParticipantOptions](./react/uselocalparticipantoptions.md)                               |                                                                                                                                                                                                                                   |
-| [UseMediaDeviceSelectProps](./react/usemediadeviceselectprops.md)                                 |                                                                                                                                                                                                                                   |
-| [UseParticipantAttributesOptions](./react/useparticipantattributesoptions.md)                     | The <code>useParticipantAttributes</code> hook returns the attributes of a given participant and allows to set them. It requires a <code>Participant</code> object passed as property or via the <code>ParticipantContext</code>. |
-| [UseParticipantInfoOptions](./react/useparticipantinfooptions.md)                                 | The <code>useParticipantInfo</code> hook returns the identity, name, and metadata of a given participant. It requires a <code>Participant</code> object passed as property or via the <code>ParticipantContext</code>.            |
-| [UseParticipantPermissionsOptions](./react/useparticipantpermissionsoptions.md)                   | The <code>useParticipantPermissions</code> hook returns the permissions of a given participant.                                                                                                                                   |
-| [UseParticipantsOptions](./react/useparticipantsoptions.md)                                       |                                                                                                                                                                                                                                   |
-| [UseParticipantTileProps](./react/useparticipanttileprops.md)                                     |                                                                                                                                                                                                                                   |
-| [UsePersistentUserChoicesOptions](./react/usepersistentuserchoicesoptions.md)                     | Options for the <code>usePersistentDeviceSettings</code> hook.                                                                                                                                                                    |
-| [UseRemoteParticipantOptions](./react/useremoteparticipantoptions.md)                             |                                                                                                                                                                                                                                   |
-| [UseRemoteParticipantsOptions](./react/useremoteparticipantsoptions.md)                           |                                                                                                                                                                                                                                   |
-| [UserInfo](./react/userinfo.md)                                                                   |                                                                                                                                                                                                                                   |
-| [UseRoomInfoOptions](./react/useroominfooptions.md)                                               | The <code>useRoomInfo</code> hook returns the name and metadata of the given <code>Room</code>.                                                                                                                                   |
-| [UseSequentialRoomConnectDisconnectResults](./react/usesequentialroomconnectdisconnectresults.md) |                                                                                                                                                                                                                                   |
-| [UseStartAudioProps](./react/usestartaudioprops.md)                                               |                                                                                                                                                                                                                                   |
-| [UseStartVideoProps](./react/usestartvideoprops.md)                                               |                                                                                                                                                                                                                                   |
-| [UseSwipeOptions](./react/useswipeoptions.md)                                                     |                                                                                                                                                                                                                                   |
-| [UseTokenOptions](./react/usetokenoptions.md)                                                     |                                                                                                                                                                                                                                   |
-| [UseTracksHookReturnType](./react/usetrackshookreturntype.md)                                     |                                                                                                                                                                                                                                   |
-| [UseTracksOptions](./react/usetracksoptions.md)                                                   |                                                                                                                                                                                                                                   |
-| [UseTrackToggleProps](./react/usetracktoggleprops.md)                                             |                                                                                                                                                                                                                                   |
-| [UseTranscriptionsOptions](./react/usetranscriptionsoptions.md)                                   | **_(BETA)_**                                                                                                                                                                                                                      |
-| [UseVisualStableUpdateOptions](./react/usevisualstableupdateoptions.md)                           |                                                                                                                                                                                                                                   |
-| [VideoConferenceProps](./react/videoconferenceprops.md)                                           |                                                                                                                                                                                                                                   |
-| [VideoTrackProps](./react/videotrackprops.md)                                                     |                                                                                                                                                                                                                                   |
-| [VoiceAssistant](./react/voiceassistant.md)                                                       | **_(BETA)_**                                                                                                                                                                                                                      |
-| [VoiceAssistantControlBarControls](./react/voiceassistantcontrolbarcontrols.md)                   | **_(BETA)_**                                                                                                                                                                                                                      |
-| [VoiceAssistantControlBarProps](./react/voiceassistantcontrolbarprops.md)                         | **_(BETA)_**                                                                                                                                                                                                                      |
+| Other                                                                                             | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [AgentCallbacks](./react/agentcallbacks.md)                                                       | **_(BETA)_**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| [AgentEvent](./react/agentevent.md)                                                               | **_(BETA)_**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| [AgentState](./react/agentstate.md)                                                               | <p>**_(BETA)_** State representing the current status of the agent, whether it is ready for speach, etc</p><p>For most agents (which have the preconnect audio buffer feature enabled), this is the lifecycle: connecting ➡️ pre-connect-buffering ➡️ initializing/listening/thinking/speaking</p><p>For agents without the preconnect audio feature enabled: connecting ➡️ initializing ➡️ idle/listening/thinking/speaking</p><p>If an agent fails to connect: connecting ➡️ pre-connect-buffering/initializing ➡️ failed</p><p>Legacy useVoiceAssistant hook: disconnected ➡️ connecting ➡️ initializing ➡️ listening/thinking/speaking</p> |
+| [AllowAudioPlaybackProps](./react/allowaudioplaybackprops.md)                                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [AllowMediaPlaybackProps](./react/allowmediaplaybackprops.md)                                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [AudioConferenceProps](./react/audioconferenceprops.md)                                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [AudioTrackProps](./react/audiotrackprops.md)                                                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [AudioVisualizerProps](./react/audiovisualizerprops.md)                                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [AudioWaveformOptions](./react/audiowaveformoptions.md)                                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [BarVisualizerOptions](./react/barvisualizeroptions.md)                                           | **_(BETA)_**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| [BarVisualizerProps](./react/barvisualizerprops.md)                                               | **_(BETA)_**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| [CarouselLayoutProps](./react/carousellayoutprops.md)                                             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [ChatEntryProps](./react/chatentryprops.md)                                                       | ChatEntry composes the HTML div element under the hood, so you can pass all its props. These are the props specific to the ChatEntry component:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [ChatProps](./react/chatprops.md)                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [ChatToggleProps](./react/chattoggleprops.md)                                                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [ClearPinButtonProps](./react/clearpinbuttonprops.md)                                             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [ConnectionQualityIndicatorOptions](./react/connectionqualityindicatoroptions.md)                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [ConnectionQualityIndicatorProps](./react/connectionqualityindicatorprops.md)                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [ConnectionStateToastProps](./react/connectionstatetoastprops.md)                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [ConnectionStatusProps](./react/connectionstatusprops.md)                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [ControlBarControls](./react/controlbarcontrols.md)                                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [ControlBarProps](./react/controlbarprops.md)                                                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [DisconnectButtonProps](./react/disconnectbuttonprops.md)                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [FocusLayoutContainerProps](./react/focuslayoutcontainerprops.md)                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [FocusLayoutProps](./react/focuslayoutprops.md)                                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [FocusToggleProps](./react/focustoggleprops.md)                                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [formatChatMessageLinks(message)](./react/formatchatmessagelinks.md)                              |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [GridLayoutProps](./react/gridlayoutprops.md)                                                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [LayoutContextProviderProps](./react/layoutcontextproviderprops.md)                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [LayoutContextType](./react/layoutcontexttype.md)                                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [LiveKitRoomProps](./react/livekitroomprops.md)                                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [MediaDeviceMenuProps](./react/mediadevicemenuprops.md)                                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [MediaDeviceSelectProps](./react/mediadeviceselectprops.md)                                       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [MessageFormatter](./react/messageformatter.md)                                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [MessagesCallbacks](./react/messagescallbacks.md)                                                 | **_(BETA)_**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| [MessagesEvent](./react/messagesevent.md)                                                         | **_(BETA)_**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| [MultiBandTrackVolumeOptions](./react/multibandtrackvolumeoptions.md)                             | Interface for configuring options for the useMultibandTrackVolume hook.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
+| [ParticipantLoopProps](./react/participantloopprops.md)                                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [ParticipantNameProps](./react/participantnameprops.md)                                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [ParticipantTileProps](./react/participanttileprops.md)                                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [PreJoinProps](./react/prejoinprops.md)                                                           | Props for the PreJoin component.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
+| [RoomAudioRendererProps](./react/roomaudiorendererprops.md)                                       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [RoomNameProps](./react/roomnameprops.md)                                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [SessionCallbacks](./react/sessioncallbacks.md)                                                   | **_(BETA)_**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| [SessionConnectOptions](./react/sessionconnectoptions.md)                                         | **_(BETA)_**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| [SessionEvent](./react/sessionevent.md)                                                           | **_(BETA)_**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| [SessionProviderProps](./react/sessionproviderprops.md)                                           | **_(BETA)_**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| [SwitchActiveDeviceOptions](./react/switchactivedeviceoptions.md)                                 | **_(BETA)_**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| [TrackLoopProps](./react/trackloopprops.md)                                                       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [TrackMutedIndicatorProps](./react/trackmutedindicatorprops.md)                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [TrackToggleProps](./react/tracktoggleprops.md)                                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [TrackTranscriptionOptions](./react/tracktranscriptionoptions.md)                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [UseAgentReturn](./react/useagentreturn.md)                                                       | **_(BETA)_**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| [UseChatToggleProps](./react/usechattoggleprops.md)                                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [UseFocusToggleProps](./react/usefocustoggleprops.md)                                             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [UseIsEncryptedOptions](./react/useisencryptedoptions.md)                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [UseIsMutedOptions](./react/useismutedoptions.md)                                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [useKrispNoiseFilterOptions](./react/usekrispnoisefilteroptions.md)                               | **_(BETA)_**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| [UseLocalParticipantOptions](./react/uselocalparticipantoptions.md)                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [UseMediaDeviceSelectProps](./react/usemediadeviceselectprops.md)                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [UseParticipantAttributesOptions](./react/useparticipantattributesoptions.md)                     | The <code>useParticipantAttributes</code> hook returns the attributes of a given participant and allows to set them. It requires a <code>Participant</code> object passed as property or via the <code>ParticipantContext</code>.                                                                                                                                                                                                                                                                                                                                                                                                              |
+| [UseParticipantInfoOptions](./react/useparticipantinfooptions.md)                                 | The <code>useParticipantInfo</code> hook returns the identity, name, and metadata of a given participant. It requires a <code>Participant</code> object passed as property or via the <code>ParticipantContext</code>.                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| [UseParticipantPermissionsOptions](./react/useparticipantpermissionsoptions.md)                   | The <code>useParticipantPermissions</code> hook returns the permissions of a given participant.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [UseParticipantsOptions](./react/useparticipantsoptions.md)                                       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [UseParticipantTileProps](./react/useparticipanttileprops.md)                                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [UsePersistentUserChoicesOptions](./react/usepersistentuserchoicesoptions.md)                     | Options for the <code>usePersistentDeviceSettings</code> hook.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
+| [UseRemoteParticipantOptions](./react/useremoteparticipantoptions.md)                             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [UseRemoteParticipantsOptions](./react/useremoteparticipantsoptions.md)                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [UserInfo](./react/userinfo.md)                                                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [UseRoomInfoOptions](./react/useroominfooptions.md)                                               | The <code>useRoomInfo</code> hook returns the name and metadata of the given <code>Room</code>.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [UseSequentialRoomConnectDisconnectResults](./react/usesequentialroomconnectdisconnectresults.md) |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [UseSessionMessagesReturn](./react/usesessionmessagesreturn.md)                                   | **_(BETA)_**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| [UseSessionReturn](./react/usesessionreturn.md)                                                   | **_(BETA)_**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| [UseSpeakingParticipantsOptions](./react/usespeakingparticipantsoptions.md)                       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [UseStartAudioProps](./react/usestartaudioprops.md)                                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [UseStartVideoProps](./react/usestartvideoprops.md)                                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [UseSwipeOptions](./react/useswipeoptions.md)                                                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [UseTextStreamOptions](./react/usetextstreamoptions.md)                                           | **_(BETA)_**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| [UseTokenOptions](./react/usetokenoptions.md)                                                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [UseTracksHookReturnType](./react/usetrackshookreturntype.md)                                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [UseTracksOptions](./react/usetracksoptions.md)                                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [UseTrackToggleProps](./react/usetracktoggleprops.md)                                             |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [UseTranscriptionsOptions](./react/usetranscriptionsoptions.md)                                   | **_(BETA)_**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| [UseVisualStableUpdateOptions](./react/usevisualstableupdateoptions.md)                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [VideoConferenceProps](./react/videoconferenceprops.md)                                           |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [VideoTrackProps](./react/videotrackprops.md)                                                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [VoiceAssistant](./react/voiceassistant.md)                                                       | **_(BETA)_**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| [VoiceAssistantControlBarControls](./react/voiceassistantcontrolbarcontrols.md)                   | **_(BETA)_**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
+| [VoiceAssistantControlBarProps](./react/voiceassistantcontrolbarprops.md)                         | **_(BETA)_**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |