@livekit/components-js-docs 0.0.5 → 0.1.1

package/generated-docs/core/activespeakerobserver.md

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

package/generated-docs/core/allparticipantevents.md

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

package/generated-docs/core/allparticipantroomevents.md

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

package/generated-docs/core/allremoteparticipantevents.md

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

package/generated-docs/core/allremoteparticipantroomevents.md

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

package/generated-docs/core/attachifsubscribed.md

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

package/generated-docs/core/audiosource.md

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

package/generated-docs/core/basedatamessage.md

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

package/generated-docs/core/basedatamessage.payload.md

@@ -1,6 +1,10 @@
+---
+{ "title": "BaseDataMessage.payload property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## BaseDataMessage.payload property
+# BaseDataMessage.payload property
 
 **Signature:**
 

package/generated-docs/core/basedatamessage.topic.md

@@ -1,6 +1,10 @@
+---
+{ "title": "BaseDataMessage.topic property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## BaseDataMessage.topic property
+# BaseDataMessage.topic property
 
 **Signature:**
 

package/generated-docs/core/captureoptionsbysource.md

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

package/generated-docs/core/chatmessage.md

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

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

@@ -1,6 +1,10 @@
+---
+{ "title": "ChatMessage.message property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ChatMessage.message property
+# ChatMessage.message property
 
 **Signature:**
 

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

@@ -1,6 +1,10 @@
+---
+{ "title": "ChatMessage.timestamp property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ChatMessage.timestamp property
+# ChatMessage.timestamp property
 
 **Signature:**
 

package/generated-docs/core/computemenuposition.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "computeMenuPosition",
+  "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. -->
 
 # computeMenuPosition
@@ -7,7 +14,7 @@
 ```typescript
 export declare function computeMenuPosition(
   button: HTMLElement,
-  menu: HTMLElement,
+  menu: HTMLElement
 ): Promise<{
   x: number;
   y: number;

package/generated-docs/core/connectedparticipantobserver.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "connectedParticipantObserver",
+  "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. -->
 
 # connectedParticipantObserver
@@ -8,6 +15,6 @@
 export declare function connectedParticipantObserver(
   room: Room,
   identity: string,
-  options?: ConnectedParticipantObserverOptions,
+  options?: ConnectedParticipantObserverOptions
 ): Observable<RemoteParticipant | undefined>;
 ```

package/generated-docs/core/connectedparticipantobserveroptions.md

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

package/generated-docs/core/connectedparticipantsobserver.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "connectedParticipantsObserver",
+  "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. -->
 
 # connectedParticipantsObserver
@@ -7,6 +14,6 @@
 ```typescript
 export declare function connectedParticipantsObserver(
   room: Room,
-  options?: ConnectedParticipantsObserverOptions,
+  options?: ConnectedParticipantsObserverOptions
 ): Observable<RemoteParticipant[]>;
 ```

package/generated-docs/core/connectionstateobserver.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "connectionStateObserver",
+  "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. -->
 
 # connectionStateObserver
@@ -6,6 +13,6 @@
 
 ```typescript
 export declare function connectionStateObserver(
-  room: Room,
-): Observable<import('livekit-client').ConnectionState>;
+  room: Room
+): Observable<import("livekit-client").ConnectionState>;
 ```

package/generated-docs/core/createactivedeviceobservable.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "createActiveDeviceObservable",
+  "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. -->
 
 # createActiveDeviceObservable
@@ -7,6 +14,6 @@
 ```typescript
 export declare function createActiveDeviceObservable(
   room: Room,
-  kind: MediaDeviceKind,
+  kind: MediaDeviceKind
 ): Observable<string | undefined>;
 ```

package/generated-docs/core/createconnectionqualityobserver.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "createConnectionQualityObserver",
+  "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. -->
 
 # createConnectionQualityObserver
@@ -6,6 +13,6 @@
 
 ```typescript
 export declare function createConnectionQualityObserver(
-  participant: Participant,
-): Observable<import('livekit-client').ConnectionQuality>;
+  participant: Participant
+): Observable<import("livekit-client").ConnectionQuality>;
 ```

package/generated-docs/core/createdataobserver.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "createDataObserver",
+  "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. -->
 
 # createDataObserver
@@ -6,13 +13,13 @@
 
 ```typescript
 export declare function createDataObserver(
-  room: Room,
+  room: Room
 ): Observable<
   [
     payload: Uint8Array,
-    participant?: import('livekit-client').RemoteParticipant | undefined,
-    kind?: import('livekit-client').DataPacket_Kind | undefined,
-    topic?: string | undefined,
+    participant?: import("livekit-client").RemoteParticipant | undefined,
+    kind?: import("livekit-client").DataPacket_Kind | undefined,
+    topic?: string | undefined
   ]
 >;
 ```

package/generated-docs/core/createdefaultgrammar.md

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

package/generated-docs/core/createisspeakingobserver.md

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

package/generated-docs/core/createmediadeviceobserver.md

@@ -1,3 +1,10 @@
+---
+{
+  "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
@@ -7,6 +14,6 @@
 ```typescript
 export declare function createMediaDeviceObserver(
   kind?: MediaDeviceKind,
-  requestPermissions?: boolean,
+  requestPermissions?: boolean
 ): Observable<MediaDeviceInfo[]>;
 ```

package/generated-docs/core/createtrackobserver.md

@@ -1,3 +1,10 @@
+---
+{
+  "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
@@ -7,7 +14,7 @@
 ```typescript
 export declare function createTrackObserver(
   participant: Participant,
-  options: TrackIdentifier,
+  options: TrackIdentifier
 ): Observable<{
   publication: TrackPublication | undefined;
 }>;

package/generated-docs/core/createurlregexp.md

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

package/generated-docs/core/cssprefix.md

@@ -1,9 +1,16 @@
+---
+{
+  "title": "cssPrefix variable",
+  "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 variable
 
 **Signature:**
 
 ```typescript
-cssPrefix = 'lk';
+cssPrefix = "lk";
 ```

package/generated-docs/core/datasendoptions.md

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

package/generated-docs/core/datatopic.md

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

package/generated-docs/core/encryptionstatusobservable.md

@@ -1,3 +1,10 @@
+---
+{
+  "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
@@ -7,6 +14,6 @@
 ```typescript
 export declare function encryptionStatusObservable(
   room: Room,
-  participant: Participant,
+  participant: Participant
 ): Observable<boolean>;
 ```

package/generated-docs/core/gettrackbyidentifier.md

@@ -1,3 +1,10 @@
+---
+{
+  "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
@@ -6,6 +13,6 @@
 
 ```typescript
 export declare function getTrackByIdentifier(
-  options: TrackIdentifier,
-): import('livekit-client').TrackPublication | undefined;
+  options: TrackIdentifier
+): import("livekit-client").TrackPublication | undefined;
 ```

package/generated-docs/core/gettrackreferenceid.md

@@ -1,15 +1,26 @@
+---
+{
+  "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` based on participant and source.
+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,
+  trackReference: TrackReferenceOrPlaceholder | number
 ): string;
 ```
 
+## Remarks
+
+The id pattern is: `${participantIdentity}_${trackSource}_${trackSid}` for `TrackReference` and `${participantIdentity}_${trackSource}_placeholder` for `TrackReferencePlaceholder`<!-- -->.
+
 {% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/gettrackreferencesource.md

@@ -1,3 +1,10 @@
+---
+{
+  "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
@@ -8,7 +15,7 @@ Returns the Source of the TrackReference.
 
 ```typescript
 export declare function getTrackReferenceSource(
-  trackReference: TrackReferenceOrPlaceholder,
+  trackReference: TrackReferenceOrPlaceholder
 ): Track.Source;
 ```
 

package/generated-docs/core/grid_layouts.md

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

package/generated-docs/core/gridlayoutdefinition.md

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