@livekit/components-js-docs 0.0.0-20251021151641

package/generated-docs/core/setupstartaudio.md

@@ -0,0 +1,20 @@
+---
+{
+  "title": "setupStartAudio",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/startAudio.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupStartAudio
+
+**Signature:**
+
+```typescript
+export declare function setupStartAudio(): {
+  className: string;
+  roomAudioPlaybackAllowedObservable: typeof roomAudioPlaybackAllowedObservable;
+  handleStartAudioPlayback: (room: Room) => Promise<void>;
+};
+```

package/generated-docs/core/setupstartvideo.md

@@ -0,0 +1,20 @@
+---
+{
+  "title": "setupStartVideo",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/startVideo.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupStartVideo
+
+**Signature:**
+
+```typescript
+export declare function setupStartVideo(): {
+  className: string;
+  roomVideoPlaybackAllowedObservable: typeof roomVideoPlaybackAllowedObservable;
+  handleStartVideoPlayback: (room: Room) => Promise<void>;
+};
+```

package/generated-docs/core/setuptextstream.md

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

package/generated-docs/core/setuptrackmutedindicator.md

@@ -0,0 +1,19 @@
+---
+{
+  "title": "setupTrackMutedIndicator",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/trackMutedIndicator.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setupTrackMutedIndicator
+
+**Signature:**
+
+```typescript
+export declare function setupTrackMutedIndicator(trackRef: TrackReferenceOrPlaceholder): {
+  className: string;
+  mediaMutedObserver: import("rxjs").Observable<boolean>;
+};
+```

package/generated-docs/core/sortparticipants.md

@@ -0,0 +1,18 @@
+---
+{
+  "title": "sortParticipants",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/sorting/sort-participants.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# sortParticipants
+
+Default sort for participants, it'll order participants by: 1. local participant 2. dominant speaker (speaker with the loudest audio level) 3. other speakers that are recently active 4. participants with video on 5. by joinedAt
+
+**Signature:**
+
+```typescript
+export declare function sortParticipants(participants: Participant[]): Participant[];
+```

package/generated-docs/core/sorttrackreferences.md

@@ -0,0 +1,20 @@
+---
+{
+  "title": "sortTrackReferences",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/sorting/sort-track-bundles.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# sortTrackReferences
+
+Default sort for `TrackReferenceOrPlaceholder`<!-- -->, it'll order participants by: 1. local camera track (publication.isLocal) 2. remote screen_share track 3. local screen_share track 4. remote dominant speaker camera track (sorted by speaker with the loudest audio level) 5. other remote speakers that are recently active 6. remote unmuted camera tracks 7. remote tracks sorted by joinedAt
+
+**Signature:**
+
+```typescript
+export declare function sortTrackReferences(
+  tracks: TrackReferenceOrPlaceholder[]
+): TrackReferenceOrPlaceholder[];
+```

package/generated-docs/core/sourcesarray.md

@@ -0,0 +1,18 @@
+---
+{
+  "title": "SourcesArray 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. -->
+
+# SourcesArray type
+
+**Signature:**
+
+```typescript
+export type SourcesArray = Track.Source[] | TrackSourceWithOptions[];
+```
+
+**References:** [TrackSourceWithOptions](./core/tracksourcewithoptions.md)

package/generated-docs/core/supportsscreensharing.md

@@ -0,0 +1,18 @@
+---
+{
+  "title": "supportsScreenSharing",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/featureDetection.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# supportsScreenSharing
+
+Returns `true` if the browser supports screen sharing.
+
+**Signature:**
+
+```typescript
+export declare function supportsScreenSharing(): boolean;
+```

package/generated-docs/core/textstreamdata.md

@@ -0,0 +1,24 @@
+---
+{
+  "title": "TextStreamData interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/textStream.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# TextStreamData interface
+
+**Signature:**
+
+```typescript
+export interface TextStreamData
+```
+
+## Properties
+
+| Property                                                    | Type                  | Description |
+| ----------------------------------------------------------- | --------------------- | ----------- |
+| [participantInfo](./core/textstreamdata.participantinfo.md) | { identity: string; } |             |
+| [streamInfo](./core/textstreamdata.streaminfo.md)           | TextStreamInfo        |             |
+| [text](./core/textstreamdata.text.md)                       | string                |             |

package/generated-docs/core/textstreamdata.participantinfo.md

@@ -0,0 +1,15 @@
+---
+{ "title": "TextStreamData.participantInfo property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# TextStreamData.participantInfo property
+
+**Signature:**
+
+```typescript
+participantInfo: {
+  identity: string;
+}
+```

package/generated-docs/core/textstreamdata.streaminfo.md

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

package/generated-docs/core/textstreamdata.text.md

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

package/generated-docs/core/togglesource.md

@@ -0,0 +1,19 @@
+---
+{
+  "title": "ToggleSource 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. -->
+
+# ToggleSource type
+
+**Signature:**
+
+```typescript
+export type ToggleSource = Exclude<
+  Track.Source,
+  Track.Source.ScreenShareAudio | Track.Source.Unknown
+>;
+```

package/generated-docs/core/tokenize.md

@@ -0,0 +1,25 @@
+---
+{
+  "title": "tokenize",
+  "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. -->
+
+# tokenize
+
+**Signature:**
+
+```typescript
+export declare function tokenize<T extends TokenizeGrammar>(
+  input: string,
+  grammar: T
+): (
+  | string
+  | {
+      type: keyof T;
+      content: string;
+    }
+)[];
+```

package/generated-docs/core/tokenizegrammar.md

@@ -0,0 +1,18 @@
+---
+{
+  "title": "TokenizeGrammar type",
+  "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. -->
+
+# TokenizeGrammar type
+
+**Signature:**
+
+```typescript
+export type TokenizeGrammar = {
+  [type: string]: RegExp;
+};
+```

package/generated-docs/core/trackeventselector.md

@@ -0,0 +1,19 @@
+---
+{
+  "title": "trackEventSelector",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/track.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# trackEventSelector
+
+**Signature:**
+
+```typescript
+export declare function trackEventSelector<T extends TrackEvent>(
+  publication: TrackPublication | Track,
+  event: T
+): Observable<Parameters<PublicationEventCallbacks[Extract<T, keyof PublicationEventCallbacks>]>>;
+```

package/generated-docs/core/trackobservable.md

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

package/generated-docs/core/trackreference.md

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

@@ -0,0 +1,18 @@
+---
+{
+  "title": "TrackReferenceFilter 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. -->
+
+# TrackReferenceFilter type
+
+**Signature:**
+
+```typescript
+export type TrackReferenceFilter = Parameters<TrackReferenceOrPlaceholder[]["filter"]>["0"];
+```
+
+**References:** [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)

package/generated-docs/core/trackreferenceid.md

@@ -0,0 +1,16 @@
+---
+{
+  "title": "TrackReferenceId type",
+  "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. -->
+
+# TrackReferenceId type
+
+**Signature:**
+
+```typescript
+export type TrackReferenceId = ReturnType<typeof getTrackReferenceId>;
+```

package/generated-docs/core/trackreferenceorplaceholder.md

@@ -0,0 +1,18 @@
+---
+{
+  "title": "TrackReferenceOrPlaceholder type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/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](./core/trackreference.md)<!-- -->, [TrackReferencePlaceholder](./core/trackreferenceplaceholder.md)

package/generated-docs/core/trackreferenceplaceholder.md

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

package/generated-docs/core/trackreferencesobservable.md

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

package/generated-docs/core/tracksource.md

@@ -0,0 +1,23 @@
+---
+{
+  "title": "TrackSource 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. -->
+
+# TrackSource type
+
+**Signature:**
+
+```typescript
+export type TrackSource<T extends Track.Source> = RequireAtLeastOne<
+  {
+    source: T;
+    name: string;
+    participant: Participant;
+  },
+  "name" | "source"
+>;
+```

package/generated-docs/core/tracksourcewithoptions.md

@@ -0,0 +1,19 @@
+---
+{
+  "title": "TrackSourceWithOptions 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. -->
+
+# TrackSourceWithOptions type
+
+**Signature:**
+
+```typescript
+export type TrackSourceWithOptions = {
+  source: Track.Source;
+  withPlaceholder: boolean;
+};
+```

package/generated-docs/core/tracksynctimeobserver.md

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

package/generated-docs/core/tracktranscriptionobserver.md

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

package/generated-docs/core/updatepages.md

@@ -0,0 +1,22 @@
+---
+{
+  "title": "updatePages",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/sorting/tile-array-update.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# updatePages
+
+Divide the list of elements into pages and and check if pages need updating.
+
+**Signature:**
+
+```typescript
+export declare function updatePages<T extends UpdatableItem>(
+  currentList: T[],
+  nextList: T[],
+  maxItemsOnPage: number
+): T[];
+```

package/generated-docs/core/videosource.md

@@ -0,0 +1,16 @@
+---
+{
+  "title": "VideoSource 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. -->
+
+# VideoSource type
+
+**Signature:**
+
+```typescript
+export type VideoSource = Track.Source.Camera | Track.Source.ScreenShare;
+```

package/generated-docs/core/wasclickoutside.md

@@ -0,0 +1,16 @@
+---
+{
+  "title": "wasClickOutside",
+  "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. -->
+
+# wasClickOutside
+
+**Signature:**
+
+```typescript
+export declare function wasClickOutside(insideElement: HTMLElement, event: MouseEvent): boolean;
+```

package/generated-docs/core/widget_default_state.md

@@ -0,0 +1,16 @@
+---
+{
+  "title": "WIDGET_DEFAULT_STATE",
+  "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. -->
+
+# WIDGET_DEFAULT_STATE
+
+**Signature:**
+
+```typescript
+WIDGET_DEFAULT_STATE: WidgetState;
+```

package/generated-docs/core/widgetstate.md

@@ -0,0 +1,20 @@
+---
+{
+  "title": "WidgetState 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. -->
+
+# WidgetState type
+
+**Signature:**
+
+```typescript
+export type WidgetState = {
+  showChat: boolean;
+  unreadMessages: number;
+  showSettings?: boolean;
+};
+```

package/generated-docs/index.md

@@ -0,0 +1,14 @@
+---
+{ "title": "API Reference" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# API Reference
+
+## Packages
+
+| Package                                       | Description |
+| --------------------------------------------- | ----------- |
+| [@livekit/components-core](./core/index.md)   |             |
+| [@livekit/components-react](./react/index.md) |             |