@livekit/components-js-docs 0.1.47 → 0.1.49

package/generated-docs/core/chatoptions.md

@@ -21,5 +21,3 @@ export type ChatOptions = {
 ```
 
 **References:** [LegacyChatMessage](./core/legacychatmessage.md)<!-- -->, [LegacyReceivedChatMessage](./core/legacyreceivedchatmessage.md)
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/dedupesegments.md

@@ -18,5 +18,3 @@ export declare function dedupeSegments<T extends TranscriptionSegment>(
   windowSize: number
 ): T[];
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/gettrackreferenceid.md

@@ -22,5 +22,3 @@ export declare function getTrackReferenceId(
 ## Remarks
 
 The id pattern is: `${participantIdentity}_${trackSource}_${trackSid}` for `TrackReference` and `${participantIdentity}_${trackSource}_placeholder` for `TrackReferencePlaceholder`<!-- -->.
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/gettrackreferencesource.md

@@ -18,5 +18,3 @@ export declare function getTrackReferenceSource(
   trackReference: TrackReferenceOrPlaceholder
 ): Track.Source;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/gridlayoutdefinition.md

@@ -20,5 +20,3 @@ export type GridLayoutDefinition = {
   orientation?: "landscape" | "portrait";
 };
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/islocal.md

@@ -12,5 +12,5 @@
 **Signature:**
 
 ```typescript
-export declare function isLocal(p: Participant): p is LocalParticipant;
+export declare function isLocal(p: Participant): boolean;
 ```

package/generated-docs/core/ismobilebrowser.md

@@ -20,5 +20,3 @@ export declare function isMobileBrowser(): boolean;
 ## Remarks
 
 This should only be used if feature detection or other methods do not work!
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/isparticipanttrackreferencepinned.md

@@ -19,5 +19,3 @@ export declare function isParticipantTrackReferencePinned(
   pinState: PinState | undefined
 ): boolean;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/isremote.md

@@ -12,5 +12,5 @@
 **Signature:**
 
 ```typescript
-export declare function isRemote(p: Participant): p is RemoteParticipant;
+export declare function isRemote(p: Participant): boolean;
 ```

package/generated-docs/core/istrackreferencepinned.md

@@ -19,5 +19,3 @@ export declare function isTrackReferencePinned(
   pinState: PinState | undefined
 ): boolean;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/loaduserchoices.md

@@ -9,6 +9,12 @@
 
 # loadUserChoices
 
+{% callout type="note" variation="normal" %}
+
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+
+{% /callout %}
+
 Reads the user choices from local storage, or returns the default settings if none are found.
 
 **Signature:**
@@ -23,5 +29,3 @@ export declare function loadUserChoices(
 ## Remarks
 
 The deprecated parameters `e2ee` and `sharedPassphrase` are not read from local storage and always return the value from the passed `defaults` or internal defaults.
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/localuserchoices.md

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

package/generated-docs/core/messagedecoder.md

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

package/generated-docs/core/messageencoder.md

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

package/generated-docs/core/participantidentifier.md

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

package/generated-docs/core/pinstate.md

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

package/generated-docs/core/receivedchatmessage.md

@@ -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/core/saveuserchoices.md

@@ -9,6 +9,12 @@
 
 # saveUserChoices
 
+{% callout type="note" variation="normal" %}
+
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+
+{% /callout %}
+
 Saves user choices to local storage.
 
 **Signature:**
@@ -16,5 +22,3 @@ Saves user choices to local storage.
 ```typescript
 export declare function saveUserChoices(userChoices: LocalUserChoices, preventSave?: boolean): void;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/sendmessage.md

@@ -20,5 +20,3 @@ export declare function sendMessage(
   options?: DataPublishOptions
 ): Promise<void>;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/setlogextension.md

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

package/generated-docs/core/setloglevel.md

@@ -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/core/sortparticipants.md

@@ -16,5 +16,3 @@ Default sort for participants, it'll order participants by: 1. local participant
 ```typescript
 export declare function sortParticipants(participants: Participant[]): Participant[];
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/sorttrackreferences.md

@@ -18,5 +18,3 @@ export declare function sortTrackReferences(
   tracks: TrackReferenceOrPlaceholder[]
 ): TrackReferenceOrPlaceholder[];
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/supportsscreensharing.md

@@ -16,5 +16,3 @@ Returns `true` if the browser supports screen sharing.
 ```typescript
 export declare function supportsScreenSharing(): boolean;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/trackreference.md

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

package/generated-docs/core/trackreferenceorplaceholder.md

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

package/generated-docs/core/trackreferenceplaceholder.md

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

package/generated-docs/core/updatepages.md

@@ -20,5 +20,3 @@ export declare function updatePages<T extends UpdatableItem>(
   maxItemsOnPage: number
 ): T[];
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/widgetstate.md

@@ -18,5 +18,3 @@ export type WidgetState = {
   showSettings?: boolean;
 };
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/agentstate.md

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

package/generated-docs/react/allowaudioplaybackprops.md

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

package/generated-docs/react/allowmediaplaybackprops.md

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

package/generated-docs/react/audioconferenceprops.md

@@ -16,5 +16,3 @@ export interface AudioConferenceProps extends React.HTMLAttributes<HTMLDivElemen
 ```
 
 **Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/audiotrackprops.md

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

package/generated-docs/react/audiotrackprops.muted.md

@@ -6,6 +6,12 @@
 
 # AudioTrackProps.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 %}
+
 Mutes the audio track if set to `true`<!-- -->.
 
 **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/audiotrackprops.trackref.md

@@ -13,5 +13,3 @@ The track reference of the track from which the audio is to be rendered.
 ```typescript
 trackRef?: TrackReference;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/audiotrackprops.volume.md

@@ -13,5 +13,3 @@ Sets the volume of the audio track. By default, the range is between `0.0` and `
 ```typescript
 volume?: number;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/audiovisualizerprops.md

@@ -11,9 +11,7 @@
 
 {% callout type="caution" variation="normal" %}
 
-This API is deprecated:
-
-Use BarVisualizer instead
+This API is deprecated: Use BarVisualizer instead
 
 {% /callout %}
 
@@ -25,8 +23,6 @@ export interface AudioVisualizerProps extends React.HTMLAttributes<SVGElement>
 
 **Extends:** React.HTMLAttributes&lt;SVGElement&gt;
 
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
-
 ## Properties
 
 | Property                                              | Type                                        | Description  |

package/generated-docs/react/audiowaveformoptions.barcount.md

@@ -6,6 +6,12 @@
 
 # AudioWaveformOptions.barCount 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/audiowaveformoptions.md

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

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

@@ -6,6 +6,12 @@
 
 # AudioWaveformOptions.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 %}
+
 **Signature:**
 
 ```typescript

package/generated-docs/react/audiowaveformoptions.volmultiplier.md

@@ -6,6 +6,12 @@
 
 # AudioWaveformOptions.volMultiplier 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/barvisualizeroptions.md

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

package/generated-docs/react/barvisualizerprops.barcount.md

@@ -6,7 +6,11 @@
 
 # BarVisualizerProps.barCount property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
 
 Number of bars that show up in the visualizer
 
@@ -15,5 +19,3 @@ Number of bars that show up in the visualizer
 ```typescript
 barCount?: number;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -6,7 +6,11 @@
 
 # BarVisualizerProps.children property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
 
 The template component to be used in the visualizer.
 
@@ -15,5 +19,3 @@ The template component to be used in the visualizer.
 ```typescript
 children?: React.ReactNode;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/barvisualizerprops.md

@@ -9,7 +9,11 @@
 
 # BarVisualizerProps interface
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
 
 **Signature:**
 
@@ -19,8 +23,6 @@ export interface BarVisualizerProps extends React.HTMLProps<HTMLDivElement>
 
 **Extends:** React.HTMLProps&lt;HTMLDivElement&gt;
 
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}
-
 ## Properties
 
 | Property                                            | Type                                                                  | Description                                                                                               |

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

@@ -6,7 +6,11 @@
 
 # BarVisualizerProps.options property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
 
 **Signature:**
 

package/generated-docs/react/barvisualizerprops.state.md

@@ -6,7 +6,11 @@
 
 # BarVisualizerProps.state property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
 
 If set, the visualizer will transition between different voice assistant states
 
@@ -15,5 +19,3 @@ If set, the visualizer will transition between different voice assistant states
 ```typescript
 state?: AgentState;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

@@ -6,7 +6,11 @@
 
 # BarVisualizerProps.trackRef property
 
-> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
 
 **Signature:**
 

package/generated-docs/react/carousellayoutprops.md

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

package/generated-docs/react/carousellayoutprops.orientation.md

@@ -13,5 +13,3 @@ Place the tiles vertically or horizontally next to each other. If undefined orie
 ```typescript
 orientation?: 'vertical' | 'horizontal';
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/chatentryprops.entry.md

@@ -13,5 +13,3 @@ The chat massage object to display.
 ```typescript
 entry: ReceivedChatMessage;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/chatentryprops.hidename.md

@@ -13,5 +13,3 @@ Hide sender name. Useful when displaying multiple consecutive chat messages from
 ```typescript
 hideName?: boolean;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/chatentryprops.hidetimestamp.md

@@ -13,5 +13,3 @@ Hide message timestamp.
 ```typescript
 hideTimestamp?: boolean;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/chatentryprops.md

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

package/generated-docs/react/chatentryprops.messageformatter.md

@@ -13,5 +13,3 @@ An optional formatter for the message body.
 ```typescript
 messageFormatter?: MessageFormatter;
 ```
-
-{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/chatprops.md

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