@livekit/components-js-docs 0.0.2

package/README.md

@@ -0,0 +1,10 @@
+# LiveKit Components-JS autogenerated docs content
+
+This package is a bundle of purely auto-generated documentation content for all LiveKit Component JavaScript packages with no functionality.
+
+## Generation Flow:
+
+1. Extract the package API using the [API Extractor](https://api-extractor.com/) from [@livekit/components-core](../../packages/core/README.md) and [@livekit/components-react](../../packages/react/README.md).
+2. Convert the resulting `*.api.json` files to Markdown files using our custom [API Documenter](../../tooling/api-documenter/README.md) package.
+3. Save the generated Markdown files in this package under the `generated-docs` path.
+4. Publish this [@livekit/components-js-docs](./README.md) package so we can import and use it within the [livekit-docs-v2 repo](https://github.com/livekit/livekit-docs-v2).

package/generated-docs/core/activespeakerobserver.md

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# activeSpeakerObserver (undefined)
+
+**Signature:**
+
+```typescript
+export declare function activeSpeakerObserver(room: Room): Observable<Participant[]>;
+```

package/generated-docs/core/allparticipantevents.md

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## allParticipantEvents variable
+
+**Signature:**
+
+```typescript
+allParticipantEvents: ParticipantEvent[]
+```

package/generated-docs/core/allparticipantroomevents.md

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## allParticipantRoomEvents variable
+
+**Signature:**
+
+```typescript
+allParticipantRoomEvents: RoomEvent[]
+```

package/generated-docs/core/allremoteparticipantevents.md

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## allRemoteParticipantEvents variable
+
+**Signature:**
+
+```typescript
+allRemoteParticipantEvents: ParticipantEvent[]
+```

package/generated-docs/core/allremoteparticipantroomevents.md

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## allRemoteParticipantRoomEvents variable
+
+**Signature:**
+
+```typescript
+allRemoteParticipantRoomEvents: RoomEvent[]
+```

package/generated-docs/core/attachifsubscribed.md

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## attachIfSubscribed variable
+
+**Signature:**
+
+```typescript
+attachIfSubscribed: (publication: TrackPublication | undefined, element: HTMLMediaElement | null | undefined) => void
+```

package/generated-docs/core/audiosource.md

@@ -0,0 +1,9 @@
+<!-- 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

@@ -0,0 +1,16 @@
+<!-- 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

@@ -0,0 +1,9 @@
+<!-- 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

@@ -0,0 +1,9 @@
+<!-- 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

@@ -0,0 +1,17 @@
+<!-- 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/chatmessage.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## ChatMessage interface
+
+**Signature:**
+
+```typescript
+export interface ChatMessage
+```
+
+## Properties
+
+| Property                                     | Type   | Description |
+| -------------------------------------------- | ------ | ----------- |
+| [message](./core/chatmessage.message.md)     | string |             |
+| [timestamp](./core/chatmessage.timestamp.md) | number |             |

package/generated-docs/core/chatmessage.message.md

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## ChatMessage.message property
+
+**Signature:**
+
+```typescript
+message: string;
+```

package/generated-docs/core/chatmessage.timestamp.md

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## ChatMessage.timestamp property
+
+**Signature:**
+
+```typescript
+timestamp: number;
+```

package/generated-docs/core/computemenuposition.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# computeMenuPosition (undefined)
+
+**Signature:**
+
+```typescript
+export declare function computeMenuPosition(
+  button: HTMLElement,
+  menu: HTMLElement,
+): Promise<{
+  x: number;
+  y: number;
+}>;
+```

package/generated-docs/core/connectedparticipantobserver.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# connectedParticipantObserver (undefined)
+
+**Signature:**
+
+```typescript
+export declare function connectedParticipantObserver(
+  room: Room,
+  identity: string,
+  options?: ConnectedParticipantObserverOptions,
+): Observable<RemoteParticipant | undefined>;
+```

package/generated-docs/core/connectedparticipantobserveroptions.md

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# connectedParticipantsObserver (undefined)
+
+**Signature:**
+
+```typescript
+export declare function connectedParticipantsObserver(
+  room: Room,
+  options?: ConnectedParticipantsObserverOptions,
+): Observable<RemoteParticipant[]>;
+```

package/generated-docs/core/connectionstateobserver.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# connectionStateObserver (undefined)
+
+**Signature:**
+
+```typescript
+export declare function connectionStateObserver(
+  room: Room,
+): Observable<import('livekit-client').ConnectionState>;
+```

package/generated-docs/core/createactivedeviceobservable.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# createActiveDeviceObservable (undefined)
+
+**Signature:**
+
+```typescript
+export declare function createActiveDeviceObservable(
+  room: Room,
+  kind: MediaDeviceKind,
+): Observable<string | undefined>;
+```

package/generated-docs/core/createconnectionqualityobserver.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# createConnectionQualityObserver (undefined)
+
+**Signature:**
+
+```typescript
+export declare function createConnectionQualityObserver(
+  participant: Participant,
+): Observable<import('livekit-client').ConnectionQuality>;
+```

package/generated-docs/core/createdataobserver.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# createDataObserver (undefined)
+
+**Signature:**
+
+```typescript
+export declare function createDataObserver(
+  room: Room,
+): Observable<
+  [
+    payload: Uint8Array,
+    participant?: import('livekit-client').RemoteParticipant | undefined,
+    kind?: import('livekit-client').DataPacket_Kind | undefined,
+    topic?: string | undefined,
+  ]
+>;
+```

package/generated-docs/core/createdefaultgrammar.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## createDefaultGrammar variable
+
+**Signature:**
+
+```typescript
+createDefaultGrammar: () => {
+  email: RegExp;
+  url: RegExp;
+};
+```

package/generated-docs/core/createisspeakingobserver.md

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# createIsSpeakingObserver (undefined)
+
+**Signature:**
+
+```typescript
+export declare function createIsSpeakingObserver(participant: Participant): Observable<boolean>;
+```

package/generated-docs/core/createmediadeviceobserver.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# createMediaDeviceObserver (undefined)
+
+**Signature:**
+
+```typescript
+export declare function createMediaDeviceObserver(
+  kind?: MediaDeviceKind,
+  requestPermissions?: boolean,
+): Observable<MediaDeviceInfo[]>;
+```

package/generated-docs/core/createtrackobserver.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# createTrackObserver (undefined)
+
+**Signature:**
+
+```typescript
+export declare function createTrackObserver(
+  participant: Participant,
+  options: TrackIdentifier,
+): Observable<{
+  publication: TrackPublication | undefined;
+}>;
+```

package/generated-docs/core/createurlregexp.md

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## createUrlRegExp variable
+
+**Signature:**
+
+```typescript
+createUrlRegExp: (options: RegExOptions) => RegExp;
+```

package/generated-docs/core/cssprefix.md

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## cssPrefix variable
+
+**Signature:**
+
+```typescript
+cssPrefix = 'lk';
+```

package/generated-docs/core/datasendoptions.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## DataSendOptions type
+
+**Signature:**
+
+```typescript
+export type DataSendOptions = {
+  kind?: DataPacket_Kind;
+  destination?: string[];
+};
+```

package/generated-docs/core/datatopic.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## DataTopic variable
+
+**Signature:**
+
+```typescript
+DataTopic: {
+    readonly CHAT: "lk-chat-topic";
+}
+```

package/generated-docs/core/gettrackbyidentifier.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# getTrackByIdentifier (undefined)
+
+**Signature:**
+
+```typescript
+export declare function getTrackByIdentifier(
+  options: TrackIdentifier,
+): import('livekit-client').TrackPublication | undefined;
+```

package/generated-docs/core/gettrackreferenceid.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# getTrackReferenceId (undefined)
+
+Returns a id to identify the `TrackReference` based on participant and source.
+
+**Signature:**
+
+```typescript
+export declare function getTrackReferenceId(
+  trackReference: TrackReferenceOrPlaceholder | number,
+): string;
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/core/gettrackreferencesource.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# getTrackReferenceSource (undefined)
+
+Returns the Source of the TrackReference.
+
+**Signature:**
+
+```typescript
+export declare function getTrackReferenceSource(
+  trackReference: TrackReferenceOrPlaceholder,
+): Track.Source;
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/core/grid_layouts.md

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## GRID_LAYOUTS variable
+
+**Signature:**
+
+```typescript
+GRID_LAYOUTS: GridLayoutDefinition[]
+```

package/generated-docs/core/gridlayoutdefinition.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## GridLayoutDefinition type
+
+**Signature:**
+
+```typescript
+export type GridLayoutDefinition = {
+  name: string;
+  columns: number;
+  rows: number;
+  minTiles: number;
+  maxTiles: number;
+  minWidth: number;
+  minHeight: number;
+};
+```