npm - @livekit/components-js-docs - Versions diffs - 0.1.47 → 0.1.49 - Mend

@livekit/components-js-docs 0.1.47 → 0.1.49

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 (312) hide show

package/generated-docs/react/prejoinprops.persistuserchoices.md CHANGED Viewed

@@ -6,6 +6,12 @@
 # PreJoinProps.persistUserChoices 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 %}
 If true, user choices are persisted across sessions.
 **Signature:**
@@ -13,5 +19,3 @@ If true, user choices are persisted across sessions.
 ```typescript
 persistUserChoices?: boolean;
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/prejoinprops.videoprocessor.md ADDED Viewed

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

package/generated-docs/react/receivedchatmessage.md CHANGED Viewed

@@ -17,8 +17,6 @@ export interface ReceivedChatMessage extends ChatMessage
 **Extends:** ChatMessage
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 ## Properties
 | Property                                     | Type        | Description  |

package/generated-docs/react/roomaudiorendererprops.md CHANGED Viewed

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

package/generated-docs/react/roomaudiorendererprops.muted.md CHANGED Viewed

@@ -6,6 +6,12 @@
 # RoomAudioRendererProps.muted 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 %}
 If set to `true`<!-- -->, mutes all audio tracks rendered by the component.
 **Signature:**
@@ -17,5 +23,3 @@ muted?: boolean;
 ## Remarks
 If set to `true`<!-- -->, the server will stop sending audio track data to the client.
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/roomaudiorendererprops.volume.md CHANGED Viewed

@@ -13,5 +13,3 @@ Sets the volume for all audio tracks rendered by this component. By default, the
 ```typescript
 volume?: number;
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/roomnameprops.md CHANGED Viewed

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

package/generated-docs/react/setlogextension.md CHANGED Viewed

@@ -19,5 +19,3 @@ export declare function setLogExtension(
   options?: SetLogExtensionOptions
 ): void;
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/setloglevel.md CHANGED Viewed

@@ -16,5 +16,3 @@ Set the log level for both the `@livekit/components-react` package and the `@liv
 ```typescript
 export declare function setLogLevel(level: LogLevel, options?: SetLogLevelOptions): void;
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/trackloopprops.children.md CHANGED Viewed

@@ -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/trackloopprops.md CHANGED Viewed

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

package/generated-docs/react/trackloopprops.tracks.md CHANGED Viewed

@@ -13,5 +13,3 @@ Track references to loop over. You can the use `useTracks()` hook to get TrackRe
 ```typescript
 tracks: TrackReference[] | TrackReferenceOrPlaceholder[];
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/trackmutedindicatorprops.md CHANGED Viewed

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

package/generated-docs/react/trackreference.md CHANGED Viewed

@@ -18,5 +18,3 @@ export type TrackReference = {
   source: Track.Source;
 };
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/trackreferenceorplaceholder.md CHANGED Viewed

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

package/generated-docs/react/tracktoggleprops.md CHANGED Viewed

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

package/generated-docs/react/tracktoggleprops.onchange.md CHANGED Viewed

@@ -13,5 +13,3 @@ Function that is called when the enabled state of the toggle changes. The second
 ```typescript
 onChange?: (enabled: boolean, isUserInitiated: boolean) => void;
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/tracktranscriptionoptions.buffersize.md CHANGED Viewed

@@ -6,6 +6,12 @@
 # TrackTranscriptionOptions.bufferSize 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 %}
 how many transcription segments should be buffered in state
 **Signature:**
@@ -13,5 +19,3 @@ how many transcription segments should be buffered in state
 ```typescript
 bufferSize?: number;
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/tracktranscriptionoptions.md CHANGED Viewed

@@ -9,14 +9,18 @@
 # TrackTranscriptionOptions 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 TrackTranscriptionOptions
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 ## Properties
 | Property                                                                 | Type                                               | Description                                                                      |

package/generated-docs/react/tracktranscriptionoptions.ontranscription.md CHANGED Viewed

@@ -6,6 +6,12 @@
 # TrackTranscriptionOptions.onTranscription 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 %}
 optional callback for retrieving newly incoming transcriptions only
 **Signature:**
@@ -13,5 +19,3 @@ optional callback for retrieving newly incoming transcriptions only
 ```typescript
 onTranscription?: (newSegments: TranscriptionSegment[]) => void;
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/usechattoggleprops.md CHANGED Viewed

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

package/generated-docs/react/usefocustoggleprops.md CHANGED Viewed

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

package/generated-docs/react/useisencryptedoptions.md CHANGED Viewed

@@ -9,14 +9,18 @@
 # UseIsEncryptedOptions 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 UseIsEncryptedOptions
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 ## Properties
 | Property                                       | Type | Description  |

package/generated-docs/react/useisencryptedoptions.room.md CHANGED Viewed

@@ -6,6 +6,12 @@
 # UseIsEncryptedOptions.room 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/useismutedoptions.md CHANGED Viewed

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

package/generated-docs/react/usekrispnoisefilteroptions.md ADDED Viewed

@@ -0,0 +1,28 @@
+---
+{
+  "title": "useKrispNoiseFilterOptions interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/cloud/krisp/useKrispNoiseFilter.ts"
+}
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+# useKrispNoiseFilterOptions interface
+{% callout type="note" variation="normal" %}
+This feature is under active development and may change based on developer feedback and real-world usage.
+{% /callout %}
+**Signature:**
+```typescript
+export interface useKrispNoiseFilterOptions
+```
+## Properties
+| Property                                                    | Type                                                                  | Description                                                                                                  |
+| ----------------------------------------------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
+| [trackRef?](./react/usekrispnoisefilteroptions.trackref.md) | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | **_(BETA)_** _(Optional)_ The track reference to use for the noise filter (defaults: local microphone track) |

package/generated-docs/react/usekrispnoisefilteroptions.trackref.md ADDED Viewed

@@ -0,0 +1,21 @@
+---
+{ "title": "useKrispNoiseFilterOptions.trackRef property" }
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+# useKrispNoiseFilterOptions.trackRef property
+{% callout type="note" variation="normal" %}
+This feature is under active development and may change based on developer feedback and real-world usage.
+{% /callout %}
+The track reference to use for the noise filter (defaults: local microphone track)
+**Signature:**
+```typescript
+trackRef?: TrackReferenceOrPlaceholder;
+```

package/generated-docs/react/uselocalparticipantoptions.md CHANGED Viewed

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

package/generated-docs/react/uselocalparticipantoptions.room.md CHANGED Viewed

@@ -13,5 +13,3 @@ The room to use. If not provided, the hook will use the room from the context.
 ```typescript
 room?: Room;
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/usemediadeviceselectprops.md CHANGED Viewed

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

package/generated-docs/react/usemediadeviceselectprops.onerror.md CHANGED Viewed

@@ -13,5 +13,3 @@ this callback gets called if an error is thrown when failing to select a device
 ```typescript
 onError?: (e: Error) => void;
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/usemediadeviceselectprops.requestpermissions.md CHANGED Viewed

@@ -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/useparticipantattributesoptions.md CHANGED Viewed

@@ -23,8 +23,6 @@ export interface UseParticipantAttributesOptions
 const { attributes } = useParticipantAttributes({ participant });
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 | Property                                                               | Type        | Description  |

package/generated-docs/react/useparticipantinfooptions.md CHANGED Viewed

@@ -23,8 +23,6 @@ export interface UseParticipantInfoOptions
 const { identity, name, metadata } = useParticipantInfo({ participant });
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 | Property                                                         | Type        | Description  |

package/generated-docs/react/useparticipantpermissionsoptions.md CHANGED Viewed

@@ -23,8 +23,6 @@ export interface UseParticipantPermissionsOptions
 const permissions = useParticipantPermissions({ participant });
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 | Property                                                                | Type        | Description  |

package/generated-docs/react/useparticipantsoptions.md CHANGED Viewed

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

package/generated-docs/react/useparticipantsoptions.room.md CHANGED Viewed

@@ -13,5 +13,3 @@ The room to use. If not provided, the hook will use the room from the context.
 ```typescript
 room?: Room;
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/useparticipantsoptions.updateonlyon.md CHANGED Viewed

@@ -13,5 +13,3 @@ To optimize performance, you can use the `updateOnlyOn` property to decide on wh
 ```typescript
 updateOnlyOn?: RoomEvent[];
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/useparticipanttileprops.md CHANGED Viewed

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

package/generated-docs/react/useparticipanttileprops.trackref.md CHANGED Viewed

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

package/generated-docs/react/usepersistentuserchoicesoptions.defaults.md CHANGED Viewed

@@ -6,6 +6,12 @@
 # UsePersistentUserChoicesOptions.defaults 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 %}
 The default value to use if reading from local storage returns no results or fails.
 **Signature:**
@@ -13,5 +19,3 @@ The default value to use if reading from local storage returns no results or fai
 ```typescript
 defaults?: Partial<LocalUserChoices>;
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/usepersistentuserchoicesoptions.md CHANGED Viewed

@@ -9,6 +9,12 @@
 # UsePersistentUserChoicesOptions 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 %}
 Options for the `usePersistentDeviceSettings` hook.
 **Signature:**
@@ -17,8 +23,6 @@ Options for the `usePersistentDeviceSettings` hook.
 export interface UsePersistentUserChoicesOptions
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 ## Properties
 | Property                                                               | Type                                                                   | Description                                                                                                         |

package/generated-docs/react/usepersistentuserchoicesoptions.preventload.md CHANGED Viewed

@@ -6,6 +6,12 @@
 # UsePersistentUserChoicesOptions.preventLoad 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 %}
 Whether to prevent loading user choices from persistent storage and use `defaults` instead.
 **Signature:**
@@ -13,5 +19,3 @@ Whether to prevent loading user choices from persistent storage and use `default
 ```typescript
 preventLoad?: boolean;
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/usepersistentuserchoicesoptions.preventsave.md CHANGED Viewed

@@ -6,6 +6,12 @@
 # UsePersistentUserChoicesOptions.preventSave 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 %}
 Whether to prevent saving to persistent storage.
 **Signature:**
@@ -13,5 +19,3 @@ Whether to prevent saving to persistent storage.
 ```typescript
 preventSave?: boolean;
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/useremoteparticipantoptions.md CHANGED Viewed

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

package/generated-docs/react/useremoteparticipantoptions.updateonlyon.md CHANGED Viewed

@@ -13,5 +13,3 @@ To optimize performance, you can use the `updateOnlyOn` property to decide on wh
 ```typescript
 updateOnlyOn?: ParticipantEvent[];
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/useremoteparticipantsoptions.md CHANGED Viewed

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

package/generated-docs/react/useremoteparticipantsoptions.room.md CHANGED Viewed

@@ -13,5 +13,3 @@ The room to use. If not provided, the hook will use the room from the context.
 ```typescript
 room?: Room;
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/useremoteparticipantsoptions.updateonlyon.md CHANGED Viewed

@@ -13,5 +13,3 @@ To optimize performance, you can use the `updateOnlyOn` property to decide on wh
 ```typescript
 updateOnlyOn?: RoomEvent[];
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/userinfo.md CHANGED Viewed

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

package/generated-docs/react/useroominfooptions.md CHANGED Viewed

@@ -27,8 +27,6 @@ Needs to be called inside a `RoomContext` or by passing a `Room` instance.
 const { name, metadata } = useRoomInfo();
 ```
-{% partial file="p_usage.md" variables={exampleCount: 1} /%}
 ## Properties
 | Property                                    | Type | Description  |

package/generated-docs/react/usestartaudioprops.md CHANGED Viewed

@@ -9,14 +9,18 @@
 # UseStartAudioProps 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 UseStartAudioProps
 ```
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
 ## Properties
 | Property                                     | Type                                                | Description  |

package/generated-docs/react/usestartaudioprops.props.md CHANGED Viewed

@@ -6,6 +6,12 @@
 # UseStartAudioProps.props 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