@livekit/components-js-docs 0.1.51 → 0.1.53

package/generated-docs/react/videotrackprops.md

@@ -19,9 +19,9 @@ export interface VideoTrackProps extends React.VideoHTMLAttributes<HTMLVideoElem
 
 ## Properties
 
-| Property                                                                               | Type                                        | Description                                              |
-| -------------------------------------------------------------------------------------- | ------------------------------------------- | -------------------------------------------------------- |
-| [manageSubscription?](./react/videotrackprops.managesubscription.md)                   | boolean                                     | _(Optional)_                                             |
-| [onSubscriptionStatusChanged?](./react/videotrackprops.onsubscriptionstatuschanged.md) | (subscribed: boolean) =&gt; void            | _(Optional)_                                             |
-| [onTrackClick?](./react/videotrackprops.ontrackclick.md)                               | (evt: ParticipantClickEvent) =&gt; void     | _(Optional)_                                             |
-| [trackRef?](./react/videotrackprops.trackref.md)                                       | [TrackReference](./react/trackreference.md) | _(Optional)_ The track reference of the track to render. |
+| Property                                                                               | Type                                    | Description                                              |
+| -------------------------------------------------------------------------------------- | --------------------------------------- | -------------------------------------------------------- |
+| [manageSubscription?](./react/videotrackprops.managesubscription.md)                   | boolean                                 | _(Optional)_                                             |
+| [onSubscriptionStatusChanged?](./react/videotrackprops.onsubscriptionstatuschanged.md) | (subscribed: boolean) =&gt; void        | _(Optional)_                                             |
+| [onTrackClick?](./react/videotrackprops.ontrackclick.md)                               | (evt: ParticipantClickEvent) =&gt; void | _(Optional)_                                             |
+| [trackRef?](./react/videotrackprops.trackref.md)                                       | TrackReference                          | _(Optional)_ The track reference of the track to render. |

package/generated-docs/react/voiceassistant.md

@@ -23,10 +23,10 @@ export interface VoiceAssistant
 
 ## Properties
 
-| Property                                                             | Type                                                     | Description  |
-| -------------------------------------------------------------------- | -------------------------------------------------------- | ------------ |
-| [agent](./react/voiceassistant.agent.md)                             | RemoteParticipant \| undefined                           | **_(BETA)_** |
-| [agentAttributes](./react/voiceassistant.agentattributes.md)         | RemoteParticipant\['attributes'\] \| undefined           | **_(BETA)_** |
-| [agentTranscriptions](./react/voiceassistant.agenttranscriptions.md) | ReceivedTranscriptionSegment\[\]                         | **_(BETA)_** |
-| [audioTrack](./react/voiceassistant.audiotrack.md)                   | [TrackReference](./react/trackreference.md) \| undefined | **_(BETA)_** |
-| [state](./react/voiceassistant.state.md)                             | [AgentState](./react/agentstate.md)                      | **_(BETA)_** |
+| Property                                                             | Type                                           | Description  |
+| -------------------------------------------------------------------- | ---------------------------------------------- | ------------ |
+| [agent](./react/voiceassistant.agent.md)                             | RemoteParticipant \| undefined                 | **_(BETA)_** |
+| [agentAttributes](./react/voiceassistant.agentattributes.md)         | RemoteParticipant\['attributes'\] \| undefined | **_(BETA)_** |
+| [agentTranscriptions](./react/voiceassistant.agenttranscriptions.md) | ReceivedTranscriptionSegment\[\]               | **_(BETA)_** |
+| [audioTrack](./react/voiceassistant.audiotrack.md)                   | TrackReference \| undefined                    | **_(BETA)_** |
+| [state](./react/voiceassistant.state.md)                             | [AgentState](./react/agentstate.md)            | **_(BETA)_** |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@livekit/components-js-docs",
-  "version": "0.1.51",
+  "version": "0.1.53",
   "description": "Automatically generated documentation pages for LiveKit Components JS. Intended to be consumed by the documentation page.",
   "repository": {
     "type": "git",
@@ -8,7 +8,7 @@
     "directory": "/docs/beta-docs"
   },
   "dependencies": {
-    "@livekit/components-react": "2.8.0"
+    "@livekit/components-react": "2.9.0"
   },
   "author": "",
   "license": "Apache-2.0",

package/generated-docs/react/gridlayoutdefinition.md

@@ -1,22 +0,0 @@
----
-{
-  "title": "GridLayoutDefinition type",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/../core/src/helper/grid-layouts.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# GridLayoutDefinition type
-
-**Signature:**
-
-```typescript
-export type GridLayoutDefinition = {
-  columns: number;
-  rows: number;
-  minWidth?: number;
-  minHeight?: number;
-  orientation?: "landscape" | "portrait";
-};
-```

package/generated-docs/react/localuserchoices.md

@@ -1,24 +0,0 @@
----
-{
-  "title": "LocalUserChoices type",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/../core/src/persistent-storage/user-choices.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# LocalUserChoices type
-
-Represents the user's choices for video and audio input devices, as well as their username.
-
-**Signature:**
-
-```typescript
-export type LocalUserChoices = {
-  videoEnabled: boolean;
-  audioEnabled: boolean;
-  videoDeviceId: string;
-  audioDeviceId: string;
-  username: string;
-};
-```

package/generated-docs/react/messagedecoder.md

@@ -1,22 +0,0 @@
----
-{
-  "title": "MessageDecoder type",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/../core/src/components/chat.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# MessageDecoder type
-
-{% 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
-
-{% /callout %}
-
-**Signature:**
-
-```typescript
-export type MessageDecoder = (message: Uint8Array) => LegacyReceivedChatMessage;
-```

package/generated-docs/react/messageencoder.md

@@ -1,22 +0,0 @@
----
-{
-  "title": "MessageEncoder type",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/../core/src/components/chat.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# MessageEncoder type
-
-{% 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
-
-{% /callout %}
-
-**Signature:**
-
-```typescript
-export type MessageEncoder = (message: LegacyChatMessage) => Uint8Array;
-```

package/generated-docs/react/participantidentifier.md

@@ -1,28 +0,0 @@
----
-{
-  "title": "ParticipantIdentifier type",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/../core/src/types.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# ParticipantIdentifier type
-
-{% 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 type ParticipantIdentifier = RequireAtLeastOne<
-  {
-    kind: ParticipantKind;
-    identity: string;
-  },
-  "identity" | "kind"
->;
-```

package/generated-docs/react/pinstate.md

@@ -1,18 +0,0 @@
----
-{
-  "title": "PinState type",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/../core/src/types.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# PinState type
-
-**Signature:**
-
-```typescript
-export type PinState = TrackReferenceOrPlaceholder[];
-```
-
-**References:** [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md)

package/generated-docs/react/receivedchatmessage.md

@@ -1,24 +0,0 @@
----
-{
-  "title": "ReceivedChatMessage interface",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/../core/src/components/chat.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# ReceivedChatMessage interface
-
-**Signature:**
-
-```typescript
-export interface ReceivedChatMessage extends ChatMessage
-```
-
-**Extends:** ChatMessage
-
-## Properties
-
-| Property                                     | Type        | Description  |
-| -------------------------------------------- | ----------- | ------------ |
-| [from?](./react/receivedchatmessage.from.md) | Participant | _(Optional)_ |

package/generated-docs/react/setlogextension.md

@@ -1,21 +0,0 @@
----
-{
-  "title": "setLogExtension",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/../core/src/logger.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# setLogExtension
-
-Set the log extension for both the `@livekit/components-react` package and the `@livekit-client` package. To set the `@livekit-client` log extension, use the `liveKitClientLogExtension` prop on the `options` object.
-
-**Signature:**
-
-```typescript
-export declare function setLogExtension(
-  extension: LogExtension,
-  options?: SetLogExtensionOptions
-): void;
-```

package/generated-docs/react/setloglevel.md

@@ -1,18 +0,0 @@
----
-{
-  "title": "setLogLevel",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/../core/src/logger.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# setLogLevel
-
-Set the log level for both the `@livekit/components-react` package and the `@livekit-client` package. To set the `@livekit-client` log independently, use the `liveKitClientLogLevel` prop on the `options` object.
-
-**Signature:**
-
-```typescript
-export declare function setLogLevel(level: LogLevel, options?: SetLogLevelOptions): void;
-```

package/generated-docs/react/trackreference.md

@@ -1,20 +0,0 @@
----
-{
-  "title": "TrackReference type",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/../core/src/track-reference/track-reference.types.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# TrackReference type
-
-**Signature:**
-
-```typescript
-export type TrackReference = {
-  participant: Participant;
-  publication: TrackPublication;
-  source: Track.Source;
-};
-```

package/generated-docs/react/trackreferenceorplaceholder.md

@@ -1,18 +0,0 @@
----
-{
-  "title": "TrackReferenceOrPlaceholder type",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/../core/src/track-reference/track-reference.types.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# TrackReferenceOrPlaceholder type
-
-**Signature:**
-
-```typescript
-export type TrackReferenceOrPlaceholder = TrackReference | TrackReferencePlaceholder;
-```
-
-**References:** [TrackReference](./react/trackreference.md)

package/generated-docs/react/widgetstate.md

@@ -1,20 +0,0 @@
----
-{
-  "title": "WidgetState type",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/../core/src/types.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# WidgetState type
-
-**Signature:**
-
-```typescript
-export type WidgetState = {
-  showChat: boolean;
-  unreadMessages: number;
-  showSettings?: boolean;
-};
-```