@livekit/components-js-docs 0.0.5 → 0.1.1

package/generated-docs/core/index.md

@@ -1,116 +1,124 @@
+---
+{ "title": "components-core package" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## components-core package
+# components-core package
 
 ## Others
 
-| Other                                                                                           | Description                                                                                                                                                                                                                                                                                                                                                                                                 |
-| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| [activeSpeakerObserver(room)](./core/activespeakerobserver.md)                                  |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [allParticipantEvents](./core/allparticipantevents.md)                                          |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [allParticipantRoomEvents](./core/allparticipantroomevents.md)                                  |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [allRemoteParticipantEvents](./core/allremoteparticipantevents.md)                              |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [allRemoteParticipantRoomEvents](./core/allremoteparticipantroomevents.md)                      |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [attachIfSubscribed](./core/attachifsubscribed.md)                                              |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [AudioSource](./core/audiosource.md)                                                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [BaseDataMessage](./core/basedatamessage.md)                                                    |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [CaptureOptionsBySource](./core/captureoptionsbysource.md)                                      |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [ChatMessage](./core/chatmessage.md)                                                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [computeMenuPosition(button, menu)](./core/computemenuposition.md)                              |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [connectedParticipantObserver(room, identity, options)](./core/connectedparticipantobserver.md) |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [ConnectedParticipantObserverOptions](./core/connectedparticipantobserveroptions.md)            |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [connectedParticipantsObserver(room, options)](./core/connectedparticipantsobserver.md)         |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [connectionStateObserver(room)](./core/connectionstateobserver.md)                              |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [createActiveDeviceObservable(room, kind)](./core/createactivedeviceobservable.md)              |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [createConnectionQualityObserver(participant)](./core/createconnectionqualityobserver.md)       |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [createDataObserver(room)](./core/createdataobserver.md)                                        |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [createDefaultGrammar](./core/createdefaultgrammar.md)                                          |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [createIsSpeakingObserver(participant)](./core/createisspeakingobserver.md)                     |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [createMediaDeviceObserver(kind, requestPermissions)](./core/createmediadeviceobserver.md)      |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [createTrackObserver(participant, options)](./core/createtrackobserver.md)                      |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [createUrlRegExp](./core/createurlregexp.md)                                                    |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [cssPrefix](./core/cssprefix.md)                                                                |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [DataSendOptions](./core/datasendoptions.md)                                                    |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [DataTopic](./core/datatopic.md)                                                                |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [encryptionStatusObservable(room, participant)](./core/encryptionstatusobservable.md)           |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [getTrackByIdentifier(options)](./core/gettrackbyidentifier.md)                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [getTrackReferenceId(trackReference)](./core/gettrackreferenceid.md)                            | Returns a id to identify the <code>TrackReference</code> based on participant and source.                                                                                                                                                                                                                                                                                                                   |
-| [getTrackReferenceSource(trackReference)](./core/gettrackreferencesource.md)                    | Returns the Source of the TrackReference.                                                                                                                                                                                                                                                                                                                                                                   |
-| [GRID_LAYOUTS](./core/grid_layouts.md)                                                          |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [GridLayoutDefinition](./core/gridlayoutdefinition.md)                                          |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [isEqualTrackRef(a, b)](./core/isequaltrackref.md)                                              |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [isLocal(p)](./core/islocal.md)                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [isMobileBrowser()](./core/ismobilebrowser.md)                                                  | Mobile browser detection based on <code>navigator.userAgent</code> string. Defaults to returning <code>false</code> if not in a browser.                                                                                                                                                                                                                                                                    |
-| [isParticipantSourcePinned(participant, source, pinState)](./core/isparticipantsourcepinned.md) | Check if the participant track source is pinned.                                                                                                                                                                                                                                                                                                                                                            |
-| [isRemote(p)](./core/isremote.md)                                                               |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [isSourcesWithOptions(sources)](./core/issourceswithoptions.md)                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [isSourceWitOptions(source)](./core/issourcewitoptions.md)                                      |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [isTrackReference(trackReference)](./core/istrackreference.md)                                  |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [isTrackReferencePinned(trackReference, pinState)](./core/istrackreferencepinned.md)            | Check if the <code>TrackReference</code> is pinned.                                                                                                                                                                                                                                                                                                                                                         |
-| [isTrackReferencePlaceholder(trackReference)](./core/istrackreferenceplaceholder.md)            |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [log](./core/log.md)                                                                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [MediaToggleType](./core/mediatoggletype.md)                                                    |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [mutedObserver(participant, source)](./core/mutedobserver.md)                                   |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [observeParticipantEvents(participant, events)](./core/observeparticipantevents.md)             |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [observeParticipantMedia(participant)](./core/observeparticipantmedia.md)                       |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [observeRoomEvents(room, events)](./core/observeroomevents.md)                                  |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [observeTrackEvents(track, events)](./core/observetrackevents.md)                               |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [ParticipantClickEvent](./core/participantclickevent.md)                                        |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [participantEventSelector(participant, event)](./core/participanteventselector.md)              |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [ParticipantFilter](./core/participantfilter.md)                                                |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [participantInfoObserver(participant)](./core/participantinfoobserver.md)                       |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [ParticipantMedia](./core/participantmedia.md)                                                  |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [participantPermissionObserver(participant)](./core/participantpermissionobserver.md)           |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [PIN_DEFAULT_STATE](./core/pin_default_state.md)                                                |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [PinState](./core/pinstate.md)                                                                  |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [ReceivedChatMessage](./core/receivedchatmessage.md)                                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [ReceivedDataMessage](./core/receiveddatamessage.md)                                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [RequireOnlyOne](./core/requireonlyone.md)                                                      |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [roomAudioPlaybackAllowedObservable(room)](./core/roomaudioplaybackallowedobservable.md)        |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [roomEventSelector(room, event)](./core/roomeventselector.md)                                   |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [roomInfoObserver(room)](./core/roominfoobserver.md)                                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [roomObserver(room)](./core/roomobserver.md)                                                    |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [screenShareObserver(room)](./core/screenshareobserver.md)                                      |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [ScreenShareTrackMap](./core/screensharetrackmap.md)                                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [selectGridLayout(layouts, participantCount, width, height)](./core/selectgridlayout.md)        |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [sendMessage(localParticipant, payload, topic, options)](./core/sendmessage.md)                 | Publish data from the LocalParticipant.                                                                                                                                                                                                                                                                                                                                                                     |
-| [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, options)](./core/setupchat.md)                                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [setupChatToggle()](./core/setupchattoggle.md)                                                  |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [setupClearPinButton()](./core/setupclearpinbutton.md)                                          |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [setupConnectionQualityIndicator(participant)](./core/setupconnectionqualityindicator.md)       |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [setupDataMessageHandler(room, topic, onMessage)](./core/setupdatamessagehandler.md)            |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [setupDeviceSelector(kind, room, localTrack)](./core/setupdeviceselector.md)                    |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [setupDisconnectButton(room)](./core/setupdisconnectbutton.md)                                  |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [setupFocusToggle()](./core/setupfocustoggle.md)                                                |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [setupLiveKitRoom()](./core/setuplivekitroom.md)                                                |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [setupManualToggle()](./core/setupmanualtoggle.md)                                              |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [setupMediaToggle(source, room, options)](./core/setupmediatoggle.md)                           |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [setupMediaTrack(trackIdentifier)](./core/setupmediatrack.md)                                   |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [setupParticipantName(participant)](./core/setupparticipantname.md)                             |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [setupParticipantTile()](./core/setupparticipanttile.md)                                        |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [setupStartAudio()](./core/setupstartaudio.md)                                                  |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [setupTrackMutedIndicator(participant, source)](./core/setuptrackmutedindicator.md)             |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [sortParticipants(participants)](./core/sortparticipants.md)                                    | 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                                                                                                                                                                         |
-| [sortTrackReferences(tracks)](./core/sorttrackreferences.md)                                    | Default sort for <code>TrackReferenceOrPlaceholder</code>, 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 |
-| [SourcesArray](./core/sourcesarray.md)                                                          |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [supportsScreenSharing()](./core/supportsscreensharing.md)                                      | Returns <code>true</code> if the browser supports screen sharing.                                                                                                                                                                                                                                                                                                                                           |
-| [ToggleSource](./core/togglesource.md)                                                          |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [tokenize(input, grammar)](./core/tokenize.md)                                                  |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [TokenizeGrammar](./core/tokenizegrammar.md)                                                    |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [TrackIdentifier](./core/trackidentifier.md)                                                    | The TrackIdentifier type is used to select Tracks either based on - Track.Source and/or name of the track, e.g. <code>{source: Track.Source.Camera}</code> or <code>{name: &quot;my-track&quot;}</code> - TrackReference (participant and publication)                                                                                                                                                      |
-| [trackObservable(track)](./core/trackobservable.md)                                             |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [TrackReference](./core/trackreference.md)                                                      |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [TrackReferenceFilter](./core/trackreferencefilter.md)                                          |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [TrackReferencePlaceholder](./core/trackreferenceplaceholder.md)                                |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [trackReferencesObservable(room, sources, options)](./core/trackreferencesobservable.md)        |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [TrackSource](./core/tracksource.md)                                                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [TrackSourceWithOptions](./core/tracksourcewithoptions.md)                                      |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [updatePages(currentList, nextList, maxItemsOnPage)](./core/updatepages.md)                     | Divide the list of elements into pages and and check if pages need updating.                                                                                                                                                                                                                                                                                                                                |
-| [VideoSource](./core/videosource.md)                                                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [wasClickOutside(insideElement, event)](./core/wasclickoutside.md)                              |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [WIDGET_DEFAULT_STATE](./core/widget_default_state.md)                                          |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [WidgetState](./core/widgetstate.md)                                                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| Other                                                                                                | Description                                                                                                                                                                                                                                                                                                                                                                                                 |
+| ---------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [activeSpeakerObserver(room)](./core/activespeakerobserver.md)                                       |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [allParticipantEvents](./core/allparticipantevents.md)                                               |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [allParticipantRoomEvents](./core/allparticipantroomevents.md)                                       |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [allRemoteParticipantEvents](./core/allremoteparticipantevents.md)                                   |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [allRemoteParticipantRoomEvents](./core/allremoteparticipantroomevents.md)                           |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [attachIfSubscribed](./core/attachifsubscribed.md)                                                   |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [AudioSource](./core/audiosource.md)                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [BaseDataMessage](./core/basedatamessage.md)                                                         |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [CaptureOptionsBySource](./core/captureoptionsbysource.md)                                           |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [ChatMessage](./core/chatmessage.md)                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [computeMenuPosition(button, menu)](./core/computemenuposition.md)                                   |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [connectedParticipantObserver(room, identity, options)](./core/connectedparticipantobserver.md)      |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [ConnectedParticipantObserverOptions](./core/connectedparticipantobserveroptions.md)                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [connectedParticipantsObserver(room, options)](./core/connectedparticipantsobserver.md)              |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [connectionStateObserver(room)](./core/connectionstateobserver.md)                                   |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [createActiveDeviceObservable(room, kind)](./core/createactivedeviceobservable.md)                   |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [createConnectionQualityObserver(participant)](./core/createconnectionqualityobserver.md)            |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [createDataObserver(room)](./core/createdataobserver.md)                                             |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [createDefaultGrammar](./core/createdefaultgrammar.md)                                               |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [createIsSpeakingObserver(participant)](./core/createisspeakingobserver.md)                          |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [createMediaDeviceObserver(kind, requestPermissions)](./core/createmediadeviceobserver.md)           |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [createTrackObserver(participant, options)](./core/createtrackobserver.md)                           |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [createUrlRegExp](./core/createurlregexp.md)                                                         |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [cssPrefix](./core/cssprefix.md)                                                                     |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [DataSendOptions](./core/datasendoptions.md)                                                         |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [DataTopic](./core/datatopic.md)                                                                     |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [encryptionStatusObservable(room, participant)](./core/encryptionstatusobservable.md)                |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [getTrackByIdentifier(options)](./core/gettrackbyidentifier.md)                                      |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [getTrackReferenceId(trackReference)](./core/gettrackreferenceid.md)                                 | Returns a id to identify the <code>TrackReference</code> or <code>TrackReferencePlaceholder</code> based on participant, track source and trackSid.                                                                                                                                                                                                                                                         |
+| [getTrackReferenceSource(trackReference)](./core/gettrackreferencesource.md)                         | Returns the Source of the TrackReference.                                                                                                                                                                                                                                                                                                                                                                   |
+| [GRID_LAYOUTS](./core/grid_layouts.md)                                                               |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [GridLayoutDefinition](./core/gridlayoutdefinition.md)                                               |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [isEqualTrackRef(a, b)](./core/isequaltrackref.md)                                                   |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [isLocal(p)](./core/islocal.md)                                                                      |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [isMobileBrowser()](./core/ismobilebrowser.md)                                                       | Mobile browser detection based on <code>navigator.userAgent</code> string. Defaults to returning <code>false</code> if not in a browser.                                                                                                                                                                                                                                                                    |
+| [isParticipantSourcePinned(participant, source, pinState)](./core/isparticipantsourcepinned.md)      | Check if the participant track source is pinned.                                                                                                                                                                                                                                                                                                                                                            |
+| [isParticipantTrackReferencePinned(trackRef, pinState)](./core/isparticipanttrackreferencepinned.md) | Check if the participant track reference is pinned.                                                                                                                                                                                                                                                                                                                                                         |
+| [isRemote(p)](./core/isremote.md)                                                                    |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [isSourcesWithOptions(sources)](./core/issourceswithoptions.md)                                      |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [isSourceWitOptions(source)](./core/issourcewitoptions.md)                                           |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [isTrackReference(trackReference)](./core/istrackreference.md)                                       |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [isTrackReferencePinned(trackReference, pinState)](./core/istrackreferencepinned.md)                 | Check if the <code>TrackReference</code> is pinned.                                                                                                                                                                                                                                                                                                                                                         |
+| [isTrackReferencePlaceholder(trackReference)](./core/istrackreferenceplaceholder.md)                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [log](./core/log.md)                                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [MediaToggleType](./core/mediatoggletype.md)                                                         |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [MessageDecoder](./core/messagedecoder.md)                                                           |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [MessageEncoder](./core/messageencoder.md)                                                           |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [mutedObserver(trackRef)](./core/mutedobserver.md)                                                   |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [observeParticipantEvents(participant, events)](./core/observeparticipantevents.md)                  |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [observeParticipantMedia(participant)](./core/observeparticipantmedia.md)                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [observeRoomEvents(room, events)](./core/observeroomevents.md)                                       |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [observeTrackEvents(track, events)](./core/observetrackevents.md)                                    |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [ParticipantClickEvent](./core/participantclickevent.md)                                             |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [participantEventSelector(participant, event)](./core/participanteventselector.md)                   |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [ParticipantFilter](./core/participantfilter.md)                                                     |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [participantInfoObserver(participant)](./core/participantinfoobserver.md)                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [ParticipantMedia](./core/participantmedia.md)                                                       |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [participantPermissionObserver(participant)](./core/participantpermissionobserver.md)                |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [PIN_DEFAULT_STATE](./core/pin_default_state.md)                                                     |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [PinState](./core/pinstate.md)                                                                       |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [ReceivedChatMessage](./core/receivedchatmessage.md)                                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [ReceivedDataMessage](./core/receiveddatamessage.md)                                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [RequireOnlyOne](./core/requireonlyone.md)                                                           |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [roomAudioPlaybackAllowedObservable(room)](./core/roomaudioplaybackallowedobservable.md)             |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [roomEventSelector(room, event)](./core/roomeventselector.md)                                        |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [roomInfoObserver(room)](./core/roominfoobserver.md)                                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [roomObserver(room)](./core/roomobserver.md)                                                         |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [screenShareObserver(room)](./core/screenshareobserver.md)                                           |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [ScreenShareTrackMap](./core/screensharetrackmap.md)                                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [selectGridLayout(layouts, participantCount, width, height)](./core/selectgridlayout.md)             |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [sendMessage(localParticipant, payload, topic, options)](./core/sendmessage.md)                      | Publish data from the LocalParticipant.                                                                                                                                                                                                                                                                                                                                                                     |
+| [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, options)](./core/setupchat.md)                                                      |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [setupChatToggle()](./core/setupchattoggle.md)                                                       |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [setupClearPinButton()](./core/setupclearpinbutton.md)                                               |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [setupConnectionQualityIndicator(participant)](./core/setupconnectionqualityindicator.md)            |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [setupDataMessageHandler(room, topic, onMessage)](./core/setupdatamessagehandler.md)                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [setupDeviceSelector(kind, room, localTrack)](./core/setupdeviceselector.md)                         |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [setupDisconnectButton(room)](./core/setupdisconnectbutton.md)                                       |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [setupFocusToggle()](./core/setupfocustoggle.md)                                                     |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [setupLiveKitRoom()](./core/setuplivekitroom.md)                                                     |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [setupManualToggle()](./core/setupmanualtoggle.md)                                                   |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [setupMediaToggle(source, room, options)](./core/setupmediatoggle.md)                                |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [setupMediaTrack(trackIdentifier)](./core/setupmediatrack.md)                                        |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [setupParticipantName(participant)](./core/setupparticipantname.md)                                  |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [setupParticipantTile()](./core/setupparticipanttile.md)                                             |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [setupStartAudio()](./core/setupstartaudio.md)                                                       |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [setupTrackMutedIndicator(trackRef)](./core/setuptrackmutedindicator.md)                             |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [sortParticipants(participants)](./core/sortparticipants.md)                                         | 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                                                                                                                                                                         |
+| [sortTrackReferences(tracks)](./core/sorttrackreferences.md)                                         | Default sort for <code>TrackReferenceOrPlaceholder</code>, 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 |
+| [SourcesArray](./core/sourcesarray.md)                                                               |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [supportsScreenSharing()](./core/supportsscreensharing.md)                                           | Returns <code>true</code> if the browser supports screen sharing.                                                                                                                                                                                                                                                                                                                                           |
+| [ToggleSource](./core/togglesource.md)                                                               |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [tokenize(input, grammar)](./core/tokenize.md)                                                       |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [TokenizeGrammar](./core/tokenizegrammar.md)                                                         |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [TrackIdentifier](./core/trackidentifier.md)                                                         | The TrackIdentifier type is used to select Tracks either based on - Track.Source and/or name of the track, e.g. <code>{source: Track.Source.Camera}</code> or <code>{name: &quot;my-track&quot;}</code> - TrackReference (participant and publication)                                                                                                                                                      |
+| [trackObservable(track)](./core/trackobservable.md)                                                  |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [TrackReference](./core/trackreference.md)                                                           |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [TrackReferenceFilter](./core/trackreferencefilter.md)                                               |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [TrackReferenceId](./core/trackreferenceid.md)                                                       |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [TrackReferencePlaceholder](./core/trackreferenceplaceholder.md)                                     |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [trackReferencesObservable(room, sources, options)](./core/trackreferencesobservable.md)             |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [TrackSource](./core/tracksource.md)                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [TrackSourceWithOptions](./core/tracksourcewithoptions.md)                                           |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [updatePages(currentList, nextList, maxItemsOnPage)](./core/updatepages.md)                          | Divide the list of elements into pages and and check if pages need updating.                                                                                                                                                                                                                                                                                                                                |
+| [VideoSource](./core/videosource.md)                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [wasClickOutside(insideElement, event)](./core/wasclickoutside.md)                                   |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [WIDGET_DEFAULT_STATE](./core/widget_default_state.md)                                               |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [WidgetState](./core/widgetstate.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,7 +1,22 @@
+---
+{
+  "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
 
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+Use [isParticipantTrackReferencePinned()](./core/isparticipanttrackreferencepinned.md) instead.
+
+{% /callout %}
+
 Check if the participant track source is pinned.
 
 **Signature:**
@@ -10,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

@@ -0,0 +1,23 @@
+---
+{
+  "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
+
+Check if the participant track reference is pinned.
+
+**Signature:**
+
+```typescript
+export declare function isParticipantTrackReferencePinned(
+  trackRef: TrackReference,
+  pinState: PinState | undefined
+): boolean;
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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