@livekit/components-js-docs 0.0.0-20251021151641

package/generated-docs/core/createdefaultgrammar.md

@@ -0,0 +1,19 @@
+---
+{
+  "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

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

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

@@ -0,0 +1,20 @@
+---
+{
+  "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

@@ -0,0 +1,21 @@
+---
+{
+  "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

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

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

@@ -0,0 +1,18 @@
+---
+{
+  "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

@@ -0,0 +1,20 @@
+---
+{
+  "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

@@ -0,0 +1,16 @@
+---
+{
+  "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;
+```

package/generated-docs/core/didactivesegmentschange.md

@@ -0,0 +1,19 @@
+---
+{
+  "title": "didActiveSegmentsChange",
+  "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. -->
+
+# didActiveSegmentsChange
+
+**Signature:**
+
+```typescript
+export declare function didActiveSegmentsChange<T extends TranscriptionSegment>(
+  prevActive: T[],
+  newActive: T[]
+): boolean;
+```

package/generated-docs/core/encryptionstatusobservable.md

@@ -0,0 +1,19 @@
+---
+{
+  "title": "encryptionStatusObservable",
+  "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. -->
+
+# encryptionStatusObservable
+
+**Signature:**
+
+```typescript
+export declare function encryptionStatusObservable(
+  room: Room,
+  participant: Participant | undefined
+): Observable<boolean>;
+```

package/generated-docs/core/getactivetranscriptionsegments.md

@@ -0,0 +1,23 @@
+---
+{
+  "title": "getActiveTranscriptionSegments",
+  "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. -->
+
+# getActiveTranscriptionSegments
+
+**Signature:**
+
+```typescript
+export declare function getActiveTranscriptionSegments(
+  segments: ReceivedTranscriptionSegment[],
+  syncTimes: {
+    timestamp: number;
+    rtpTimestamp?: number;
+  },
+  maxAge?: number
+): ReceivedTranscriptionSegment[];
+```

package/generated-docs/core/gettrackbyidentifier.md

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

package/generated-docs/core/gettrackreferenceid.md

@@ -0,0 +1,24 @@
+---
+{
+  "title": "getTrackReferenceId",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/track-reference/track-reference.utils.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# getTrackReferenceId
+
+Returns a id to identify the `TrackReference` or `TrackReferencePlaceholder` based on participant, track source and trackSid.
+
+**Signature:**
+
+```typescript
+export declare function getTrackReferenceId(
+  trackReference: TrackReferenceOrPlaceholder | number
+): string;
+```
+
+## Remarks
+
+The id pattern is: `${participantIdentity}_${trackSource}_${trackSid}` for `TrackReference` and `${participantIdentity}_${trackSource}_placeholder` for `TrackReferencePlaceholder`<!-- -->.

package/generated-docs/core/gettrackreferencesource.md

@@ -0,0 +1,20 @@
+---
+{
+  "title": "getTrackReferenceSource",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/track-reference/track-reference.utils.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# getTrackReferenceSource
+
+Returns the Source of the TrackReference.
+
+**Signature:**
+
+```typescript
+export declare function getTrackReferenceSource(
+  trackReference: TrackReferenceOrPlaceholder
+): Track.Source;
+```

package/generated-docs/core/grid_layouts.md

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

package/generated-docs/core/gridlayoutdefinition.md

@@ -0,0 +1,22 @@
+---
+{
+  "title": "GridLayoutDefinition type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/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/core/gridlayoutinfo.md

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