@livekit/components-js-docs 0.0.0-20251021151641 → 0.0.0-agents-sdk-20251009192259

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@livekit/components-js-docs",
-  "version": "0.0.0-20251021151641",
+  "version": "0.0.0-agents-sdk-20251009192259",
   "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": "0.0.0-20251021151641"
+    "@livekit/components-react": "0.0.0-agents-sdk-20251009192259"
   },
   "author": "",
   "license": "Apache-2.0",
@@ -19,5 +19,8 @@
   "files": [
     "generated-docs",
     "meta-data.json"
-  ]
+  ],
+  "publishConfig": {
+    "access": "restricted"
+  }
 }

package/generated-docs/core/activespeakerobserver.md

@@ -1,16 +0,0 @@
----
-{
-  "title": "activeSpeakerObserver",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/room.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# activeSpeakerObserver
-
-**Signature:**
-
-```typescript
-export declare function activeSpeakerObserver(room: Room): Observable<Participant[]>;
-```

package/generated-docs/core/addmediatimestamptotranscription.md

@@ -1,22 +0,0 @@
----
-{
-  "title": "addMediaTimestampToTranscription",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/transcriptions.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# addMediaTimestampToTranscription
-
-**Signature:**
-
-```typescript
-export declare function addMediaTimestampToTranscription(
-  segment: TranscriptionSegment,
-  timestamps: {
-    timestamp: number;
-    rtpTimestamp?: number;
-  }
-): ReceivedTranscriptionSegment;
-```

package/generated-docs/core/allparticipantevents.md

@@ -1,16 +0,0 @@
----
-{
-  "title": "allParticipantEvents",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/eventGroups.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# allParticipantEvents
-
-**Signature:**
-
-```typescript
-allParticipantEvents: ParticipantEvent[]
-```

package/generated-docs/core/allparticipantroomevents.md

@@ -1,16 +0,0 @@
----
-{
-  "title": "allParticipantRoomEvents",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/eventGroups.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# allParticipantRoomEvents
-
-**Signature:**
-
-```typescript
-allParticipantRoomEvents: RoomEvent[]
-```

package/generated-docs/core/allremoteparticipantevents.md

@@ -1,16 +0,0 @@
----
-{
-  "title": "allRemoteParticipantEvents",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/eventGroups.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# allRemoteParticipantEvents
-
-**Signature:**
-
-```typescript
-allRemoteParticipantEvents: ParticipantEvent[]
-```

package/generated-docs/core/allremoteparticipantroomevents.md

@@ -1,16 +0,0 @@
----
-{
-  "title": "allRemoteParticipantRoomEvents",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/eventGroups.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# allRemoteParticipantRoomEvents
-
-**Signature:**
-
-```typescript
-allRemoteParticipantRoomEvents: RoomEvent[]
-```

package/generated-docs/core/attachifsubscribed.md

@@ -1,16 +0,0 @@
----
-{
-  "title": "attachIfSubscribed",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/utils.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# attachIfSubscribed
-
-**Signature:**
-
-```typescript
-attachIfSubscribed: (publication: TrackPublication | undefined, element: HTMLMediaElement | null | undefined) => void
-```

package/generated-docs/core/audiosource.md

@@ -1,16 +0,0 @@
----
-{
-  "title": "AudioSource type",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/types.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# AudioSource type
-
-**Signature:**
-
-```typescript
-export type AudioSource = Track.Source.Microphone | Track.Source.ScreenShareAudio;
-```

package/generated-docs/core/basedatamessage.md

@@ -1,23 +0,0 @@
----
-{
-  "title": "BaseDataMessage interface",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/dataChannel.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# BaseDataMessage interface
-
-**Signature:**
-
-```typescript
-export interface BaseDataMessage<T extends string | undefined>
-```
-
-## Properties
-
-| Property                                     | Type       | Description  |
-| -------------------------------------------- | ---------- | ------------ |
-| [payload](./core/basedatamessage.payload.md) | Uint8Array |              |
-| [topic?](./core/basedatamessage.topic.md)    | T          | _(Optional)_ |

package/generated-docs/core/basedatamessage.payload.md

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

package/generated-docs/core/basedatamessage.topic.md

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

package/generated-docs/core/captureoptionsbysource.md

@@ -1,24 +0,0 @@
----
-{
-  "title": "CaptureOptionsBySource type",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/mediaToggle.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# CaptureOptionsBySource type
-
-**Signature:**
-
-```typescript
-export type CaptureOptionsBySource<T extends ToggleSource> = T extends Track.Source.Camera
-  ? VideoCaptureOptions
-  : T extends Track.Source.Microphone
-    ? AudioCaptureOptions
-    : T extends Track.Source.ScreenShare
-      ? ScreenShareCaptureOptions
-      : never;
-```
-
-**References:** [ToggleSource](./core/togglesource.md)

package/generated-docs/core/chatoptions.md

@@ -1,23 +0,0 @@
----
-{
-  "title": "ChatOptions type",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/chat.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# ChatOptions type
-
-**Signature:**
-
-```typescript
-export type ChatOptions = {
-  messageEncoder?: (message: LegacyChatMessage) => Uint8Array;
-  messageDecoder?: (message: Uint8Array) => LegacyReceivedChatMessage;
-  channelTopic?: string;
-  updateChannelTopic?: string;
-};
-```
-
-**References:** [LegacyChatMessage](./core/legacychatmessage.md)<!-- -->, [LegacyReceivedChatMessage](./core/legacyreceivedchatmessage.md)

package/generated-docs/core/computemenuposition.md

@@ -1,20 +0,0 @@
----
-{
-  "title": "computeMenuPosition",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/floating-menu.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# computeMenuPosition
-
-**Signature:**
-
-```typescript
-export declare function computeMenuPosition(
-  button: HTMLElement,
-  menu: HTMLElement,
-  onUpdate?: (x: number, y: number) => void
-): () => void;
-```

package/generated-docs/core/connectedparticipantobserver.md

@@ -1,20 +0,0 @@
----
-{
-  "title": "connectedParticipantObserver",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/participant.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# connectedParticipantObserver
-
-**Signature:**
-
-```typescript
-export declare function connectedParticipantObserver(
-  room: Room,
-  identity: string,
-  options?: ConnectedParticipantObserverOptions
-): Observable<RemoteParticipant | undefined>;
-```

package/generated-docs/core/connectedparticipantobserveroptions.md

@@ -1,18 +0,0 @@
----
-{
-  "title": "ConnectedParticipantObserverOptions type",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/participant.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# ConnectedParticipantObserverOptions type
-
-**Signature:**
-
-```typescript
-export type ConnectedParticipantObserverOptions = {
-  additionalEvents?: ParticipantEvent[];
-};
-```

package/generated-docs/core/connectedparticipantsobserver.md

@@ -1,19 +0,0 @@
----
-{
-  "title": "connectedParticipantsObserver",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/participant.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# connectedParticipantsObserver
-
-**Signature:**
-
-```typescript
-export declare function connectedParticipantsObserver(
-  room: Room,
-  options?: ConnectedParticipantsObserverOptions
-): Observable<RemoteParticipant[]>;
-```

package/generated-docs/core/connectionstateobserver.md

@@ -1,18 +0,0 @@
----
-{
-  "title": "connectionStateObserver",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/room.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# connectionStateObserver
-
-**Signature:**
-
-```typescript
-export declare function connectionStateObserver(
-  room: Room
-): Observable<import("livekit-client").ConnectionState>;
-```

package/generated-docs/core/createactivedeviceobservable.md

@@ -1,19 +0,0 @@
----
-{
-  "title": "createActiveDeviceObservable",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/room.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# createActiveDeviceObservable
-
-**Signature:**
-
-```typescript
-export declare function createActiveDeviceObservable(
-  room: Room,
-  kind: MediaDeviceKind
-): Observable<string>;
-```

package/generated-docs/core/createchatobserver.md

@@ -1,23 +0,0 @@
----
-{
-  "title": "createChatObserver",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/room.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# createChatObserver
-
-**Signature:**
-
-```typescript
-export declare function createChatObserver(
-  room: Room
-): Observable<
-  [
-    message: import("livekit-client").ChatMessage,
-    participant?: LocalParticipant | import("livekit-client").RemoteParticipant | undefined
-  ]
->;
-```

package/generated-docs/core/createconnectionqualityobserver.md

@@ -1,18 +0,0 @@
----
-{
-  "title": "createConnectionQualityObserver",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/participant.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# createConnectionQualityObserver
-
-**Signature:**
-
-```typescript
-export declare function createConnectionQualityObserver(
-  participant: Participant
-): Observable<import("livekit-client").ConnectionQuality>;
-```

package/generated-docs/core/createdataobserver.md

@@ -1,25 +0,0 @@
----
-{
-  "title": "createDataObserver",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/room.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# createDataObserver
-
-**Signature:**
-
-```typescript
-export declare function createDataObserver(
-  room: Room
-): Observable<
-  [
-    payload: Uint8Array<ArrayBufferLike>,
-    participant?: import("livekit-client").RemoteParticipant | undefined,
-    kind?: import("livekit-client").DataPacket_Kind | undefined,
-    topic?: string | undefined
-  ]
->;
-```

package/generated-docs/core/createdefaultgrammar.md

@@ -1,19 +0,0 @@
----
-{
-  "title": "createDefaultGrammar",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/tokenizer.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# createDefaultGrammar
-
-**Signature:**
-
-```typescript
-createDefaultGrammar: () => {
-  email: RegExp;
-  url: RegExp;
-};
-```

package/generated-docs/core/createemailregexp.md

@@ -1,16 +0,0 @@
----
-{
-  "title": "createEmailRegExp",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/emailRegex.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# createEmailRegExp
-
-**Signature:**
-
-```typescript
-declare function createEmailRegExp({ exact }?: { exact?: boolean }): RegExp;
-```

package/generated-docs/core/createisspeakingobserver.md

@@ -1,16 +0,0 @@
----
-{
-  "title": "createIsSpeakingObserver",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/participant.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# createIsSpeakingObserver
-
-**Signature:**
-
-```typescript
-export declare function createIsSpeakingObserver(participant: Participant): Observable<boolean>;
-```

package/generated-docs/core/createmediadeviceobserver.md

@@ -1,20 +0,0 @@
----
-{
-  "title": "createMediaDeviceObserver",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/room.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# createMediaDeviceObserver
-
-**Signature:**
-
-```typescript
-export declare function createMediaDeviceObserver(
-  kind?: MediaDeviceKind,
-  onError?: (e: Error) => void,
-  requestPermissions?: boolean
-): Observable<MediaDeviceInfo[]>;
-```

package/generated-docs/core/createtrackobserver.md

@@ -1,21 +0,0 @@
----
-{
-  "title": "createTrackObserver",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/participant.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# createTrackObserver
-
-**Signature:**
-
-```typescript
-export declare function createTrackObserver(
-  participant: Participant,
-  options: TrackIdentifier
-): Observable<{
-  publication: TrackPublication | undefined;
-}>;
-```

package/generated-docs/core/createurlregexp.md

@@ -1,16 +0,0 @@
----
-{
-  "title": "createUrlRegExp",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/url-regex.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# createUrlRegExp
-
-**Signature:**
-
-```typescript
-export declare function createUrlRegExp(options: RegExOptions): RegExp;
-```

package/generated-docs/core/cssprefix.md

@@ -1,16 +0,0 @@
----
-{
-  "title": "cssPrefix",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/constants.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# cssPrefix
-
-**Signature:**
-
-```typescript
-cssPrefix = "lk";
-```

package/generated-docs/core/datatopic.md

@@ -1,18 +0,0 @@
----
-{
-  "title": "DataTopic",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/dataChannel.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# DataTopic
-
-**Signature:**
-
-```typescript
-DataTopic: {
-    readonly CHAT: "lk.chat";
-}
-```

package/generated-docs/core/dedupesegments.md

@@ -1,20 +0,0 @@
----
-{
-  "title": "dedupeSegments",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/transcriptions.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# dedupeSegments
-
-**Signature:**
-
-```typescript
-export declare function dedupeSegments<T extends TranscriptionSegment>(
-  prevSegments: T[],
-  newSegments: T[],
-  windowSize: number
-): T[];
-```

package/generated-docs/core/defaultuserchoices.md

@@ -1,16 +0,0 @@
----
-{
-  "title": "defaultUserChoices",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/persistent-storage/user-choices.ts"
-}
----
-
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-# defaultUserChoices
-
-**Signature:**
-
-```typescript
-defaultUserChoices: LocalUserChoices;
-```