@livekit/components-js-docs 0.1.0 → 0.1.2

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,3 +1,10 @@
+---
+{
+  "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
@@ -8,7 +15,7 @@ Returns a id to identify the `TrackReference` or `TrackReferencePlaceholder` bas
 
 ```typescript
 export declare function getTrackReferenceId(
-  trackReference: TrackReferenceOrPlaceholder | number,
+  trackReference: TrackReferenceOrPlaceholder | number
 ): string;
 ```
 

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:**
 

package/generated-docs/core/index.md

@@ -1,6 +1,10 @@
+---
+{ "title": "components-core package" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## components-core package
+# components-core package
 
 ## Others
 
@@ -28,7 +32,7 @@
 | [createIsSpeakingObserver(participant)](./core/createisspeakingobserver.md)                          |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [createMediaDeviceObserver(kind, requestPermissions)](./core/createmediadeviceobserver.md)           |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [createTrackObserver(participant, options)](./core/createtrackobserver.md)                           |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [createUrlRegExp](./core/createurlregexp.md)                                                         |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [createUrlRegExp(options)](./core/createurlregexp.md)                                                |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [cssPrefix](./core/cssprefix.md)                                                                     |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [DataSendOptions](./core/datasendoptions.md)                                                         |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [DataTopic](./core/datatopic.md)                                                                     |                                                                                                                                                                                                                                                                                                                                                                                                             |
@@ -49,6 +53,8 @@
 | [isTrackReference(trackReference)](./core/istrackreference.md)                                       |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [isTrackReferencePinned(trackReference, pinState)](./core/istrackreferencepinned.md)                 | Check if the <code>TrackReference</code> is pinned.                                                                                                                                                                                                                                                                                                                                                         |
 | [isTrackReferencePlaceholder(trackReference)](./core/istrackreferenceplaceholder.md)                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [loadUserChoices(defaults, preventLoad)](./core/loaduserchoices.md)                                  | Reads the user choices from local storage, or returns the default settings if none are found.                                                                                                                                                                                                                                                                                                               |
+| [LocalUserChoices](./core/localuserchoices.md)                                                       | Represents the user's choices for video and audio input devices, as well as their username.                                                                                                                                                                                                                                                                                                                 |
 | [log](./core/log.md)                                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [MediaToggleType](./core/mediatoggletype.md)                                                         |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [MessageDecoder](./core/messagedecoder.md)                                                           |                                                                                                                                                                                                                                                                                                                                                                                                             |
@@ -73,6 +79,7 @@
 | [roomEventSelector(room, event)](./core/roomeventselector.md)                                        |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [roomInfoObserver(room)](./core/roominfoobserver.md)                                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [roomObserver(room)](./core/roomobserver.md)                                                         |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [saveUserChoices(userChoices, preventSave)](./core/saveuserchoices.md)                               | Saves user choices to local storage.                                                                                                                                                                                                                                                                                                                                                                        |
 | [screenShareObserver(room)](./core/screenshareobserver.md)                                           |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [ScreenShareTrackMap](./core/screensharetrackmap.md)                                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [selectGridLayout(layouts, participantCount, width, height)](./core/selectgridlayout.md)             |                                                                                                                                                                                                                                                                                                                                                                                                             |

package/generated-docs/core/isequaltrackref.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "isEqualTrackRef",
+  "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. -->
 
 # isEqualTrackRef
@@ -7,6 +14,6 @@
 ```typescript
 export declare function isEqualTrackRef(
   a?: TrackReferenceOrPlaceholder,
-  b?: TrackReferenceOrPlaceholder,
+  b?: TrackReferenceOrPlaceholder
 ): boolean;
 ```

package/generated-docs/core/islocal.md

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

package/generated-docs/core/ismobilebrowser.md

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

package/generated-docs/core/isparticipantsourcepinned.md

@@ -1,10 +1,21 @@
+---
+{
+  "title": "isParticipantSourcePinned",
+  "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. -->
 
 # isParticipantSourcePinned
 
-> Warning: This API is now obsolete.
->
-> Use [isParticipantTrackReferencePinned()](./core/isparticipanttrackreferencepinned.md) instead.
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+Use [isParticipantTrackReferencePinned()](./core/isparticipanttrackreferencepinned.md) instead.
+
+{% /callout %}
 
 Check if the participant track source is pinned.
 
@@ -14,7 +25,7 @@ Check if the participant track source is pinned.
 export declare function isParticipantSourcePinned(
   participant: Participant,
   source: Track.Source,
-  pinState: PinState | undefined,
+  pinState: PinState | undefined
 ): boolean;
 ```
 

package/generated-docs/core/isparticipanttrackreferencepinned.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "isParticipantTrackReferencePinned",
+  "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. -->
 
 # isParticipantTrackReferencePinned
@@ -9,7 +16,7 @@ Check if the participant track reference is pinned.
 ```typescript
 export declare function isParticipantTrackReferencePinned(
   trackRef: TrackReference,
-  pinState: PinState | undefined,
+  pinState: PinState | undefined
 ): boolean;
 ```
 

package/generated-docs/core/isremote.md

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

package/generated-docs/core/issourceswithoptions.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "isSourcesWithOptions",
+  "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. -->
 
 # isSourcesWithOptions
@@ -6,6 +13,6 @@
 
 ```typescript
 export declare function isSourcesWithOptions(
-  sources: SourcesArray,
+  sources: SourcesArray
 ): sources is TrackSourceWithOptions[];
 ```

package/generated-docs/core/issourcewitoptions.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "isSourceWitOptions",
+  "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. -->
 
 # isSourceWitOptions
@@ -6,6 +13,6 @@
 
 ```typescript
 export declare function isSourceWitOptions(
-  source: SourcesArray[number],
+  source: SourcesArray[number]
 ): source is TrackSourceWithOptions;
 ```

package/generated-docs/core/istrackreference.md

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

package/generated-docs/core/istrackreferencepinned.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "isTrackReferencePinned",
+  "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. -->
 
 # isTrackReferencePinned
@@ -9,7 +16,7 @@ Check if the `TrackReference` is pinned.
 ```typescript
 export declare function isTrackReferencePinned(
   trackReference: TrackReferenceOrPlaceholder,
-  pinState: PinState | undefined,
+  pinState: PinState | undefined
 ): boolean;
 ```
 

package/generated-docs/core/istrackreferenceplaceholder.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "isTrackReferencePlaceholder",
+  "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. -->
 
 # isTrackReferencePlaceholder
@@ -6,6 +13,6 @@
 
 ```typescript
 export declare function isTrackReferencePlaceholder(
-  trackReference?: TrackReferenceOrPlaceholder,
+  trackReference?: TrackReferenceOrPlaceholder
 ): trackReference is TrackReferencePlaceholder;
 ```

package/generated-docs/core/loaduserchoices.md

@@ -0,0 +1,27 @@
+---
+{
+  "title": "loadUserChoices",
+  "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. -->
+
+# loadUserChoices
+
+Reads the user choices from local storage, or returns the default settings if none are found.
+
+**Signature:**
+
+```typescript
+export declare function loadUserChoices(
+  defaults?: Partial<LocalUserChoices>,
+  preventLoad?: boolean
+): LocalUserChoices;
+```
+
+## Remarks
+
+The deprecated parameters `e2ee` and `sharedPassphrase` are not read from local storage and always return the value from the passed `defaults` or internal defaults.
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/{react → core}/localuserchoices.md

@@ -1,16 +1,25 @@
+---
+{
+  "title": "LocalUserChoices type",
+  "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. -->
 
-## LocalUserChoices type
+# LocalUserChoices type
+
+Represents the user's choices for video and audio input devices, as well as their username.
 
 **Signature:**
 
 ```typescript
 export type LocalUserChoices = {
-  username: string;
   videoEnabled: boolean;
   audioEnabled: boolean;
   videoDeviceId: string;
   audioDeviceId: string;
+  username: string;
   e2ee: boolean;
   sharedPassphrase: string;
 };

package/generated-docs/core/log.md

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

package/generated-docs/core/mediatoggletype.md

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

package/generated-docs/core/messagedecoder.md

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

package/generated-docs/core/messageencoder.md

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

package/generated-docs/core/mutedobserver.md

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

package/generated-docs/core/observeparticipantevents.md

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

package/generated-docs/core/observeparticipantmedia.md

@@ -1,3 +1,10 @@
+---
+{
+  "title": "observeParticipantMedia",
+  "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. -->
 
 # observeParticipantMedia
@@ -6,6 +13,6 @@
 
 ```typescript
 export declare function observeParticipantMedia<T extends Participant>(
-  participant: T,
+  participant: T
 ): Observable<ParticipantMedia<T>>;
 ```

package/generated-docs/core/observeroomevents.md

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

package/generated-docs/core/observetrackevents.md

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

package/generated-docs/core/participantclickevent.md

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

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

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

package/generated-docs/core/participantclickevent.track.md

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