@livekit/components-js-docs 0.1.61 → 0.1.62

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. package/generated-docs/react/audiotrackprops.md +6 -6
  2. package/generated-docs/react/audiovisualizerprops.md +3 -3
  3. package/generated-docs/react/barvisualizerprops.md +7 -7
  4. package/generated-docs/react/carousellayoutprops.md +5 -5
  5. package/generated-docs/react/chatentryprops.md +6 -6
  6. package/generated-docs/react/chatprops.md +1 -1
  7. package/generated-docs/react/focuslayoutprops.md +4 -4
  8. package/generated-docs/react/focustoggleprops.md +3 -3
  9. package/generated-docs/react/gridlayoutprops.md +4 -4
  10. package/generated-docs/react/hook/usemediadeviceselect.md +1 -1
  11. package/generated-docs/react/hook/usetrackbyname.md +1 -1
  12. package/generated-docs/react/hook/usetracktoggle.md +1 -3
  13. package/generated-docs/react/hook/usetranscriptions.md +1 -1
  14. package/generated-docs/react/layoutcontextproviderprops.md +5 -5
  15. package/generated-docs/react/participanttileprops.md +5 -5
  16. package/generated-docs/react/prejoinprops.md +13 -13
  17. package/generated-docs/react/trackloopprops.md +4 -4
  18. package/generated-docs/react/trackmutedindicatorprops.md +4 -4
  19. package/generated-docs/react/tracktoggleprops.md +9 -9
  20. package/generated-docs/react/usefocustoggleprops.md +4 -4
  21. package/generated-docs/react/usekrispnoisefilteroptions.md +3 -3
  22. package/generated-docs/react/useparticipanttileprops.md +6 -6
  23. package/generated-docs/react/usepersistentuserchoicesoptions.md +5 -5
  24. package/generated-docs/react/usetrackshookreturntype.md +2 -0
  25. package/generated-docs/react/usevisualstableupdateoptions.md +3 -3
  26. package/generated-docs/react/videoconferenceprops.md +2 -2
  27. package/generated-docs/react/videotrackprops.md +6 -6
  28. package/generated-docs/react/voiceassistant.md +8 -8
  29. package/package.json +2 -2
package/generated-docs/react/audiotrackprops.md CHANGED
@@ -19,9 +19,9 @@ export interface AudioTrackProps extends React.AudioHTMLAttributes<HTMLAudioElem
19
19
 
20
20
  ## Properties
21
21
 
22
- | Property | Type | Description |
23
- | -------------------------------------------------------------------------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
24
- | [muted?](./react/audiotrackprops.muted.md) | boolean | _(Optional)_ Mutes the audio track if set to <code>true</code>. |
25
- | [onSubscriptionStatusChanged?](./react/audiotrackprops.onsubscriptionstatuschanged.md) | (subscribed: boolean) =&gt; void | _(Optional)_ |
26
- | [trackRef?](./react/audiotrackprops.trackref.md) | TrackReference | _(Optional)_ The track reference of the track from which the audio is to be rendered. |
27
- | [volume?](./react/audiotrackprops.volume.md) | number | _(Optional)_ Sets the volume of the audio track. By default, the range is between <code>0.0</code> and <code>1.0</code>. |
22
+ | Property | Type | Description |
23
+ | -------------------------------------------------------------------------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
24
+ | [muted?](./react/audiotrackprops.muted.md) | boolean | _(Optional)_ Mutes the audio track if set to <code>true</code>. |
25
+ | [onSubscriptionStatusChanged?](./react/audiotrackprops.onsubscriptionstatuschanged.md) | (subscribed: boolean) =&gt; void | _(Optional)_ |
26
+ | [trackRef?](./react/audiotrackprops.trackref.md) | [TrackReference](./core/trackreference.md) | _(Optional)_ The track reference of the track from which the audio is to be rendered. |
27
+ | [volume?](./react/audiotrackprops.volume.md) | number | _(Optional)_ Sets the volume of the audio track. By default, the range is between <code>0.0</code> and <code>1.0</code>. |
package/generated-docs/react/audiovisualizerprops.md CHANGED
@@ -25,6 +25,6 @@ export interface AudioVisualizerProps extends React.HTMLAttributes<SVGElement>
25
25
 
26
26
  ## Properties
27
27
 
28
- | Property | Type | Description |
29
- | ----------------------------------------------------- | -------------- | ------------ |
30
- | [trackRef?](./react/audiovisualizerprops.trackref.md) | TrackReference | _(Optional)_ |
28
+ | Property | Type | Description |
29
+ | ----------------------------------------------------- | ------------------------------------------ | ------------ |
30
+ | [trackRef?](./react/audiovisualizerprops.trackref.md) | [TrackReference](./core/trackreference.md) | _(Optional)_ |
package/generated-docs/react/barvisualizerprops.md CHANGED
@@ -25,10 +25,10 @@ export interface BarVisualizerProps extends React.HTMLProps<HTMLDivElement>
25
25
 
26
26
  ## Properties
27
27
 
28
- | Property | Type | Description |
29
- | --------------------------------------------------- | ------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
30
- | [barCount?](./react/barvisualizerprops.barcount.md) | number | **_(BETA)_** _(Optional)_ Number of bars that show up in the visualizer |
31
- | [children?](./react/barvisualizerprops.children.md) | React.ReactNode | **_(BETA)_** _(Optional)_ The template component to be used in the visualizer. |
32
- | [options?](./react/barvisualizerprops.options.md) | [BarVisualizerOptions](./react/barvisualizeroptions.md) | **_(BETA)_** _(Optional)_ |
33
- | [state?](./react/barvisualizerprops.state.md) | [AgentState](./react/agentstate.md) | **_(BETA)_** _(Optional)_ If set, the visualizer will transition between different voice assistant states |
34
- | [trackRef?](./react/barvisualizerprops.trackref.md) | TrackReferenceOrPlaceholder | **_(BETA)_** _(Optional)_ |
28
+ | Property | Type | Description |
29
+ | --------------------------------------------------- | -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
30
+ | [barCount?](./react/barvisualizerprops.barcount.md) | number | **_(BETA)_** _(Optional)_ Number of bars that show up in the visualizer |
31
+ | [children?](./react/barvisualizerprops.children.md) | React.ReactNode | **_(BETA)_** _(Optional)_ The template component to be used in the visualizer. |
32
+ | [options?](./react/barvisualizerprops.options.md) | [BarVisualizerOptions](./react/barvisualizeroptions.md) | **_(BETA)_** _(Optional)_ |
33
+ | [state?](./react/barvisualizerprops.state.md) | [AgentState](./react/agentstate.md) | **_(BETA)_** _(Optional)_ If set, the visualizer will transition between different voice assistant states |
34
+ | [trackRef?](./react/barvisualizerprops.trackref.md) | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) | **_(BETA)_** _(Optional)_ |
package/generated-docs/react/carousellayoutprops.md CHANGED
@@ -19,8 +19,8 @@ export interface CarouselLayoutProps extends React.HTMLAttributes<HTMLMediaEleme
19
19
 
20
20
  ## Properties
21
21
 
22
- | Property | Type | Description |
23
- | ---------------------------------------------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
24
- | [children](./react/carousellayoutprops.children.md) | React.ReactNode | |
25
- | [orientation?](./react/carousellayoutprops.orientation.md) | 'vertical' \| 'horizontal' | _(Optional)_ Place the tiles vertically or horizontally next to each other. If undefined orientation is guessed by the dimensions of the container. |
26
- | [tracks](./react/carousellayoutprops.tracks.md) | TrackReferenceOrPlaceholder\[\] | |
22
+ | Property | Type | Description |
23
+ | ---------------------------------------------------------- | -------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
24
+ | [children](./react/carousellayoutprops.children.md) | React.ReactNode | |
25
+ | [orientation?](./react/carousellayoutprops.orientation.md) | 'vertical' \| 'horizontal' | _(Optional)_ Place the tiles vertically or horizontally next to each other. If undefined orientation is guessed by the dimensions of the container. |
26
+ | [tracks](./react/carousellayoutprops.tracks.md) | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\] | |
package/generated-docs/react/chatentryprops.md CHANGED
@@ -21,9 +21,9 @@ export interface ChatEntryProps extends React.HTMLAttributes<HTMLLIElement>
21
21
 
22
22
  ## Properties
23
23
 
24
- | Property | Type | Description |
25
- | --------------------------------------------------------------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
26
- | [entry](./react/chatentryprops.entry.md) | ReceivedChatMessage | The chat massage object to display. |
27
- | [hideName?](./react/chatentryprops.hidename.md) | boolean | _(Optional)_ Hide sender name. Useful when displaying multiple consecutive chat messages from the same person. |
28
- | [hideTimestamp?](./react/chatentryprops.hidetimestamp.md) | boolean | _(Optional)_ Hide message timestamp. |
29
- | [messageFormatter?](./react/chatentryprops.messageformatter.md) | [MessageFormatter](./react/messageformatter.md) | _(Optional)_ An optional formatter for the message body. |
24
+ | Property | Type | Description |
25
+ | --------------------------------------------------------------- | ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
26
+ | [entry](./react/chatentryprops.entry.md) | [ReceivedChatMessage](./core/receivedchatmessage.md) | The chat massage object to display. |
27
+ | [hideName?](./react/chatentryprops.hidename.md) | boolean | _(Optional)_ Hide sender name. Useful when displaying multiple consecutive chat messages from the same person. |
28
+ | [hideTimestamp?](./react/chatentryprops.hidetimestamp.md) | boolean | _(Optional)_ Hide message timestamp. |
29
+ | [messageFormatter?](./react/chatentryprops.messageformatter.md) | [MessageFormatter](./react/messageformatter.md) | _(Optional)_ An optional formatter for the message body. |
package/generated-docs/react/chatprops.md CHANGED
@@ -15,7 +15,7 @@
15
15
  export interface ChatProps extends React.HTMLAttributes<HTMLDivElement>, ChatOptions
16
16
  ```
17
17
 
18
- **Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;, ChatOptions
18
+ **Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;, [ChatOptions](./core/chatoptions.md)
19
19
 
20
20
  ## Properties
21
21
 
package/generated-docs/react/focuslayoutprops.md CHANGED
@@ -19,7 +19,7 @@ export interface FocusLayoutProps extends React.HTMLAttributes<HTMLElement>
19
19
 
20
20
  ## Properties
21
21
 
22
- | Property | Type | Description |
23
- | --------------------------------------------------------------------- | --------------------------------------- | ------------------------------------------------------ |
24
- | [onParticipantClick?](./react/focuslayoutprops.onparticipantclick.md) | (evt: ParticipantClickEvent) =&gt; void | _(Optional)_ |
25
- | [trackRef?](./react/focuslayoutprops.trackref.md) | TrackReferenceOrPlaceholder | _(Optional)_ The track to display in the focus layout. |
22
+ | Property | Type | Description |
23
+ | --------------------------------------------------------------------- | -------------------------------------------------------------------- | ------------------------------------------------------ |
24
+ | [onParticipantClick?](./react/focuslayoutprops.onparticipantclick.md) | (evt: ParticipantClickEvent) =&gt; void | _(Optional)_ |
25
+ | [trackRef?](./react/focuslayoutprops.trackref.md) | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) | _(Optional)_ The track to display in the focus layout. |
package/generated-docs/react/focustoggleprops.md CHANGED
@@ -19,6 +19,6 @@ export interface FocusToggleProps extends React.ButtonHTMLAttributes<HTMLButtonE
19
19
 
20
20
  ## Properties
21
21
 
22
- | Property | Type | Description |
23
- | ------------------------------------------------- | --------------------------- | ------------ |
24
- | [trackRef?](./react/focustoggleprops.trackref.md) | TrackReferenceOrPlaceholder | _(Optional)_ |
22
+ | Property | Type | Description |
23
+ | ------------------------------------------------- | -------------------------------------------------------------------- | ------------ |
24
+ | [trackRef?](./react/focustoggleprops.trackref.md) | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) | _(Optional)_ |
package/generated-docs/react/gridlayoutprops.md CHANGED
@@ -19,7 +19,7 @@ export interface GridLayoutProps extends React.HTMLAttributes<HTMLDivElement>, P
19
19
 
20
20
  ## Properties
21
21
 
22
- | Property | Type | Description |
23
- | ----------------------------------------------- | ------------------------------- | ----------- |
24
- | [children](./react/gridlayoutprops.children.md) | React.ReactNode | |
25
- | [tracks](./react/gridlayoutprops.tracks.md) | TrackReferenceOrPlaceholder\[\] | |
22
+ | Property | Type | Description |
23
+ | ----------------------------------------------- | -------------------------------------------------------------------------------- | ----------- |
24
+ | [children](./react/gridlayoutprops.children.md) | React.ReactNode | |
25
+ | [tracks](./react/gridlayoutprops.tracks.md) | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\] | |
package/generated-docs/react/hook/usemediadeviceselect.md CHANGED
@@ -53,6 +53,6 @@ this will call getUserMedia if the permissions are not yet given to enumerate th
53
53
  devices: MediaDeviceInfo[];
54
54
  className: string;
55
55
  activeDeviceId: string;
56
- setActiveMediaDevice: (id: string, options?: import('../../packages/core/dist/index.d.ts').SetMediaDeviceOptions) => Promise<void>;
56
+ setActiveMediaDevice: (id: string, options?: import('@livekit/components-core').SetMediaDeviceOptions) => Promise<void>;
57
57
  }
58
58
  ```
package/generated-docs/react/hook/usetrackbyname.md CHANGED
@@ -28,5 +28,5 @@ import { useTrackByName } from "@livekit/components-react";
28
28
  ## Returns
29
29
 
30
30
  ```typescript
31
- import("../../packages/core/dist/index.d.ts").TrackReferenceOrPlaceholder;
31
+ import("@livekit/components-core").TrackReferenceOrPlaceholder;
32
32
  ```
package/generated-docs/react/hook/usetracktoggle.md CHANGED
@@ -31,9 +31,7 @@ return <button {...buttonProps}>{enabled ? "disable" : "enable"}</button>;
31
31
  toggle: ((forceState?: boolean) => Promise<void>) |
32
32
  ((
33
33
  forceState?: boolean,
34
- captureOptions?:
35
- | import("../../packages/core/dist/index.d.ts").CaptureOptionsBySource<T>
36
- | undefined
34
+ captureOptions?: import("@livekit/components-core").CaptureOptionsBySource<T> | undefined
37
35
  ) => Promise<boolean | undefined>);
38
36
  enabled: boolean;
39
37
  pending: boolean;
package/generated-docs/react/hook/usetranscriptions.md CHANGED
@@ -41,5 +41,5 @@ return <div>{transcriptions.map((transcription) => transcription.text)}</div>;
41
41
  ## Returns
42
42
 
43
43
  ```typescript
44
- import('../../packages/core/dist/index.d.ts').TextStreamData[]
44
+ import('@livekit/components-core').TextStreamData[]
45
45
  ```
package/generated-docs/react/layoutcontextproviderprops.md CHANGED
@@ -23,8 +23,8 @@ export interface LayoutContextProviderProps
23
23
 
24
24
  ## Properties
25
25
 
26
- | Property | Type | Description |
27
- | ----------------------------------------------------------------------- | ------------------------------------------------- | ------------ |
28
- | [onPinChange?](./react/layoutcontextproviderprops.onpinchange.md) | (state: PinState) =&gt; void | _(Optional)_ |
29
- | [onWidgetChange?](./react/layoutcontextproviderprops.onwidgetchange.md) | (state: WidgetState) =&gt; void | _(Optional)_ |
30
- | [value?](./react/layoutcontextproviderprops.value.md) | [LayoutContextType](./react/layoutcontexttype.md) | _(Optional)_ |
26
+ | Property | Type | Description |
27
+ | ----------------------------------------------------------------------- | ---------------------------------------------------------------- | ------------ |
28
+ | [onPinChange?](./react/layoutcontextproviderprops.onpinchange.md) | (state: [PinState](./core/pinstate.md)<!-- -->) =&gt; void | _(Optional)_ |
29
+ | [onWidgetChange?](./react/layoutcontextproviderprops.onwidgetchange.md) | (state: [WidgetState](./core/widgetstate.md)<!-- -->) =&gt; void | _(Optional)_ |
30
+ | [value?](./react/layoutcontextproviderprops.value.md) | [LayoutContextType](./react/layoutcontexttype.md) | _(Optional)_ |
package/generated-docs/react/participanttileprops.md CHANGED
@@ -19,8 +19,8 @@ export interface ParticipantTileProps extends React.HTMLAttributes<HTMLDivElemen
19
19
 
20
20
  ## Properties
21
21
 
22
- | Property | Type | Description |
23
- | ------------------------------------------------------------------------------------- | ----------------------------------------- | -------------------------------------------- |
24
- | [disableSpeakingIndicator?](./react/participanttileprops.disablespeakingindicator.md) | boolean | _(Optional)_ |
25
- | [onParticipantClick?](./react/participanttileprops.onparticipantclick.md) | (event: ParticipantClickEvent) =&gt; void | _(Optional)_ |
26
- | [trackRef?](./react/participanttileprops.trackref.md) | TrackReferenceOrPlaceholder | _(Optional)_ The track reference to display. |
22
+ | Property | Type | Description |
23
+ | ------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------- |
24
+ | [disableSpeakingIndicator?](./react/participanttileprops.disablespeakingindicator.md) | boolean | _(Optional)_ |
25
+ | [onParticipantClick?](./react/participanttileprops.onparticipantclick.md) | (event: ParticipantClickEvent) =&gt; void | _(Optional)_ |
26
+ | [trackRef?](./react/participanttileprops.trackref.md) | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) | _(Optional)_ The track reference to display. |
package/generated-docs/react/prejoinprops.md CHANGED
@@ -21,16 +21,16 @@ export interface PreJoinProps extends Omit<React.HTMLAttributes<HTMLDivElement>,
21
21
 
22
22
  ## Properties
23
23
 
24
- | Property | Type | Description |
25
- | ----------------------------------------------------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
26
- | [camLabel?](./react/prejoinprops.camlabel.md) | string | _(Optional)_ |
27
- | [debug?](./react/prejoinprops.debug.md) | boolean | _(Optional)_ Display a debug window for your convenience. |
28
- | [defaults?](./react/prejoinprops.defaults.md) | Partial&lt;LocalUserChoices&gt; | _(Optional)_ Prefill the input form with initial values. |
29
- | [joinLabel?](./react/prejoinprops.joinlabel.md) | string | _(Optional)_ |
30
- | [micLabel?](./react/prejoinprops.miclabel.md) | string | _(Optional)_ |
31
- | [onError?](./react/prejoinprops.onerror.md) | (error: Error) =&gt; void | _(Optional)_ |
32
- | [onSubmit?](./react/prejoinprops.onsubmit.md) | (values: LocalUserChoices) =&gt; void | _(Optional)_ This function is called with the <code>LocalUserChoices</code> if validation is passed. |
33
- | [onValidate?](./react/prejoinprops.onvalidate.md) | (values: LocalUserChoices) =&gt; boolean | _(Optional)_ Provide your custom validation function. Only if validation is successful the user choices are past to the onSubmit callback. |
34
- | [persistUserChoices?](./react/prejoinprops.persistuserchoices.md) | boolean | _(Optional)_ If true, user choices are persisted across sessions. |
35
- | [userLabel?](./react/prejoinprops.userlabel.md) | string | _(Optional)_ |
36
- | [videoProcessor?](./react/prejoinprops.videoprocessor.md) | TrackProcessor&lt;Track.Kind.Video&gt; | _(Optional)_ |
24
+ | Property | Type | Description |
25
+ | ----------------------------------------------------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
26
+ | [camLabel?](./react/prejoinprops.camlabel.md) | string | _(Optional)_ |
27
+ | [debug?](./react/prejoinprops.debug.md) | boolean | _(Optional)_ Display a debug window for your convenience. |
28
+ | [defaults?](./react/prejoinprops.defaults.md) | Partial&lt;[LocalUserChoices](./core/localuserchoices.md)<!-- -->&gt; | _(Optional)_ Prefill the input form with initial values. |
29
+ | [joinLabel?](./react/prejoinprops.joinlabel.md) | string | _(Optional)_ |
30
+ | [micLabel?](./react/prejoinprops.miclabel.md) | string | _(Optional)_ |
31
+ | [onError?](./react/prejoinprops.onerror.md) | (error: Error) =&gt; void | _(Optional)_ |
32
+ | [onSubmit?](./react/prejoinprops.onsubmit.md) | (values: [LocalUserChoices](./core/localuserchoices.md)<!-- -->) =&gt; void | _(Optional)_ This function is called with the <code>LocalUserChoices</code> if validation is passed. |
33
+ | [onValidate?](./react/prejoinprops.onvalidate.md) | (values: [LocalUserChoices](./core/localuserchoices.md)<!-- -->) =&gt; boolean | _(Optional)_ Provide your custom validation function. Only if validation is successful the user choices are past to the onSubmit callback. |
34
+ | [persistUserChoices?](./react/prejoinprops.persistuserchoices.md) | boolean | _(Optional)_ If true, user choices are persisted across sessions. |
35
+ | [userLabel?](./react/prejoinprops.userlabel.md) | string | _(Optional)_ |
36
+ | [videoProcessor?](./react/prejoinprops.videoprocessor.md) | TrackProcessor&lt;Track.Kind.Video&gt; | _(Optional)_ |
package/generated-docs/react/trackloopprops.md CHANGED
@@ -17,7 +17,7 @@ export interface TrackLoopProps
17
17
 
18
18
  ## Properties
19
19
 
20
- | Property | Type | Description |
21
- | ---------------------------------------------- | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
22
- | [children](./react/trackloopprops.children.md) | React.ReactNode | The template component to be used in the loop. |
23
- | [tracks](./react/trackloopprops.tracks.md) | TrackReference\[\] \| TrackReferenceOrPlaceholder\[\] | Track references to loop over. You can the use <code>useTracks()</code> hook to get TrackReferences. |
20
+ | Property | Type | Description |
21
+ | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------- |
22
+ | [children](./react/trackloopprops.children.md) | React.ReactNode | The template component to be used in the loop. |
23
+ | [tracks](./react/trackloopprops.tracks.md) | [TrackReference](./core/trackreference.md)<!-- -->\[\] \| [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\] | Track references to loop over. You can the use <code>useTracks()</code> hook to get TrackReferences. |
package/generated-docs/react/trackmutedindicatorprops.md CHANGED
@@ -19,7 +19,7 @@ export interface TrackMutedIndicatorProps extends React.HTMLAttributes<HTMLDivEl
19
19
 
20
20
  ## Properties
21
21
 
22
- | Property | Type | Description |
23
- | -------------------------------------------------------- | -------------------------------- | ------------ |
24
- | [show?](./react/trackmutedindicatorprops.show.md) | 'always' \| 'muted' \| 'unmuted' | _(Optional)_ |
25
- | [trackRef](./react/trackmutedindicatorprops.trackref.md) | TrackReferenceOrPlaceholder | |
22
+ | Property | Type | Description |
23
+ | -------------------------------------------------------- | -------------------------------------------------------------------- | ------------ |
24
+ | [show?](./react/trackmutedindicatorprops.show.md) | 'always' \| 'muted' \| 'unmuted' | _(Optional)_ |
25
+ | [trackRef](./react/trackmutedindicatorprops.trackref.md) | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) | |
package/generated-docs/react/tracktoggleprops.md CHANGED
@@ -19,12 +19,12 @@ export interface TrackToggleProps<T extends ToggleSource> extends Omit<React.But
19
19
 
20
20
  ## Properties
21
21
 
22
- | Property | Type | Description |
23
- | ------------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
24
- | [captureOptions?](./react/tracktoggleprops.captureoptions.md) | CaptureOptionsBySource&lt;T&gt; | _(Optional)_ |
25
- | [initialState?](./react/tracktoggleprops.initialstate.md) | boolean | _(Optional)_ |
26
- | [onChange?](./react/tracktoggleprops.onchange.md) | (enabled: boolean, isUserInitiated: boolean) =&gt; void | _(Optional)_ Function that is called when the enabled state of the toggle changes. The second function argument <code>isUserInitiated</code> is <code>true</code> if the change was initiated by a user interaction, such as a click. |
27
- | [onDeviceError?](./react/tracktoggleprops.ondeviceerror.md) | (error: Error) =&gt; void | _(Optional)_ |
28
- | [publishOptions?](./react/tracktoggleprops.publishoptions.md) | TrackPublishOptions | _(Optional)_ |
29
- | [showIcon?](./react/tracktoggleprops.showicon.md) | boolean | _(Optional)_ |
30
- | [source](./react/tracktoggleprops.source.md) | T | |
22
+ | Property | Type | Description |
23
+ | ------------------------------------------------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
24
+ | [captureOptions?](./react/tracktoggleprops.captureoptions.md) | [CaptureOptionsBySource](./core/captureoptionsbysource.md)<!-- -->&lt;T&gt; | _(Optional)_ |
25
+ | [initialState?](./react/tracktoggleprops.initialstate.md) | boolean | _(Optional)_ |
26
+ | [onChange?](./react/tracktoggleprops.onchange.md) | (enabled: boolean, isUserInitiated: boolean) =&gt; void | _(Optional)_ Function that is called when the enabled state of the toggle changes. The second function argument <code>isUserInitiated</code> is <code>true</code> if the change was initiated by a user interaction, such as a click. |
27
+ | [onDeviceError?](./react/tracktoggleprops.ondeviceerror.md) | (error: Error) =&gt; void | _(Optional)_ |
28
+ | [publishOptions?](./react/tracktoggleprops.publishoptions.md) | TrackPublishOptions | _(Optional)_ |
29
+ | [showIcon?](./react/tracktoggleprops.showicon.md) | boolean | _(Optional)_ |
30
+ | [source](./react/tracktoggleprops.source.md) | T | |
package/generated-docs/react/usefocustoggleprops.md CHANGED
@@ -17,7 +17,7 @@ export interface UseFocusToggleProps
17
17
 
18
18
  ## Properties
19
19
 
20
- | Property | Type | Description |
21
- | ---------------------------------------------------- | --------------------------------------------------- | ------------ |
22
- | [props](./react/usefocustoggleprops.props.md) | React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt; | |
23
- | [trackRef?](./react/usefocustoggleprops.trackref.md) | TrackReferenceOrPlaceholder | _(Optional)_ |
20
+ | Property | Type | Description |
21
+ | ---------------------------------------------------- | -------------------------------------------------------------------- | ------------ |
22
+ | [props](./react/usefocustoggleprops.props.md) | React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt; | |
23
+ | [trackRef?](./react/usefocustoggleprops.trackref.md) | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) | _(Optional)_ |
package/generated-docs/react/usekrispnoisefilteroptions.md CHANGED
@@ -23,6 +23,6 @@ export interface useKrispNoiseFilterOptions
23
23
 
24
24
  ## Properties
25
25
 
26
- | Property | Type | Description |
27
- | ----------------------------------------------------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------ |
28
- | [trackRef?](./react/usekrispnoisefilteroptions.trackref.md) | TrackReferenceOrPlaceholder | **_(BETA)_** _(Optional)_ The track reference to use for the noise filter (defaults: local microphone track) |
26
+ | Property | Type | Description |
27
+ | ----------------------------------------------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
28
+ | [trackRef?](./react/usekrispnoisefilteroptions.trackref.md) | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) | **_(BETA)_** _(Optional)_ The track reference to use for the noise filter (defaults: local microphone track) |
package/generated-docs/react/useparticipanttileprops.md CHANGED
@@ -19,9 +19,9 @@ export interface UseParticipantTileProps<T extends HTMLElement> extends React.HT
19
19
 
20
20
  ## Properties
21
21
 
22
- | Property | Type | Description |
23
- | ---------------------------------------------------------------------------------------- | ----------------------------------------- | -------------------------------------------- |
24
- | [disableSpeakingIndicator?](./react/useparticipanttileprops.disablespeakingindicator.md) | boolean | _(Optional)_ |
25
- | [htmlProps](./react/useparticipanttileprops.htmlprops.md) | React.HTMLAttributes&lt;T&gt; | |
26
- | [onParticipantClick?](./react/useparticipanttileprops.onparticipantclick.md) | (event: ParticipantClickEvent) =&gt; void | _(Optional)_ |
27
- | [trackRef?](./react/useparticipanttileprops.trackref.md) | TrackReferenceOrPlaceholder | _(Optional)_ The track reference to display. |
22
+ | Property | Type | Description |
23
+ | ---------------------------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------- |
24
+ | [disableSpeakingIndicator?](./react/useparticipanttileprops.disablespeakingindicator.md) | boolean | _(Optional)_ |
25
+ | [htmlProps](./react/useparticipanttileprops.htmlprops.md) | React.HTMLAttributes&lt;T&gt; | |
26
+ | [onParticipantClick?](./react/useparticipanttileprops.onparticipantclick.md) | (event: ParticipantClickEvent) =&gt; void | _(Optional)_ |
27
+ | [trackRef?](./react/useparticipanttileprops.trackref.md) | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) | _(Optional)_ The track reference to display. |
package/generated-docs/react/usepersistentuserchoicesoptions.md CHANGED
@@ -25,8 +25,8 @@ export interface UsePersistentUserChoicesOptions
25
25
 
26
26
  ## Properties
27
27
 
28
- | Property | Type | Description |
29
- | ---------------------------------------------------------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
30
- | [defaults?](./react/usepersistentuserchoicesoptions.defaults.md) | Partial&lt;LocalUserChoices&gt; | _(Optional)_ The default value to use if reading from local storage returns no results or fails. |
31
- | [preventLoad?](./react/usepersistentuserchoicesoptions.preventload.md) | boolean | _(Optional)_ Whether to prevent loading user choices from persistent storage and use <code>defaults</code> instead. |
32
- | [preventSave?](./react/usepersistentuserchoicesoptions.preventsave.md) | boolean | _(Optional)_ Whether to prevent saving to persistent storage. |
28
+ | Property | Type | Description |
29
+ | ---------------------------------------------------------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
30
+ | [defaults?](./react/usepersistentuserchoicesoptions.defaults.md) | Partial&lt;[LocalUserChoices](./core/localuserchoices.md)<!-- -->&gt; | _(Optional)_ The default value to use if reading from local storage returns no results or fails. |
31
+ | [preventLoad?](./react/usepersistentuserchoicesoptions.preventload.md) | boolean | _(Optional)_ Whether to prevent loading user choices from persistent storage and use <code>defaults</code> instead. |
32
+ | [preventSave?](./react/usepersistentuserchoicesoptions.preventsave.md) | boolean | _(Optional)_ Whether to prevent saving to persistent storage. |
package/generated-docs/react/usetrackshookreturntype.md CHANGED
@@ -18,3 +18,5 @@ export type UseTracksHookReturnType<T> = T extends Track.Source[]
18
18
  ? TrackReferenceOrPlaceholder[]
19
19
  : never;
20
20
  ```
21
+
22
+ **References:** [TrackReference](./core/trackreference.md)<!-- -->, [TrackSourceWithOptions](./core/tracksourcewithoptions.md)<!-- -->, [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)
package/generated-docs/react/usevisualstableupdateoptions.md CHANGED
@@ -17,6 +17,6 @@ export interface UseVisualStableUpdateOptions
17
17
 
18
18
  ## Properties
19
19
 
20
- | Property | Type | Description |
21
- | --------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -------------------------------------------------- |
22
- | [customSortFunction?](./react/usevisualstableupdateoptions.customsortfunction.md) | (trackReferences: TrackReferenceOrPlaceholder\[\]) =&gt; TrackReferenceOrPlaceholder\[\] | _(Optional)_ Overwrites the default sort function. |
20
+ | Property | Type | Description |
21
+ | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------- |
22
+ | [customSortFunction?](./react/usevisualstableupdateoptions.customsortfunction.md) | (trackReferences: [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\]) =&gt; [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\] | _(Optional)_ Overwrites the default sort function. |
package/generated-docs/react/videoconferenceprops.md CHANGED
@@ -21,7 +21,7 @@ export interface VideoConferenceProps extends React.HTMLAttributes<HTMLDivElemen
21
21
 
22
22
  | Property | Type | Description |
23
23
  | ----------------------------------------------------------------------------- | ----------------------------------------------- | ------------ |
24
- | [chatMessageDecoder?](./react/videoconferenceprops.chatmessagedecoder.md) | MessageDecoder | _(Optional)_ |
25
- | [chatMessageEncoder?](./react/videoconferenceprops.chatmessageencoder.md) | MessageEncoder | _(Optional)_ |
24
+ | [chatMessageDecoder?](./react/videoconferenceprops.chatmessagedecoder.md) | [MessageDecoder](./core/messagedecoder.md) | _(Optional)_ |
25
+ | [chatMessageEncoder?](./react/videoconferenceprops.chatmessageencoder.md) | [MessageEncoder](./core/messageencoder.md) | _(Optional)_ |
26
26
  | [chatMessageFormatter?](./react/videoconferenceprops.chatmessageformatter.md) | [MessageFormatter](./react/messageformatter.md) | _(Optional)_ |
27
27
  | [SettingsComponent?](./react/videoconferenceprops.settingscomponent.md) | React.ComponentType | _(Optional)_ |
package/generated-docs/react/videotrackprops.md CHANGED
@@ -19,9 +19,9 @@ export interface VideoTrackProps extends React.VideoHTMLAttributes<HTMLVideoElem
19
19
 
20
20
  ## Properties
21
21
 
22
- | Property | Type | Description |
23
- | -------------------------------------------------------------------------------------- | --------------------------------------- | -------------------------------------------------------- |
24
- | [manageSubscription?](./react/videotrackprops.managesubscription.md) | boolean | _(Optional)_ |
25
- | [onSubscriptionStatusChanged?](./react/videotrackprops.onsubscriptionstatuschanged.md) | (subscribed: boolean) =&gt; void | _(Optional)_ |
26
- | [onTrackClick?](./react/videotrackprops.ontrackclick.md) | (evt: ParticipantClickEvent) =&gt; void | _(Optional)_ |
27
- | [trackRef?](./react/videotrackprops.trackref.md) | TrackReference | _(Optional)_ The track reference of the track to render. |
22
+ | Property | Type | Description |
23
+ | -------------------------------------------------------------------------------------- | ------------------------------------------ | -------------------------------------------------------- |
24
+ | [manageSubscription?](./react/videotrackprops.managesubscription.md) | boolean | _(Optional)_ |
25
+ | [onSubscriptionStatusChanged?](./react/videotrackprops.onsubscriptionstatuschanged.md) | (subscribed: boolean) =&gt; void | _(Optional)_ |
26
+ | [onTrackClick?](./react/videotrackprops.ontrackclick.md) | (evt: ParticipantClickEvent) =&gt; void | _(Optional)_ |
27
+ | [trackRef?](./react/videotrackprops.trackref.md) | [TrackReference](./core/trackreference.md) | _(Optional)_ The track reference of the track to render. |
package/generated-docs/react/voiceassistant.md CHANGED
@@ -23,11 +23,11 @@ export interface VoiceAssistant
23
23
 
24
24
  ## Properties
25
25
 
26
- | Property | Type | Description |
27
- | -------------------------------------------------------------------- | ---------------------------------------------- | ---------------------------------------------------------------------------------------------- |
28
- | [agent](./react/voiceassistant.agent.md) | RemoteParticipant \| undefined | **_(BETA)_** The agent participant. |
29
- | [agentAttributes](./react/voiceassistant.agentattributes.md) | RemoteParticipant\['attributes'\] \| undefined | **_(BETA)_** The agent's participant attributes. |
30
- | [agentTranscriptions](./react/voiceassistant.agenttranscriptions.md) | ReceivedTranscriptionSegment\[\] | **_(BETA)_** The transcriptions of the agent's microphone track (if any). |
31
- | [audioTrack](./react/voiceassistant.audiotrack.md) | TrackReference \| undefined | **_(BETA)_** The microphone track published by the agent or associated avatar worker (if any). |
32
- | [state](./react/voiceassistant.state.md) | [AgentState](./react/agentstate.md) | **_(BETA)_** The current state of the agent. |
33
- | [videoTrack](./react/voiceassistant.videotrack.md) | TrackReference \| undefined | **_(BETA)_** The camera track published by the agent or associated avatar worker (if any). |
26
+ | Property | Type | Description |
27
+ | -------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
28
+ | [agent](./react/voiceassistant.agent.md) | RemoteParticipant \| undefined | **_(BETA)_** The agent participant. |
29
+ | [agentAttributes](./react/voiceassistant.agentattributes.md) | RemoteParticipant\['attributes'\] \| undefined | **_(BETA)_** The agent's participant attributes. |
30
+ | [agentTranscriptions](./react/voiceassistant.agenttranscriptions.md) | [ReceivedTranscriptionSegment](./core/receivedtranscriptionsegment.md)<!-- -->\[\] | **_(BETA)_** The transcriptions of the agent's microphone track (if any). |
31
+ | [audioTrack](./react/voiceassistant.audiotrack.md) | [TrackReference](./core/trackreference.md) \| undefined | **_(BETA)_** The microphone track published by the agent or associated avatar worker (if any). |
32
+ | [state](./react/voiceassistant.state.md) | [AgentState](./react/agentstate.md) | **_(BETA)_** The current state of the agent. |
33
+ | [videoTrack](./react/voiceassistant.videotrack.md) | [TrackReference](./core/trackreference.md) \| undefined | **_(BETA)_** The camera track published by the agent or associated avatar worker (if any). |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@livekit/components-js-docs",
3
- "version": "0.1.61",
3
+ "version": "0.1.62",
4
4
  "description": "Automatically generated documentation pages for LiveKit Components JS. Intended to be consumed by the documentation page.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -8,7 +8,7 @@
8
8
  "directory": "/docs/beta-docs"
9
9
  },
10
10
  "dependencies": {
11
- "@livekit/components-react": "2.9.8"
11
+ "@livekit/components-react": "2.9.9"
12
12
  },
13
13
  "author": "",
14
14
  "license": "Apache-2.0",