@livekit/components-js-docs 0.1.0 → 0.1.2

package/generated-docs/core/participanteventselector.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "participantEventSelector",
+  "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. -->
 
 # participantEventSelector
@@ -7,6 +14,6 @@
 ```typescript
 export declare function participantEventSelector<T extends ParticipantEvent>(
   participant: Participant,
-  event: T,
+  event: T
 ): Observable<Parameters<ParticipantEventCallbacks[Extract<T, keyof ParticipantEventCallbacks>]>>;
 ```

package/generated-docs/core/participantfilter.md

@@ -1,9 +1,16 @@
+---
+{
+  "title": "ParticipantFilter 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. -->
 
-## ParticipantFilter type
+# ParticipantFilter type
 
 **Signature:**
 
 ```typescript
-export type ParticipantFilter = Parameters<Participant[]['filter']>['0'];
+export type ParticipantFilter = Parameters<Participant[]["filter"]>["0"];
 ```

package/generated-docs/core/participantinfoobserver.md

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

package/generated-docs/core/participantmedia.cameratrack.md

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

package/generated-docs/core/participantmedia.iscameraenabled.md

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

package/generated-docs/core/participantmedia.ismicrophoneenabled.md

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

package/generated-docs/core/participantmedia.isscreenshareenabled.md

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

package/generated-docs/core/participantmedia.md

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

package/generated-docs/core/participantmedia.microphonetrack.md

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

package/generated-docs/core/participantmedia.participant.md

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

package/generated-docs/core/participantpermissionobserver.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "participantPermissionObserver",
+  "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. -->
 
 # participantPermissionObserver
@@ -6,8 +13,8 @@
 
 ```typescript
 export declare function participantPermissionObserver(
-  participant: Participant,
+  participant: Participant
 ): Observable<
-  import('livekit-client/dist/src/proto/livekit_models_pb').ParticipantPermission | undefined
+  import("livekit-client/dist/src/proto/livekit_models_pb").ParticipantPermission | undefined
 >;
 ```

package/generated-docs/core/pin_default_state.md

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

package/generated-docs/core/pinstate.md

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

package/generated-docs/core/receivedchatmessage.from.md

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

package/generated-docs/core/receivedchatmessage.md

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

package/generated-docs/core/receiveddatamessage.from.md

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

package/generated-docs/core/receiveddatamessage.md

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

package/generated-docs/core/requireonlyone.md

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

package/generated-docs/core/roomaudioplaybackallowedobservable.md

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

package/generated-docs/core/roomeventselector.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "roomEventSelector",
+  "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. -->
 
 # roomEventSelector
@@ -7,6 +14,6 @@
 ```typescript
 export declare function roomEventSelector<T extends RoomEvent>(
   room: Room,
-  event: T,
+  event: T
 ): Observable<Parameters<RoomEventCallbacks[T]>>;
 ```

package/generated-docs/core/roominfoobserver.md

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

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

@@ -0,0 +1,20 @@
+---
+{
+  "title": "saveUserChoices",
+  "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. -->
+
+# saveUserChoices
+
+Saves user choices to local storage.
+
+**Signature:**
+
+```typescript
+export declare function saveUserChoices(userChoices: LocalUserChoices, preventSave?: boolean): void;
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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>;
 ```