@livekit/components-js-docs 0.0.0-20251021151641

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

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

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

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

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

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

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

@@ -0,0 +1,15 @@
+---
+{ "title": "LiveKitRoomProps.options property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# LiveKitRoomProps.options property
+
+Options for when creating a new room. When you pass your own room instance to this component, these options have no effect. Instead, set the options directly in the room instance.
+
+**Signature:**
+
+```typescript
+options?: RoomOptions;
+```

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

@@ -0,0 +1,15 @@
+---
+{ "title": "LiveKitRoomProps.room property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# LiveKitRoomProps.room property
+
+Optional room instance. By passing your own room instance you overwrite the `options` parameter, make sure to set the options directly on the room instance itself.
+
+**Signature:**
+
+```typescript
+room?: Room;
+```

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

@@ -0,0 +1,15 @@
+---
+{ "title": "LiveKitRoomProps.screen property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# LiveKitRoomProps.screen property
+
+Publish screen share immediately after connecting to your LiveKit room.
+
+**Signature:**
+
+```typescript
+screen?: ScreenShareCaptureOptions | boolean;
+```

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

@@ -0,0 +1,15 @@
+---
+{ "title": "LiveKitRoomProps.serverUrl property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# LiveKitRoomProps.serverUrl property
+
+URL to the LiveKit server. For example: `wss://<domain>.livekit.cloud` To simplify the implementation, `undefined` is also accepted as an intermediate value, but only with a valid string url can the connection be established.
+
+**Signature:**
+
+```typescript
+serverUrl: string | undefined;
+```

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

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

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

@@ -0,0 +1,15 @@
+---
+{ "title": "LiveKitRoomProps.token property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# LiveKitRoomProps.token property
+
+A user specific access token for a client to authenticate to the room. This token is necessary to establish a connection to the room. To simplify the implementation, `undefined` is also accepted as an intermediate value, but only with a valid string token can the connection be established.
+
+**Signature:**
+
+```typescript
+token: string | undefined;
+```

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

@@ -0,0 +1,15 @@
+---
+{ "title": "LiveKitRoomProps.video property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# LiveKitRoomProps.video property
+
+Publish video immediately after connecting to your LiveKit room.
+
+**Signature:**
+
+```typescript
+video?: VideoCaptureOptions | boolean;
+```

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

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

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

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

package/generated-docs/react/mediadevicemenuprops.md

@@ -0,0 +1,28 @@
+---
+{
+  "title": "MediaDeviceMenuProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/prefabs/MediaDeviceMenu.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# MediaDeviceMenuProps interface
+
+**Signature:**
+
+```typescript
+export interface MediaDeviceMenuProps extends React.ButtonHTMLAttributes<HTMLButtonElement>
+```
+
+**Extends:** React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt;
+
+## Properties
+
+| Property                                                                      | Type                                                                                          | Description                                                                                                                                                                                                                                                                                                                                              |
+| ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [initialSelection?](./react/mediadevicemenuprops.initialselection.md)         | string                                                                                        | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
+| [kind?](./react/mediadevicemenuprops.kind.md)                                 | MediaDeviceKind                                                                               | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
+| [onActiveDeviceChange?](./react/mediadevicemenuprops.onactivedevicechange.md) | (kind: MediaDeviceKind, deviceId: string) =&gt; void                                          | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
+| [requestPermissions?](./react/mediadevicemenuprops.requestpermissions.md)     | boolean                                                                                       | _(Optional)_ this will call getUserMedia if the permissions are not yet given to enumerate the devices with device labels. in some browsers multiple calls to getUserMedia result in multiple permission prompts. It's generally advised only flip this to true, once a (preview) track has been acquired successfully with the appropriate permissions. |
+| [tracks?](./react/mediadevicemenuprops.tracks.md)                             | Partial&lt;Record&lt;MediaDeviceKind, LocalAudioTrack \| LocalVideoTrack \| undefined&gt;&gt; | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |

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

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

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

@@ -0,0 +1,15 @@
+---
+{ "title": "MediaDeviceMenuProps.requestPermissions property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# MediaDeviceMenuProps.requestPermissions property
+
+this will call getUserMedia if the permissions are not yet given to enumerate the devices with device labels. in some browsers multiple calls to getUserMedia result in multiple permission prompts. It's generally advised only flip this to true, once a (preview) track has been acquired successfully with the appropriate permissions.
+
+**Signature:**
+
+```typescript
+requestPermissions?: boolean;
+```

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

@@ -0,0 +1,13 @@
+---
+{ "title": "MediaDeviceMenuProps.tracks property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# MediaDeviceMenuProps.tracks property
+
+**Signature:**
+
+```typescript
+tracks?: Partial<Record<MediaDeviceKind, LocalAudioTrack | LocalVideoTrack | undefined>>;
+```

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

@@ -0,0 +1,15 @@
+---
+{ "title": "MediaDeviceSelectProps.exactMatch property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# MediaDeviceSelectProps.exactMatch property
+
+will force the browser to only return the specified device will call `onDeviceSelectError` with the error in case this fails
+
+**Signature:**
+
+```typescript
+exactMatch?: boolean;
+```

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

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

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

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

package/generated-docs/react/mediadeviceselectprops.md

@@ -0,0 +1,32 @@
+---
+{
+  "title": "MediaDeviceSelectProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/controls/MediaDeviceSelect.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# MediaDeviceSelectProps interface
+
+**Signature:**
+
+```typescript
+export interface MediaDeviceSelectProps extends Omit<React.HTMLAttributes<HTMLUListElement>, 'onError'>
+```
+
+**Extends:** Omit&lt;React.HTMLAttributes&lt;HTMLUListElement&gt;, 'onError'&gt;
+
+## Properties
+
+| Property                                                                        | Type                                      | Description                                                                                                                                                                                                                                                                                                                                              |
+| ------------------------------------------------------------------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [exactMatch?](./react/mediadeviceselectprops.exactmatch.md)                     | boolean                                   | _(Optional)_ will force the browser to only return the specified device will call <code>onDeviceSelectError</code> with the error in case this fails                                                                                                                                                                                                     |
+| [initialSelection?](./react/mediadeviceselectprops.initialselection.md)         | string                                    | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
+| [kind](./react/mediadeviceselectprops.kind.md)                                  | MediaDeviceKind                           |                                                                                                                                                                                                                                                                                                                                                          |
+| [onActiveDeviceChange?](./react/mediadeviceselectprops.onactivedevicechange.md) | (deviceId: string) =&gt; void             | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
+| [onDeviceListChange?](./react/mediadeviceselectprops.ondevicelistchange.md)     | (devices: MediaDeviceInfo\[\]) =&gt; void | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
+| [onDeviceSelectError?](./react/mediadeviceselectprops.ondeviceselecterror.md)   | (e: Error) =&gt; void                     | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
+| [onError?](./react/mediadeviceselectprops.onerror.md)                           | (e: Error) =&gt; void                     | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
+| [requestPermissions?](./react/mediadeviceselectprops.requestpermissions.md)     | boolean                                   | _(Optional)_ this will call getUserMedia if the permissions are not yet given to enumerate the devices with device labels. in some browsers multiple calls to getUserMedia result in multiple permission prompts. It's generally advised only flip this to true, once a (preview) track has been acquired successfully with the appropriate permissions. |
+| [track?](./react/mediadeviceselectprops.track.md)                               | LocalAudioTrack \| LocalVideoTrack        | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,15 @@
+---
+{ "title": "MediaDeviceSelectProps.requestPermissions property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# MediaDeviceSelectProps.requestPermissions property
+
+this will call getUserMedia if the permissions are not yet given to enumerate the devices with device labels. in some browsers multiple calls to getUserMedia result in multiple permission prompts. It's generally advised only flip this to true, once a (preview) track has been acquired successfully with the appropriate permissions.
+
+**Signature:**
+
+```typescript
+requestPermissions?: boolean;
+```

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

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

package/generated-docs/react/messageformatter.md

@@ -0,0 +1,16 @@
+---
+{
+  "title": "MessageFormatter type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/ChatEntry.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# MessageFormatter type
+
+**Signature:**
+
+```typescript
+export type MessageFormatter = (message: string) => React.ReactNode;
+```

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

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

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

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

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

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

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

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

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

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

package/generated-docs/react/multibandtrackvolumeoptions.md

@@ -0,0 +1,34 @@
+---
+{
+  "title": "MultiBandTrackVolumeOptions interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTrackVolume.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# 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:**
+
+```typescript
+export interface MultiBandTrackVolumeOptions
+```
+
+## Properties
+
+| Property                                                                   | Type            | Description                                                                                                                                 |
+| -------------------------------------------------------------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
+| [analyserOptions?](./react/multibandtrackvolumeoptions.analyseroptions.md) | AnalyserOptions | _(Optional)_                                                                                                                                |
+| [bands?](./react/multibandtrackvolumeoptions.bands.md)                     | number          | _(Optional)_                                                                                                                                |
+| [hiPass?](./react/multibandtrackvolumeoptions.hipass.md)                   | number          | _(Optional)_ cut off of frequency bins on the higher end Note: this is not a frequency measure, but in relation to analyserOptions.fftSize, |
+| [loPass?](./react/multibandtrackvolumeoptions.lopass.md)                   | number          | _(Optional)_ cut off of frequency bins on the lower end Note: this is not a frequency measure, but in relation to analyserOptions.fftSize,  |
+| [updateInterval?](./react/multibandtrackvolumeoptions.updateinterval.md)   | number          | _(Optional)_ update should run every x ms                                                                                                   |

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

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

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

@@ -0,0 +1,15 @@
+---
+{ "title": "ParticipantLoopProps.children property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# ParticipantLoopProps.children property
+
+The template component to be used in the loop.
+
+**Signature:**
+
+```typescript
+children: React.ReactNode;
+```