@livekit/components-js-docs 0.1.0 → 0.1.1

package/generated-docs/core/roomobserver.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "roomObserver",
+  "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. -->
 
 # roomObserver

package/generated-docs/core/screenshareobserver.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "screenShareObserver",
+  "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. -->
 
 # screenShareObserver

package/generated-docs/core/screensharetrackmap.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "ScreenShareTrackMap type",
+  "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. -->
 
-## ScreenShareTrackMap type
+# ScreenShareTrackMap type
 
 **Signature:**
 

package/generated-docs/core/selectgridlayout.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "selectGridLayout",
+  "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. -->
 
 # selectGridLayout
@@ -9,6 +16,6 @@ export declare function selectGridLayout(
   layouts: GridLayoutDefinition[],
   participantCount: number,
   width: number,
-  height: number,
+  height: number
 ): GridLayoutDefinition;
 ```

package/generated-docs/core/sendmessage.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "sendMessage",
+  "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. -->
 
 # sendMessage
@@ -11,7 +18,7 @@ export declare function sendMessage(
   localParticipant: LocalParticipant,
   payload: Uint8Array,
   topic?: string,
-  options?: DataSendOptions,
+  options?: DataSendOptions
 ): Promise<void>;
 ```
 

package/generated-docs/core/setdifference.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "setDifference",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/set-helper.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # setDifference

package/generated-docs/core/setloglevel.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "setLogLevel",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/logger.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # setLogLevel

package/generated-docs/core/setmediadeviceoptions.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "SetMediaDeviceOptions type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/mediaDeviceSelect.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## SetMediaDeviceOptions type
+# SetMediaDeviceOptions type
 
 **Signature:**
 

package/generated-docs/core/setupchat.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "setupChat",
+  "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. -->
 
 # setupChat
@@ -10,9 +17,9 @@ export declare function setupChat(
   options?: {
     messageEncoder?: (message: ChatMessage) => Uint8Array;
     messageDecoder?: (message: Uint8Array) => ReceivedChatMessage;
-  },
+  }
 ): {
-  messageObservable: import('rxjs').Observable<ReceivedChatMessage[]>;
+  messageObservable: import("rxjs").Observable<ReceivedChatMessage[]>;
   isSendingObservable: BehaviorSubject<boolean>;
   send: (message: string) => Promise<void>;
   destroy: () => void;

package/generated-docs/core/setupchattoggle.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "setupChatToggle",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/chatToggle.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # setupChatToggle

package/generated-docs/core/setupclearpinbutton.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "setupClearPinButton",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/clearPinButton.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # setupClearPinButton

package/generated-docs/core/setupconnectionqualityindicator.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "setupConnectionQualityIndicator",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/connectionQualityIndicator.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # setupConnectionQualityIndicator
@@ -6,7 +13,7 @@
 
 ```typescript
 export declare function setupConnectionQualityIndicator(participant: Participant): {
-  className: 'lk-connection-quality';
-  connectionQualityObserver: import('rxjs').Observable<import('livekit-client').ConnectionQuality>;
+  className: "lk-connection-quality";
+  connectionQualityObserver: import("rxjs").Observable<import("livekit-client").ConnectionQuality>;
 };
 ```

package/generated-docs/core/setupdatamessagehandler.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "setupDataMessageHandler",
+  "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. -->
 
 # setupDataMessageHandler
@@ -8,12 +15,12 @@
 export declare function setupDataMessageHandler<T extends string>(
   room: Room,
   topic?: T,
-  onMessage?: (msg: ReceivedDataMessage<T>) => void,
+  onMessage?: (msg: ReceivedDataMessage<T>) => void
 ): {
   messageObservable: Observable<{
     payload: Uint8Array;
     topic: T;
-    from: import('livekit-client').RemoteParticipant | undefined;
+    from: import("livekit-client").RemoteParticipant | undefined;
   }>;
   isSendingObservable: Observable<boolean>;
   send: (payload: Uint8Array, options?: DataSendOptions) => Promise<void>;

package/generated-docs/core/setupdeviceselector.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "setupDeviceSelector",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/mediaDeviceSelect.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # setupDeviceSelector
@@ -8,10 +15,10 @@
 export declare function setupDeviceSelector(
   kind: MediaDeviceKind,
   room?: Room,
-  localTrack?: LocalAudioTrack | LocalVideoTrack,
+  localTrack?: LocalAudioTrack | LocalVideoTrack
 ): {
   className: string;
-  activeDeviceObservable: import('rxjs').Observable<string | undefined>;
+  activeDeviceObservable: import("rxjs").Observable<string | undefined>;
   setActiveMediaDevice: (id: string, options?: SetMediaDeviceOptions) => Promise<void>;
 };
 ```

package/generated-docs/core/setupdisconnectbutton.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "setupDisconnectButton",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/disconnectButton.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # setupDisconnectButton

package/generated-docs/core/setupfocustoggle.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "setupFocusToggle",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/focusToggle.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # setupFocusToggle

package/generated-docs/core/setuplivekitroom.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "setupLiveKitRoom",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/room.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # setupLiveKitRoom

package/generated-docs/core/setupmanualtoggle.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "setupManualToggle",
+  "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. -->
 
 # setupManualToggle

package/generated-docs/core/setupmediatoggle.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "setupMediaToggle",
+  "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. -->
 
 # setupMediaToggle
@@ -8,6 +15,6 @@
 export declare function setupMediaToggle<T extends ToggleSource>(
   source: T,
   room: Room,
-  options?: CaptureOptionsBySource<T>,
+  options?: CaptureOptionsBySource<T>
 ): MediaToggleType<T>;
 ```

package/generated-docs/core/setupmediatrack.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "setupMediaTrack",
+  "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. -->
 
 # setupMediaTrack
@@ -7,6 +14,6 @@
 ```typescript
 export declare function setupMediaTrack(trackIdentifier: TrackIdentifier): {
   className: string;
-  trackObserver: import('rxjs').Observable<import('livekit-client').TrackPublication | undefined>;
+  trackObserver: import("rxjs").Observable<import("livekit-client").TrackPublication | undefined>;
 };
 ```

package/generated-docs/core/setupparticipantname.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "setupParticipantName",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/participantName.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # setupParticipantName
@@ -7,7 +14,7 @@
 ```typescript
 export declare function setupParticipantName(participant: Participant): {
   className: string;
-  infoObserver: import('rxjs').Observable<
+  infoObserver: import("rxjs").Observable<
     | {
         name: string | undefined;
         identity: string;

package/generated-docs/core/setupparticipanttile.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "setupParticipantTile",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/participantTile.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
 # setupParticipantTile

package/generated-docs/core/setupstartaudio.md

@@ -1,3 +1,10 @@
+---
+{
+  "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

package/generated-docs/core/setuptrackmutedindicator.md

@@ -1,3 +1,10 @@
+---
+{
+  "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
@@ -7,6 +14,6 @@
 ```typescript
 export declare function setupTrackMutedIndicator(trackRef: TrackReferenceOrPlaceholder): {
   className: string;
-  mediaMutedObserver: import('rxjs').Observable<boolean>;
+  mediaMutedObserver: import("rxjs").Observable<boolean>;
 };
 ```

package/generated-docs/core/sortparticipants.md

@@ -1,3 +1,10 @@
+---
+{
+  "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

package/generated-docs/core/sorttrackreferences.md

@@ -1,3 +1,10 @@
+---
+{
+  "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
@@ -8,7 +15,7 @@ Default sort for `TrackReferenceOrPlaceholder`<!-- -->, it'll order participants
 
 ```typescript
 export declare function sortTrackReferences(
-  tracks: TrackReferenceOrPlaceholder[],
+  tracks: TrackReferenceOrPlaceholder[]
 ): TrackReferenceOrPlaceholder[];
 ```
 

package/generated-docs/core/sourcesarray.md

@@ -1,6 +1,13 @@
+---
+{
+  "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
+# SourcesArray type
 
 **Signature:**
 

package/generated-docs/core/supportsscreensharing.md

@@ -1,3 +1,10 @@
+---
+{
+  "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

package/generated-docs/core/togglesource.md

@@ -1,6 +1,13 @@
+---
+{
+  "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
+# ToggleSource type
 
 **Signature:**
 

package/generated-docs/core/tokenize.md

@@ -1,3 +1,10 @@
+---
+{
+  "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
@@ -7,7 +14,7 @@
 ```typescript
 export declare function tokenize<T extends TokenizeGrammar>(
   input: string,
-  grammar: T,
+  grammar: T
 ): (
   | string
   | {

package/generated-docs/core/tokenizegrammar.md

@@ -1,6 +1,13 @@
+---
+{
+  "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
+# TokenizeGrammar type
 
 **Signature:**
 

package/generated-docs/core/trackidentifier.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "TrackIdentifier 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. -->
 
-## TrackIdentifier type
+# TrackIdentifier type
 
 The TrackIdentifier type is used to select Tracks either based on - Track.Source and/or name of the track, e.g. `{source: Track.Source.Camera}` or `{name: "my-track"}` - TrackReference (participant and publication)
 

package/generated-docs/core/trackobservable.md

@@ -1,3 +1,10 @@
+---
+{
+  "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

package/generated-docs/core/trackreference.md

@@ -1,6 +1,13 @@
+---
+{
+  "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
+# TrackReference type
 
 **Signature:**
 

package/generated-docs/core/trackreferencefilter.md

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

package/generated-docs/core/trackreferenceid.md

@@ -1,6 +1,13 @@
+---
+{
+  "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
+# TrackReferenceId type
 
 **Signature:**
 

package/generated-docs/core/trackreferenceorplaceholder.md

@@ -1,6 +1,13 @@
+---
+{
+  "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
+# TrackReferenceOrPlaceholder type
 
 **Signature:**
 

package/generated-docs/core/trackreferenceplaceholder.md

@@ -1,6 +1,13 @@
+---
+{
+  "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
+# TrackReferencePlaceholder type
 
 **Signature:**
 

package/generated-docs/core/trackreferencesobservable.md

@@ -1,3 +1,10 @@
+---
+{
+  "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
@@ -8,7 +15,7 @@
 export declare function trackReferencesObservable(
   room: Room,
   sources: Track.Source[],
-  options: TrackReferencesObservableOptions,
+  options: TrackReferencesObservableOptions
 ): Observable<{
   trackReferences: TrackReference[];
   participants: Participant[];

package/generated-docs/core/tracksource.md

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