@livekit/components-js-docs 0.0.2 → 0.0.4

package/generated-docs/core/activespeakerobserver.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# activeSpeakerObserver (undefined)
+# activeSpeakerObserver
 
 **Signature:**
 

package/generated-docs/core/computemenuposition.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# computeMenuPosition (undefined)
+# computeMenuPosition
 
 **Signature:**
 

package/generated-docs/core/connectedparticipantobserver.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# connectedParticipantObserver (undefined)
+# connectedParticipantObserver
 
 **Signature:**
 

package/generated-docs/core/connectedparticipantsobserver.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# connectedParticipantsObserver (undefined)
+# connectedParticipantsObserver
 
 **Signature:**
 

package/generated-docs/core/connectionstateobserver.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# connectionStateObserver (undefined)
+# connectionStateObserver
 
 **Signature:**
 

package/generated-docs/core/createactivedeviceobservable.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# createActiveDeviceObservable (undefined)
+# createActiveDeviceObservable
 
 **Signature:**
 

package/generated-docs/core/createconnectionqualityobserver.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# createConnectionQualityObserver (undefined)
+# createConnectionQualityObserver
 
 **Signature:**
 

package/generated-docs/core/createdataobserver.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# createDataObserver (undefined)
+# createDataObserver
 
 **Signature:**
 

package/generated-docs/core/createisspeakingobserver.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# createIsSpeakingObserver (undefined)
+# createIsSpeakingObserver
 
 **Signature:**
 

package/generated-docs/core/createmediadeviceobserver.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# createMediaDeviceObserver (undefined)
+# createMediaDeviceObserver
 
 **Signature:**
 

package/generated-docs/core/createtrackobserver.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# createTrackObserver (undefined)
+# createTrackObserver
 
 **Signature:**
 

package/generated-docs/core/gettrackbyidentifier.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# getTrackByIdentifier (undefined)
+# getTrackByIdentifier
 
 **Signature:**
 

package/generated-docs/core/gettrackreferenceid.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# getTrackReferenceId (undefined)
+# getTrackReferenceId
 
 Returns a id to identify the `TrackReference` based on participant and source.
 
@@ -12,4 +12,4 @@ export declare function getTrackReferenceId(
 ): string;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/gettrackreferencesource.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# getTrackReferenceSource (undefined)
+# getTrackReferenceSource
 
 Returns the Source of the TrackReference.
 
@@ -12,4 +12,4 @@ export declare function getTrackReferenceSource(
 ): Track.Source;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/index.md

@@ -76,7 +76,7 @@
 | [setDifference(setA, setB)](./core/setdifference.md)                                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [setLogLevel(level, options)](./core/setloglevel.md)                                            | Set the log level for both the <code>@livekit/components-react</code> package and the <code>@livekit-client</code> package. To set the <code>@livekit-client</code> log independently, use the <code>liveKitClientLogLevel</code> prop on the <code>options</code> object.                                                                                                                                  |
 | [SetMediaDeviceOptions](./core/setmediadeviceoptions.md)                                        |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [setupChat(room)](./core/setupchat.md)                                                          |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [setupChat(room, options)](./core/setupchat.md)                                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [setupChatToggle()](./core/setupchattoggle.md)                                                  |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [setupClearPinButton()](./core/setupclearpinbutton.md)                                          |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [setupConnectionQualityIndicator(participant)](./core/setupconnectionqualityindicator.md)       |                                                                                                                                                                                                                                                                                                                                                                                                             |

package/generated-docs/core/isequaltrackref.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# isEqualTrackRef (undefined)
+# isEqualTrackRef
 
 **Signature:**
 

package/generated-docs/core/islocal.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# isLocal (undefined)
+# isLocal
 
 **Signature:**
 

package/generated-docs/core/ismobilebrowser.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# isMobileBrowser (undefined)
+# isMobileBrowser
 
 Mobile browser detection based on `navigator.userAgent` string. Defaults to returning `false` if not in a browser.
 
@@ -14,4 +14,4 @@ export declare function isMobileBrowser(): boolean;
 
 This should only be used if feature detection or other methods do not work!
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/isparticipantsourcepinned.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# isParticipantSourcePinned (undefined)
+# isParticipantSourcePinned
 
 Check if the participant track source is pinned.
 
@@ -14,4 +14,4 @@ export declare function isParticipantSourcePinned(
 ): boolean;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/isremote.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# isRemote (undefined)
+# isRemote
 
 **Signature:**
 

package/generated-docs/core/issourceswithoptions.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# isSourcesWithOptions (undefined)
+# isSourcesWithOptions
 
 **Signature:**
 

package/generated-docs/core/issourcewitoptions.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# isSourceWitOptions (undefined)
+# isSourceWitOptions
 
 **Signature:**
 

package/generated-docs/core/istrackreference.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# isTrackReference (undefined)
+# isTrackReference
 
 **Signature:**
 

package/generated-docs/core/istrackreferencepinned.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# isTrackReferencePinned (undefined)
+# isTrackReferencePinned
 
 Check if the `TrackReference` is pinned.
 
@@ -13,4 +13,4 @@ export declare function isTrackReferencePinned(
 ): boolean;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/istrackreferenceplaceholder.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# isTrackReferencePlaceholder (undefined)
+# isTrackReferencePlaceholder
 
 **Signature:**
 

package/generated-docs/core/mutedobserver.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# mutedObserver (undefined)
+# mutedObserver
 
 **Signature:**
 

package/generated-docs/core/observeparticipantevents.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# observeParticipantEvents (undefined)
+# observeParticipantEvents
 
 **Signature:**
 

package/generated-docs/core/observeparticipantmedia.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# observeParticipantMedia (undefined)
+# observeParticipantMedia
 
 **Signature:**
 

package/generated-docs/core/observeroomevents.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# observeRoomEvents (undefined)
+# observeRoomEvents
 
 **Signature:**
 

package/generated-docs/core/observetrackevents.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# observeTrackEvents (undefined)
+# observeTrackEvents
 
 **Signature:**
 

package/generated-docs/core/participanteventselector.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# participantEventSelector (undefined)
+# participantEventSelector
 
 **Signature:**
 

package/generated-docs/core/participantinfoobserver.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# participantInfoObserver (undefined)
+# participantInfoObserver
 
 **Signature:**
 

package/generated-docs/core/participantpermissionobserver.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# participantPermissionObserver (undefined)
+# participantPermissionObserver
 
 **Signature:**
 
@@ -8,6 +8,6 @@
 export declare function participantPermissionObserver(
   participant: Participant,
 ): Observable<
-  import('livekit-client/dist/src/proto/livekit_models').ParticipantPermission | undefined
+  import('livekit-client/dist/src/proto/livekit_models_pb').ParticipantPermission | undefined
 >;
 ```

package/generated-docs/core/roomaudioplaybackallowedobservable.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# roomAudioPlaybackAllowedObservable (undefined)
+# roomAudioPlaybackAllowedObservable
 
 **Signature:**
 

package/generated-docs/core/roomeventselector.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# roomEventSelector (undefined)
+# roomEventSelector
 
 **Signature:**
 

package/generated-docs/core/roominfoobserver.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# roomInfoObserver (undefined)
+# roomInfoObserver
 
 **Signature:**
 

package/generated-docs/core/roomobserver.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# roomObserver (undefined)
+# roomObserver
 
 **Signature:**
 

package/generated-docs/core/screenshareobserver.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# screenShareObserver (undefined)
+# screenShareObserver
 
 **Signature:**
 

package/generated-docs/core/selectgridlayout.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# selectGridLayout (undefined)
+# selectGridLayout
 
 **Signature:**
 

package/generated-docs/core/sendmessage.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# sendMessage (undefined)
+# sendMessage
 
 Publish data from the LocalParticipant.
 
@@ -15,4 +15,4 @@ export declare function sendMessage(
 ): Promise<void>;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/setdifference.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# setDifference (undefined)
+# setDifference
 
 **Signature:**
 

package/generated-docs/core/setloglevel.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# setLogLevel (undefined)
+# setLogLevel
 
 Set the log level for both the `@livekit/components-react` package and the `@livekit-client` package. To set the `@livekit-client` log independently, use the `liveKitClientLogLevel` prop on the `options` object.
 
@@ -10,4 +10,4 @@ Set the log level for both the `@livekit/components-react` package and the `@liv
 export declare function setLogLevel(level: LogLevel, options?: SetLogLevelOptions): void;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/setupchat.md

@@ -1,11 +1,17 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# setupChat (undefined)
+# setupChat
 
 **Signature:**
 
 ```typescript
-export declare function setupChat(room: Room): {
+export declare function setupChat(
+  room: Room,
+  options?: {
+    messageEncoder?: (message: ChatMessage) => Uint8Array;
+    messageDecoder?: (message: Uint8Array) => ReceivedChatMessage;
+  },
+): {
   messageObservable: import('rxjs').Observable<ReceivedChatMessage[]>;
   isSendingObservable: BehaviorSubject<boolean>;
   send: (message: string) => Promise<void>;

package/generated-docs/core/setupchattoggle.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# setupChatToggle (undefined)
+# setupChatToggle
 
 **Signature:**
 

package/generated-docs/core/setupclearpinbutton.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# setupClearPinButton (undefined)
+# setupClearPinButton
 
 **Signature:**
 

package/generated-docs/core/setupconnectionqualityindicator.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# setupConnectionQualityIndicator (undefined)
+# setupConnectionQualityIndicator
 
 **Signature:**
 

package/generated-docs/core/setupdatamessagehandler.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# setupDataMessageHandler (undefined)
+# setupDataMessageHandler
 
 **Signature:**
 

package/generated-docs/core/setupdeviceselector.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# setupDeviceSelector (undefined)
+# setupDeviceSelector
 
 **Signature:**
 

package/generated-docs/core/setupdisconnectbutton.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# setupDisconnectButton (undefined)
+# setupDisconnectButton
 
 **Signature:**
 

package/generated-docs/core/setupfocustoggle.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# setupFocusToggle (undefined)
+# setupFocusToggle
 
 **Signature:**
 

package/generated-docs/core/setuplivekitroom.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# setupLiveKitRoom (undefined)
+# setupLiveKitRoom
 
 **Signature:**
 

package/generated-docs/core/setupmanualtoggle.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# setupManualToggle (undefined)
+# setupManualToggle
 
 **Signature:**
 

package/generated-docs/core/setupmediatoggle.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# setupMediaToggle (undefined)
+# setupMediaToggle
 
 **Signature:**
 

package/generated-docs/core/setupmediatrack.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# setupMediaTrack (undefined)
+# setupMediaTrack
 
 **Signature:**
 

package/generated-docs/core/setupparticipantname.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# setupParticipantName (undefined)
+# setupParticipantName
 
 **Signature:**
 

package/generated-docs/core/setupparticipanttile.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# setupParticipantTile (undefined)
+# setupParticipantTile
 
 **Signature:**
 

package/generated-docs/core/setupstartaudio.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# setupStartAudio (undefined)
+# setupStartAudio
 
 **Signature:**
 

package/generated-docs/core/setuptrackmutedindicator.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# setupTrackMutedIndicator (undefined)
+# setupTrackMutedIndicator
 
 **Signature:**
 

package/generated-docs/core/sortparticipants.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# sortParticipants (undefined)
+# 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
 
@@ -10,4 +10,4 @@ Default sort for participants, it'll order participants by: 1. local participant
 export declare function sortParticipants(participants: Participant[]): Participant[];
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/sorttrackreferences.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# sortTrackReferences (undefined)
+# 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
 
@@ -12,4 +12,4 @@ export declare function sortTrackReferences(
 ): TrackReferenceOrPlaceholder[];
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/core/supportsscreensharing.md

@@ -1,6 +1,6 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# supportsScreenSharing (undefined)
+# supportsScreenSharing
 
 Returns `true` if the browser supports screen sharing.
 
@@ -10,4 +10,4 @@ Returns `true` if the browser supports screen sharing.
 export declare function supportsScreenSharing(): boolean;
 ```
 
-{% partial file="p_usage.md" /%}
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}