@livekit/components-js-docs 0.1.22 → 0.1.24

package/generated-docs/core/addmediatimestamptotranscription.md

@@ -0,0 +1,22 @@
+---
+{
+  "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,13 +1,13 @@
 ---
 {
-  "title": "allParticipantEvents variable",
+  "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 variable
+# allParticipantEvents
 
 **Signature:**
 

package/generated-docs/core/allparticipantroomevents.md

@@ -1,13 +1,13 @@
 ---
 {
-  "title": "allParticipantRoomEvents variable",
+  "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 variable
+# allParticipantRoomEvents
 
 **Signature:**
 

package/generated-docs/core/allremoteparticipantevents.md

@@ -1,13 +1,13 @@
 ---
 {
-  "title": "allRemoteParticipantEvents variable",
+  "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 variable
+# allRemoteParticipantEvents
 
 **Signature:**
 

package/generated-docs/core/allremoteparticipantroomevents.md

@@ -1,13 +1,13 @@
 ---
 {
-  "title": "allRemoteParticipantRoomEvents variable",
+  "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 variable
+# allRemoteParticipantRoomEvents
 
 **Signature:**
 

package/generated-docs/core/cssprefix.md

@@ -1,13 +1,13 @@
 ---
 {
-  "title": "cssPrefix variable",
+  "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 variable
+# cssPrefix
 
 **Signature:**
 

package/generated-docs/core/datatopic.md

@@ -1,13 +1,13 @@
 ---
 {
-  "title": "DataTopic variable",
+  "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 variable
+# DataTopic
 
 **Signature:**
 

package/generated-docs/core/dedupesegments.md

@@ -0,0 +1,22 @@
+---
+{
+  "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[];
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/defaultuserchoices.md

@@ -1,13 +1,13 @@
 ---
 {
-  "title": "defaultUserChoices variable",
+  "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 variable
+# defaultUserChoices
 
 **Signature:**
 

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/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/grid_layouts.md

@@ -1,13 +1,13 @@
 ---
 {
-  "title": "GRID_LAYOUTS variable",
+  "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 variable
+# GRID_LAYOUTS
 
 **Signature:**