npm - @livekit/components-js-docs - Versions diffs - 0.0.0-20251021151641 - Mend

@livekit/components-js-docs 0.0.0-20251021151641

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (502) hide show

package/generated-docs/core/index.md ADDED Viewed

@@ -0,0 +1,151 @@
+---
+{ "title": "components-core package" }
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+# components-core package
+## Others
+| Other                                                                                                           | Description                                                                                                                                                                                                                                                                                                                                                                                                 |
+| --------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [activeSpeakerObserver(room)](./core/activespeakerobserver.md)                                                  |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [addMediaTimestampToTranscription(segment, timestamps)](./core/addmediatimestamptotranscription.md)             |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [allParticipantEvents](./core/allparticipantevents.md)                                                          |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [allParticipantRoomEvents](./core/allparticipantroomevents.md)                                                  |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [allRemoteParticipantEvents](./core/allremoteparticipantevents.md)                                              |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [allRemoteParticipantRoomEvents](./core/allremoteparticipantroomevents.md)                                      |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [attachIfSubscribed(publication, element)](./core/attachifsubscribed.md)                                        |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [AudioSource](./core/audiosource.md)                                                                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [BaseDataMessage](./core/basedatamessage.md)                                                                    |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [CaptureOptionsBySource](./core/captureoptionsbysource.md)                                                      |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [ChatOptions](./core/chatoptions.md)                                                                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [computeMenuPosition(button, menu, onUpdate)](./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)                              |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [createChatObserver(room)](./core/createchatobserver.md)                                                        |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [createConnectionQualityObserver(participant)](./core/createconnectionqualityobserver.md)                       |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [createDataObserver(room)](./core/createdataobserver.md)                                                        |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [createDefaultGrammar()](./core/createdefaultgrammar.md)                                                        |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [createEmailRegExp({ exact })](./core/createemailregexp.md)                                                     |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [createIsSpeakingObserver(participant)](./core/createisspeakingobserver.md)                                     |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [createMediaDeviceObserver(kind, onError, requestPermissions)](./core/createmediadeviceobserver.md)             |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [createTrackObserver(participant, options)](./core/createtrackobserver.md)                                      |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [createUrlRegExp(options)](./core/createurlregexp.md)                                                           |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [cssPrefix](./core/cssprefix.md)                                                                                |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [DataTopic](./core/datatopic.md)                                                                                |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [dedupeSegments(prevSegments, newSegments, windowSize)](./core/dedupesegments.md)                               |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [defaultUserChoices](./core/defaultuserchoices.md)                                                              |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [didActiveSegmentsChange(prevActive, newActive)](./core/didactivesegmentschange.md)                             |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [encryptionStatusObservable(room, participant)](./core/encryptionstatusobservable.md)                           |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [getActiveTranscriptionSegments(segments, syncTimes, maxAge)](./core/getactivetranscriptionsegments.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)                                                          |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [GridLayoutInfo](./core/gridlayoutinfo.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.                                                                                                                                                                                                                                                                    |
+| [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)                                                      |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [isTrackReferencePinned(trackReference, pinState)](./core/istrackreferencepinned.md)                            | Check if the <code>TrackReference</code> is pinned.                                                                                                                                                                                                                                                                                                                                                         |
+| [isTrackReferencePlaceholder(trackReference)](./core/istrackreferenceplaceholder.md)                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [LegacyChatMessage](./core/legacychatmessage.md)                                                                |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [LegacyDataTopic](./core/legacydatatopic.md)                                                                    |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [LegacyReceivedChatMessage](./core/legacyreceivedchatmessage.md)                                                |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [loadUserChoices(defaults, preventLoad)](./core/loaduserchoices.md)                                             | Reads the user choices from local storage, or returns the default settings if none are found.                                                                                                                                                                                                                                                                                                               |
+| [LocalUserChoices](./core/localuserchoices.md)                                                                  | Represents the user's choices for video and audio input devices, as well as their username.                                                                                                                                                                                                                                                                                                                 |
+| [log](./core/log.md)                                                                                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [MediaToggleType](./core/mediatoggletype.md)                                                                    |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [MessageDecoder](./core/messagedecoder.md)                                                                      |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [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)                                               |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [participantAttributesObserver(participant)](./core/participantattributesobserver.md)                           |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [participantAttributesObserver(participant)](./core/participantattributesobserver_1.md)                         |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [participantByIdentifierObserver(room, { kind, identity }, options)](./core/participantbyidentifierobserver.md) |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [participantEventSelector(participant, event)](./core/participanteventselector.md)                              |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [ParticipantFilter](./core/participantfilter.md)                                                                |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [ParticipantIdentifier](./core/participantidentifier.md)                                                        | **_(BETA)_**                                                                                                                                                                                                                                                                                                                                                                                                |
+| [participantInfoObserver(participant)](./core/participantinfoobserver.md)                                       |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [ParticipantMedia](./core/participantmedia.md)                                                                  |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [participantPermissionObserver(participant)](./core/participantpermissionobserver.md)                           |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [participantTrackEvents](./core/participanttrackevents.md)                                                      |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [ParticipantTrackIdentifier](./core/participanttrackidentifier.md)                                              |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [participantTracksObservable(participant, trackIdentifier)](./core/participanttracksobservable.md)              |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [PIN_DEFAULT_STATE](./core/pin_default_state.md)                                                                |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [PinState](./core/pinstate.md)                                                                                  |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [ReceivedChatMessage](./core/receivedchatmessage.md)                                                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [ReceivedDataMessage](./core/receiveddatamessage.md)                                                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [ReceivedTranscriptionSegment](./core/receivedtranscriptionsegment.md)                                          |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [recordingStatusObservable(room)](./core/recordingstatusobservable.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)                                                                    |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [roomVideoPlaybackAllowedObservable(room)](./core/roomvideoplaybackallowedobservable.md)                        |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [saveUserChoices(userChoices, preventSave)](./core/saveuserchoices.md)                                          | Saves user choices to local storage.                                                                                                                                                                                                                                                                                                                                                                        |
+| [screenShareObserver(room)](./core/screenshareobserver.md)                                                      |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [ScreenShareTrackMap](./core/screensharetrackmap.md)                                                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [selectGridLayout(layoutDefinitions, participantCount, width, height)](./core/selectgridlayout.md)              |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [sendMessage(localParticipant, payload, options)](./core/sendmessage.md)                                        | Publish data from the LocalParticipant.                                                                                                                                                                                                                                                                                                                                                                     |
+| [setDifference(setA, setB)](./core/setdifference.md)                                                            |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [setLogExtension(extension, options)](./core/setlogextension.md)                                                | Set the log extension for both the <code>@livekit/components-react</code> package and the <code>@livekit-client</code> package. To set the <code>@livekit-client</code> log extension, use the <code>liveKitClientLogExtension</code> prop on the <code>options</code> object.                                                                                                                              |
+| [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)                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [setupChatMessageHandler(room)](./core/setupchatmessagehandler.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, publishOptions, onError)](./core/setupmediatoggle.md)                  |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [setupMediaTrack(trackIdentifier)](./core/setupmediatrack.md)                                                   |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [setupParticipantName(participant)](./core/setupparticipantname.md)                                             |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [setupParticipantTile()](./core/setupparticipanttile.md)                                                        |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [setupStartAudio()](./core/setupstartaudio.md)                                                                  |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [setupStartVideo()](./core/setupstartvideo.md)                                                                  |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [setupTextStream(room, topic)](./core/setuptextstream.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.                                                                                                                                                                                                                                                                                                                                           |
+| [TextStreamData](./core/textstreamdata.md)                                                                      |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [ToggleSource](./core/togglesource.md)                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [tokenize(input, grammar)](./core/tokenize.md)                                                                  |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [TokenizeGrammar](./core/tokenizegrammar.md)                                                                    |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [trackEventSelector(publication, event)](./core/trackeventselector.md)                                          |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [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)                                                      |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [trackSyncTimeObserver(track)](./core/tracksynctimeobserver.md)                                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [trackTranscriptionObserver(publication)](./core/tracktranscriptionobserver.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 ADDED Viewed

@@ -0,0 +1,19 @@
+---
+{
+  "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
+**Signature:**
+```typescript
+export declare function isEqualTrackRef(
+  a?: TrackReferenceOrPlaceholder,
+  b?: TrackReferenceOrPlaceholder
+): boolean;
+```

package/generated-docs/core/islocal.md ADDED Viewed

@@ -0,0 +1,16 @@
+---
+{
+  "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
+**Signature:**
+```typescript
+export declare function isLocal(p: Participant): boolean;
+```

package/generated-docs/core/ismobilebrowser.md ADDED Viewed

@@ -0,0 +1,22 @@
+---
+{
+  "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
+Mobile browser detection based on `navigator.userAgent` string. Defaults to returning `false` if not in a browser.
+**Signature:**
+```typescript
+export declare function isMobileBrowser(): boolean;
+```
+## Remarks
+This should only be used if feature detection or other methods do not work!

package/generated-docs/core/isparticipanttrackreferencepinned.md ADDED Viewed

@@ -0,0 +1,21 @@
+---
+{
+  "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;
+```

package/generated-docs/core/isremote.md ADDED Viewed

@@ -0,0 +1,16 @@
+---
+{
+  "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
+**Signature:**
+```typescript
+export declare function isRemote(p: Participant): boolean;
+```

package/generated-docs/core/issourceswithoptions.md ADDED Viewed

@@ -0,0 +1,18 @@
+---
+{
+  "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
+**Signature:**
+```typescript
+export declare function isSourcesWithOptions(
+  sources: SourcesArray
+): sources is TrackSourceWithOptions[];
+```

package/generated-docs/core/issourcewitoptions.md ADDED Viewed

@@ -0,0 +1,18 @@
+---
+{
+  "title": "isSourceWitOptions",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/types.ts"
+}
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+# isSourceWitOptions
+**Signature:**
+```typescript
+export declare function isSourceWitOptions(
+  source: SourcesArray[number]
+): source is TrackSourceWithOptions;
+```

package/generated-docs/core/istrackreferencepinned.md ADDED Viewed

@@ -0,0 +1,21 @@
+---
+{
+  "title": "isTrackReferencePinned",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/track-reference/track-reference.utils.ts"
+}
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+# isTrackReferencePinned
+Check if the `TrackReference` is pinned.
+**Signature:**
+```typescript
+export declare function isTrackReferencePinned(
+  trackReference: TrackReferenceOrPlaceholder,
+  pinState: PinState | undefined
+): boolean;
+```

package/generated-docs/core/istrackreferenceplaceholder.md ADDED Viewed

@@ -0,0 +1,18 @@
+---
+{
+  "title": "isTrackReferencePlaceholder",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/track-reference/track-reference.types.ts"
+}
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+# isTrackReferencePlaceholder
+**Signature:**
+```typescript
+export declare function isTrackReferencePlaceholder(
+  trackReference?: TrackReferenceOrPlaceholder
+): trackReference is TrackReferencePlaceholder;
+```

package/generated-docs/core/legacychatmessage.ignorelegacy.md ADDED Viewed

@@ -0,0 +1,13 @@
+---
+{ "title": "LegacyChatMessage.ignoreLegacy property" }
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+# LegacyChatMessage.ignoreLegacy property
+**Signature:**
+```typescript
+ignoreLegacy?: boolean;
+```

package/generated-docs/core/legacychatmessage.md ADDED Viewed

@@ -0,0 +1,24 @@
+---
+{
+  "title": "LegacyChatMessage interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/chat.ts"
+}
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+# LegacyChatMessage interface
+**Signature:**
+```typescript
+export interface LegacyChatMessage extends ChatMessage
+```
+**Extends:** ChatMessage
+## Properties
+| Property                                                  | Type    | Description  |
+| --------------------------------------------------------- | ------- | ------------ |
+| [ignoreLegacy?](./core/legacychatmessage.ignorelegacy.md) | boolean | _(Optional)_ |

package/generated-docs/core/legacydatatopic.md ADDED Viewed

@@ -0,0 +1,22 @@
+---
+{
+  "title": "LegacyDataTopic",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/dataChannel.ts"
+}
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+# LegacyDataTopic
+{% callout type="caution" variation="normal" %}
+{% /callout %}
+**Signature:**
+```typescript
+LegacyDataTopic: {
+    readonly CHAT: "lk-chat-topic";
+}
+```

package/generated-docs/core/legacyreceivedchatmessage.ignorelegacy.md ADDED Viewed

@@ -0,0 +1,13 @@
+---
+{ "title": "LegacyReceivedChatMessage.ignoreLegacy property" }
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+# LegacyReceivedChatMessage.ignoreLegacy property
+**Signature:**
+```typescript
+ignoreLegacy?: boolean;
+```

package/generated-docs/core/legacyreceivedchatmessage.md ADDED Viewed

@@ -0,0 +1,24 @@
+---
+{
+  "title": "LegacyReceivedChatMessage interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/components/chat.ts"
+}
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+# LegacyReceivedChatMessage interface
+**Signature:**
+```typescript
+export interface LegacyReceivedChatMessage extends ReceivedChatMessage
+```
+**Extends:** [ReceivedChatMessage](./core/receivedchatmessage.md)
+## Properties
+| Property                                                          | Type    | Description  |
+| ----------------------------------------------------------------- | ------- | ------------ |
+| [ignoreLegacy?](./core/legacyreceivedchatmessage.ignorelegacy.md) | boolean | _(Optional)_ |

package/generated-docs/core/loaduserchoices.md ADDED Viewed

@@ -0,0 +1,31 @@
+---
+{
+  "title": "loadUserChoices",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/persistent-storage/user-choices.ts"
+}
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+# loadUserChoices
+{% callout type="note" variation="normal" %}
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+{% /callout %}
+Reads the user choices from local storage, or returns the default settings if none are found.
+**Signature:**
+```typescript
+export declare function loadUserChoices(
+  defaults?: Partial<LocalUserChoices>,
+  preventLoad?: boolean
+): LocalUserChoices;
+```
+## Remarks
+The deprecated parameters `e2ee` and `sharedPassphrase` are not read from local storage and always return the value from the passed `defaults` or internal defaults.

package/generated-docs/core/localuserchoices.md ADDED Viewed

@@ -0,0 +1,24 @@
+---
+{
+  "title": "LocalUserChoices type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/persistent-storage/user-choices.ts"
+}
+---
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+# LocalUserChoices type
+Represents the user's choices for video and audio input devices, as well as their username.
+**Signature:**
+```typescript
+export type LocalUserChoices = {
+  videoEnabled: boolean;
+  audioEnabled: boolean;
+  videoDeviceId: string;
+  audioDeviceId: string;
+  username: string;
+};
+```