@livekit/components-js-docs 0.1.47 → 0.1.49

package/generated-docs/react/index.md

@@ -49,15 +49,15 @@
 
 ## Prefabs
 
-| Prefab                                                                                                                                                                  | Description                                                                                                                                                                                                                                                                                                                                                                         |
-| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [AudioConference({ ...props })](./react/component/audioconference.md)                                                                                                   | This component is the default setup of a classic LiveKit audio conferencing app. It provides functionality like switching between participant grid view and focus view.                                                                                                                                                                                                             |
-| [Chat({ messageFormatter, messageDecoder, messageEncoder, channelTopic, ...props })](./react/component/chat.md)                                                         | The Chat component adds a basis chat functionality to the LiveKit room. The messages are distributed to all participants in the room. Only users who are in the room at the time of dispatch will receive the message.                                                                                                                                                              |
-| [ControlBar({ variation, controls, saveUserChoices, onDeviceError, ...props })](./react/component/controlbar.md)                                                        | The <code>ControlBar</code> prefab gives the user the basic user interface to control their media devices (camera, microphone and screen share), open the <code>Chat</code> and leave the room.                                                                                                                                                                                     |
-| [MediaDeviceMenu({ kind, initialSelection, onActiveDeviceChange, tracks, requestPermissions, ...props })](./react/component/mediadevicemenu.md)                         | The <code>MediaDeviceMenu</code> component is a button that opens a menu that lists all media devices and allows the user to select them.                                                                                                                                                                                                                                           |
-| [PreJoin({ defaults, onValidate, onSubmit, onError, debug, joinLabel, micLabel, camLabel, userLabel, persistUserChoices, ...htmlProps })](./react/component/prejoin.md) | The <code>PreJoin</code> prefab component is normally presented to the user before he enters a room. This component allows the user to check and select the preferred media device (camera und microphone). On submit the user decisions are returned, which can then be passed on to the <code>LiveKitRoom</code> so that the user enters the room with the correct media devices. |
-| [VideoConference({ chatMessageFormatter, chatMessageDecoder, chatMessageEncoder, SettingsComponent, ...props })](./react/component/videoconference.md)                  | The <code>VideoConference</code> ready-made component is your drop-in solution for a classic video conferencing application. It provides functionality such as focusing on one participant, grid view with pagination to handle large numbers of participants, basic non-persistent chat, screen sharing, and more.                                                                 |
-| [VoiceAssistantControlBar({ controls, saveUserChoices, onDeviceError, ...props })](./react/component/voiceassistantcontrolbar.md)                                       | **_(BETA)_**                                                                                                                                                                                                                                                                                                                                                                        |
+| Prefab                                                                                                                                                                                  | Description                                                                                                                                                                                                                                                                                                                                                                         |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [AudioConference({ ...props })](./react/component/audioconference.md)                                                                                                                   | This component is the default setup of a classic LiveKit audio conferencing app. It provides functionality like switching between participant grid view and focus view.                                                                                                                                                                                                             |
+| [Chat({ messageFormatter, messageDecoder, messageEncoder, channelTopic, ...props })](./react/component/chat.md)                                                                         | The Chat component adds a basis chat functionality to the LiveKit room. The messages are distributed to all participants in the room. Only users who are in the room at the time of dispatch will receive the message.                                                                                                                                                              |
+| [ControlBar({ variation, controls, saveUserChoices, onDeviceError, ...props })](./react/component/controlbar.md)                                                                        | The <code>ControlBar</code> prefab gives the user the basic user interface to control their media devices (camera, microphone and screen share), open the <code>Chat</code> and leave the room.                                                                                                                                                                                     |
+| [MediaDeviceMenu({ kind, initialSelection, onActiveDeviceChange, tracks, requestPermissions, ...props })](./react/component/mediadevicemenu.md)                                         | The <code>MediaDeviceMenu</code> component is a button that opens a menu that lists all media devices and allows the user to select them.                                                                                                                                                                                                                                           |
+| [PreJoin({ defaults, onValidate, onSubmit, onError, debug, joinLabel, micLabel, camLabel, userLabel, persistUserChoices, videoProcessor, ...htmlProps })](./react/component/prejoin.md) | The <code>PreJoin</code> prefab component is normally presented to the user before he enters a room. This component allows the user to check and select the preferred media device (camera und microphone). On submit the user decisions are returned, which can then be passed on to the <code>LiveKitRoom</code> so that the user enters the room with the correct media devices. |
+| [VideoConference({ chatMessageFormatter, chatMessageDecoder, chatMessageEncoder, SettingsComponent, ...props })](./react/component/videoconference.md)                                  | The <code>VideoConference</code> ready-made component is your drop-in solution for a classic video conferencing application. It provides functionality such as focusing on one participant, grid view with pagination to handle large numbers of participants, basic non-persistent chat, screen sharing, and more.                                                                 |
+| [VoiceAssistantControlBar({ controls, saveUserChoices, onDeviceError, ...props })](./react/component/voiceassistantcontrolbar.md)                                                       | **_(BETA)_**                                                                                                                                                                                                                                                                                                                                                                        |
 
 ## Hooks
 
@@ -86,6 +86,7 @@
 | [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.                                                                                                                                                                                                                                                                                                                                                    |
@@ -116,7 +117,7 @@
 | [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)                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [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 the only the active speakers of all participants.                                                                                                                                                                                                                                                                                                                                                                     |
+| [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.                                                                                                                                                                                                                                                                                                                                                                   |
@@ -193,6 +194,7 @@
 | [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>.                                              |

package/generated-docs/react/layoutcontextproviderprops.md

@@ -9,14 +9,18 @@
 
 # LayoutContextProviderProps interface
 
+{% callout type="note" variation="normal" %}
+
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+
+{% /callout %}
+
 **Signature:**
 
 ```typescript
 export interface LayoutContextProviderProps
 ```
 
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
-
 ## Properties
 
 | Property                                                                | Type                                                              | Description  |

package/generated-docs/react/layoutcontextproviderprops.onpinchange.md

@@ -6,6 +6,12 @@
 
 # LayoutContextProviderProps.onPinChange property
 
+{% callout type="note" variation="normal" %}
+
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+
+{% /callout %}
+
 **Signature:**
 
 ```typescript

package/generated-docs/react/layoutcontextproviderprops.onwidgetchange.md

@@ -6,6 +6,12 @@
 
 # LayoutContextProviderProps.onWidgetChange property
 
+{% callout type="note" variation="normal" %}
+
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+
+{% /callout %}
+
 **Signature:**
 
 ```typescript

package/generated-docs/react/layoutcontextproviderprops.value.md

@@ -6,6 +6,12 @@
 
 # LayoutContextProviderProps.value property
 
+{% callout type="note" variation="normal" %}
+
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+
+{% /callout %}
+
 **Signature:**
 
 ```typescript

package/generated-docs/react/layoutcontexttype.md

@@ -17,5 +17,3 @@ export type LayoutContextType = {
   widget: WidgetContextType;
 };
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/livekitroomprops.audio.md

@@ -13,5 +13,3 @@ Publish audio immediately after connecting to your LiveKit room.
 ```typescript
 audio?: AudioCaptureOptions | boolean;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/livekitroomprops.connect.md

@@ -13,5 +13,3 @@ If set to true a connection to LiveKit room is initiated.
 ```typescript
 connect?: boolean;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/livekitroomprops.connectoptions.md

@@ -13,5 +13,3 @@ Define options how to connect to the LiveKit server.
 ```typescript
 connectOptions?: RoomConnectOptions;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/livekitroomprops.md

@@ -17,8 +17,6 @@ export interface LiveKitRoomProps extends Omit<React.HTMLAttributes<HTMLDivEleme
 
 **Extends:** Omit&lt;React.HTMLAttributes&lt;HTMLDivElement&gt;, 'onError'&gt;
 
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
-
 ## Properties
 
 | Property                                                                  | Type                                      | Description                                                                                                                                                                                                                                                                                                   |

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

@@ -13,5 +13,3 @@ Options for when creating a new room. When you pass your own room instance to th
 ```typescript
 options?: RoomOptions;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -13,5 +13,3 @@ Optional room instance. By passing your own room instance you overwrite the `opt
 ```typescript
 room?: Room;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/livekitroomprops.screen.md

@@ -13,5 +13,3 @@ Publish screen share immediately after connecting to your LiveKit room.
 ```typescript
 screen?: ScreenShareCaptureOptions | boolean;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/livekitroomprops.serverurl.md

@@ -13,5 +13,3 @@ URL to the LiveKit server. For example: `wss://<domain>.livekit.cloud` To simpli
 ```typescript
 serverUrl: string | undefined;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/livekitroomprops.token.md

@@ -13,5 +13,3 @@ A user specific access token for a client to authenticate to the room. This toke
 ```typescript
 token: string | undefined;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/livekitroomprops.video.md

@@ -13,5 +13,3 @@ Publish video immediately after connecting to your LiveKit room.
 ```typescript
 video?: VideoCaptureOptions | boolean;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/localuserchoices.md

@@ -22,5 +22,3 @@ export type LocalUserChoices = {
   username: string;
 };
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/mediadevicemenuprops.md

@@ -17,8 +17,6 @@ export interface MediaDeviceMenuProps extends React.ButtonHTMLAttributes<HTMLBut
 
 **Extends:** React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt;
 
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
-
 ## Properties
 
 | Property                                                                      | Type                                                                                          | Description                                                                                                                                                                                                                                                                                                                                              |

package/generated-docs/react/mediadevicemenuprops.requestpermissions.md

@@ -13,5 +13,3 @@ this will call getUserMedia if the permissions are not yet given to enumerate th
 ```typescript
 requestPermissions?: boolean;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/mediadeviceselectprops.exactmatch.md

@@ -13,5 +13,3 @@ will force the browser to only return the specified device will call `onDeviceSe
 ```typescript
 exactMatch?: boolean;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/mediadeviceselectprops.md

@@ -17,8 +17,6 @@ export interface MediaDeviceSelectProps extends Omit<React.HTMLAttributes<HTMLUL
 
 **Extends:** Omit&lt;React.HTMLAttributes&lt;HTMLUListElement&gt;, 'onError'&gt;
 
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
-
 ## Properties
 
 | Property                                                                        | Type                                      | Description                                                                                                                                                                                                                                                                                                                                              |

package/generated-docs/react/mediadeviceselectprops.requestpermissions.md

@@ -13,5 +13,3 @@ this will call getUserMedia if the permissions are not yet given to enumerate th
 ```typescript
 requestPermissions?: boolean;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/messagedecoder.md

@@ -11,9 +11,7 @@
 
 {% callout type="caution" variation="normal" %}
 
-This API is deprecated:
-
-the new chat API doesn't rely on encoders and decoders anymore and uses a dedicated chat API instead
+This API is deprecated: the new chat API doesn't rely on encoders and decoders anymore and uses a dedicated chat API instead
 
 {% /callout %}
 
@@ -22,5 +20,3 @@ the new chat API doesn't rely on encoders and decoders anymore and uses a dedica
 ```typescript
 export type MessageDecoder = (message: Uint8Array) => LegacyReceivedChatMessage;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/messageencoder.md

@@ -11,9 +11,7 @@
 
 {% callout type="caution" variation="normal" %}
 
-This API is deprecated:
-
-the new chat API doesn't rely on encoders and decoders anymore and uses a dedicated chat API instead
+This API is deprecated: the new chat API doesn't rely on encoders and decoders anymore and uses a dedicated chat API instead
 
 {% /callout %}
 
@@ -22,5 +20,3 @@ the new chat API doesn't rely on encoders and decoders anymore and uses a dedica
 ```typescript
 export type MessageEncoder = (message: LegacyChatMessage) => Uint8Array;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/messageformatter.md

@@ -14,5 +14,3 @@
 ```typescript
 export type MessageFormatter = (message: string) => React.ReactNode;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

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

package/generated-docs/react/multibandtrackvolumeoptions.analyseroptions.md

@@ -6,6 +6,12 @@
 
 # MultiBandTrackVolumeOptions.analyserOptions property
 
+{% callout type="note" variation="normal" %}
+
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+
+{% /callout %}
+
 **Signature:**
 
 ```typescript

package/generated-docs/react/multibandtrackvolumeoptions.bands.md

@@ -6,6 +6,12 @@
 
 # MultiBandTrackVolumeOptions.bands property
 
+{% callout type="note" variation="normal" %}
+
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+
+{% /callout %}
+
 **Signature:**
 
 ```typescript

package/generated-docs/react/multibandtrackvolumeoptions.hipass.md

@@ -6,6 +6,12 @@
 
 # MultiBandTrackVolumeOptions.hiPass property
 
+{% callout type="note" variation="normal" %}
+
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+
+{% /callout %}
+
 cut off of frequency bins on the higher end Note: this is not a frequency measure, but in relation to analyserOptions.fftSize,
 
 **Signature:**
@@ -13,5 +19,3 @@ cut off of frequency bins on the higher end Note: this is not a frequency measur
 ```typescript
 hiPass?: number;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/multibandtrackvolumeoptions.lopass.md

@@ -6,6 +6,12 @@
 
 # MultiBandTrackVolumeOptions.loPass property
 
+{% callout type="note" variation="normal" %}
+
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+
+{% /callout %}
+
 cut off of frequency bins on the lower end Note: this is not a frequency measure, but in relation to analyserOptions.fftSize,
 
 **Signature:**
@@ -13,5 +19,3 @@ cut off of frequency bins on the lower end Note: this is not a frequency measure
 ```typescript
 loPass?: number;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/multibandtrackvolumeoptions.md

@@ -9,6 +9,12 @@
 
 # MultiBandTrackVolumeOptions interface
 
+{% callout type="note" variation="normal" %}
+
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+
+{% /callout %}
+
 Interface for configuring options for the useMultibandTrackVolume hook.
 
 **Signature:**
@@ -17,8 +23,6 @@ Interface for configuring options for the useMultibandTrackVolume hook.
 export interface MultiBandTrackVolumeOptions
 ```
 
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
-
 ## Properties
 
 | Property                                                                   | Type            | Description                                                                                                                                 |

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

@@ -6,6 +6,12 @@
 
 # MultiBandTrackVolumeOptions.updateInterval property
 
+{% callout type="note" variation="normal" %}
+
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+
+{% /callout %}
+
 update should run every x ms
 
 **Signature:**
@@ -13,5 +19,3 @@ update should run every x ms
 ```typescript
 updateInterval?: number;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/participantidentifier.md

@@ -9,7 +9,11 @@
 
 # ParticipantIdentifier type
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
 
 **Signature:**
 
@@ -22,5 +26,3 @@ export type ParticipantIdentifier = RequireAtLeastOne<
   "identity" | "kind"
 >;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -13,5 +13,3 @@ The template component to be used in the loop.
 ```typescript
 children: React.ReactNode;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/participantloopprops.md

@@ -15,8 +15,6 @@
 export interface ParticipantLoopProps
 ```
 
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
-
 ## Properties
 
 | Property                                                     | Type            | Description                                                                                 |

package/generated-docs/react/participantloopprops.participants.md

@@ -13,5 +13,3 @@ The participants to loop over. Use `useParticipants()` hook to get participants.
 ```typescript
 participants: Participant[];
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/participantnameprops.md

@@ -16,5 +16,3 @@ export interface ParticipantNameProps extends React.HTMLAttributes<HTMLSpanEleme
 ```
 
 **Extends:** React.HTMLAttributes&lt;HTMLSpanElement&gt;, [UseParticipantInfoOptions](./react/useparticipantinfooptions.md)
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/participanttileprops.md

@@ -17,8 +17,6 @@ export interface ParticipantTileProps extends React.HTMLAttributes<HTMLDivElemen
 
 **Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;
 
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
-
 ## Properties
 
 | Property                                                                              | Type                                                                  | Description                                  |

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

@@ -13,5 +13,3 @@ The track reference to display.
 ```typescript
 trackRef?: TrackReferenceOrPlaceholder;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/pinstate.md

@@ -16,5 +16,3 @@ export type PinState = TrackReferenceOrPlaceholder[];
 ```
 
 **References:** [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md)
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/prejoinprops.debug.md

@@ -13,5 +13,3 @@ Display a debug window for your convenience.
 ```typescript
 debug?: boolean;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/prejoinprops.defaults.md

@@ -13,5 +13,3 @@ Prefill the input form with initial values.
 ```typescript
 defaults?: Partial<LocalUserChoices>;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/prejoinprops.md

@@ -19,8 +19,6 @@ export interface PreJoinProps extends Omit<React.HTMLAttributes<HTMLDivElement>,
 
 **Extends:** Omit&lt;React.HTMLAttributes&lt;HTMLDivElement&gt;, 'onSubmit' \| 'onError'&gt;
 
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
-
 ## Properties
 
 | Property                                                          | Type                                                                            | Description                                                                                                                                |
@@ -35,3 +33,4 @@ export interface PreJoinProps extends Omit<React.HTMLAttributes<HTMLDivElement>,
 | [onValidate?](./react/prejoinprops.onvalidate.md)                 | (values: [LocalUserChoices](./react/localuserchoices.md)<!-- -->) =&gt; boolean | _(Optional)_ Provide your custom validation function. Only if validation is successful the user choices are past to the onSubmit callback. |
 | [persistUserChoices?](./react/prejoinprops.persistuserchoices.md) | boolean                                                                         | _(Optional)_ If true, user choices are persisted across sessions.                                                                          |
 | [userLabel?](./react/prejoinprops.userlabel.md)                   | string                                                                          | _(Optional)_                                                                                                                               |
+| [videoProcessor?](./react/prejoinprops.videoprocessor.md)         | TrackProcessor&lt;Track.Kind.Video&gt;                                          | _(Optional)_                                                                                                                               |

package/generated-docs/react/prejoinprops.onsubmit.md

@@ -13,5 +13,3 @@ This function is called with the `LocalUserChoices` if validation is passed.
 ```typescript
 onSubmit?: (values: LocalUserChoices) => void;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/prejoinprops.onvalidate.md

@@ -13,5 +13,3 @@ Provide your custom validation function. Only if validation is successful the us
 ```typescript
 onValidate?: (values: LocalUserChoices) => boolean;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}