@livekit/components-js-docs 0.1.24 → 0.1.26

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 (12) hide show
  1. package/generated-docs/core/createemailregexp.md +16 -0
  2. package/generated-docs/core/index.md +131 -128
  3. package/generated-docs/core/participantbyidentifierobserver.md +20 -0
  4. package/generated-docs/core/participantidentifier.md +26 -0
  5. package/generated-docs/react/hook/usedatachannel.md +3 -1
  6. package/generated-docs/react/hook/usedatachannel_1.md +3 -1
  7. package/generated-docs/react/hook/useremoteparticipant.md +3 -3
  8. package/generated-docs/react/hook/useremoteparticipant_1.md +44 -0
  9. package/generated-docs/react/index.md +3 -1
  10. package/generated-docs/react/meta-data.json +1 -1
  11. package/generated-docs/react/participantidentifier.md +26 -0
  12. package/package.json +2 -2
package/generated-docs/core/createemailregexp.md ADDED
@@ -0,0 +1,16 @@
1
+ ---
2
+ {
3
+ "title": "createEmailRegExp",
4
+ "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/emailRegex.ts"
5
+ }
6
+ ---
7
+
8
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
9
+
10
+ # createEmailRegExp
11
+
12
+ **Signature:**
13
+
14
+ ```typescript
15
+ declare function createEmailRegExp({ exact }?: { exact?: boolean }): RegExp;
16
+ ```
package/generated-docs/core/index.md CHANGED
@@ -8,131 +8,134 @@
8
8
 
9
9
  ## Others
10
10
 
11
- | Other | Description |
12
- | ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | [activeSpeakerObserver(room)](./core/activespeakerobserver.md) | |
14
- | [addMediaTimestampToTranscription(segment, timestamps)](./core/addmediatimestamptotranscription.md) | |
15
- | [allParticipantEvents](./core/allparticipantevents.md) | |
16
- | [allParticipantRoomEvents](./core/allparticipantroomevents.md) | |
17
- | [allRemoteParticipantEvents](./core/allremoteparticipantevents.md) | |
18
- | [allRemoteParticipantRoomEvents](./core/allremoteparticipantroomevents.md) | |
19
- | [attachIfSubscribed(publication, element)](./core/attachifsubscribed.md) | |
20
- | [AudioSource](./core/audiosource.md) | |
21
- | [BaseDataMessage](./core/basedatamessage.md) | |
22
- | [CaptureOptionsBySource](./core/captureoptionsbysource.md) | |
23
- | [ChatMessage](./core/chatmessage.md) | |
24
- | [ChatOptions](./core/chatoptions.md) | |
25
- | [computeMenuPosition(button, menu)](./core/computemenuposition.md) | |
26
- | [connectedParticipantObserver(room, identity, options)](./core/connectedparticipantobserver.md) | |
27
- | [ConnectedParticipantObserverOptions](./core/connectedparticipantobserveroptions.md) | |
28
- | [connectedParticipantsObserver(room, options)](./core/connectedparticipantsobserver.md) | |
29
- | [connectionStateObserver(room)](./core/connectionstateobserver.md) | |
30
- | [createActiveDeviceObservable(room, kind)](./core/createactivedeviceobservable.md) | |
31
- | [createConnectionQualityObserver(participant)](./core/createconnectionqualityobserver.md) | |
32
- | [createDataObserver(room)](./core/createdataobserver.md) | |
33
- | [createDefaultGrammar()](./core/createdefaultgrammar.md) | |
34
- | [createIsSpeakingObserver(participant)](./core/createisspeakingobserver.md) | |
35
- | [createMediaDeviceObserver(kind, onError, requestPermissions)](./core/createmediadeviceobserver.md) | |
36
- | [createTrackObserver(participant, options)](./core/createtrackobserver.md) | |
37
- | [createUrlRegExp(options)](./core/createurlregexp.md) | |
38
- | [cssPrefix](./core/cssprefix.md) | |
39
- | [DataTopic](./core/datatopic.md) | |
40
- | [dedupeSegments(prevSegments, newSegments, windowSize)](./core/dedupesegments.md) | |
41
- | [defaultUserChoices](./core/defaultuserchoices.md) | |
42
- | [didActiveSegmentsChange(prevActive, newActive)](./core/didactivesegmentschange.md) | |
43
- | [encryptionStatusObservable(room, participant)](./core/encryptionstatusobservable.md) | |
44
- | [getActiveTranscriptionSegments(segments, syncTimes, maxAge)](./core/getactivetranscriptionsegments.md) | |
45
- | [getTrackByIdentifier(options)](./core/gettrackbyidentifier.md) | |
46
- | [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. |
47
- | [getTrackReferenceSource(trackReference)](./core/gettrackreferencesource.md) | Returns the Source of the TrackReference. |
48
- | [GRID_LAYOUTS](./core/grid_layouts.md) | |
49
- | [GridLayoutDefinition](./core/gridlayoutdefinition.md) | |
50
- | [isEqualTrackRef(a, b)](./core/isequaltrackref.md) | |
51
- | [isLocal(p)](./core/islocal.md) | |
52
- | [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. |
53
- | [isParticipantTrackReferencePinned(trackRef, pinState)](./core/isparticipanttrackreferencepinned.md) | Check if the participant track reference is pinned. |
54
- | [isRemote(p)](./core/isremote.md) | |
55
- | [isSourcesWithOptions(sources)](./core/issourceswithoptions.md) | |
56
- | [isSourceWitOptions(source)](./core/issourcewitoptions.md) | |
57
- | [isTrackReferencePinned(trackReference, pinState)](./core/istrackreferencepinned.md) | Check if the <code>TrackReference</code> is pinned. |
58
- | [isTrackReferencePlaceholder(trackReference)](./core/istrackreferenceplaceholder.md) | |
59
- | [loadUserChoices(defaults, preventLoad)](./core/loaduserchoices.md) | Reads the user choices from local storage, or returns the default settings if none are found. |
60
- | [LocalUserChoices](./core/localuserchoices.md) | Represents the user's choices for video and audio input devices, as well as their username. |
61
- | [log](./core/log.md) | |
62
- | [MediaToggleType](./core/mediatoggletype.md) | |
63
- | [MessageDecoder](./core/messagedecoder.md) | |
64
- | [MessageEncoder](./core/messageencoder.md) | |
65
- | [mutedObserver(trackRef)](./core/mutedobserver.md) | |
66
- | [observeParticipantEvents(participant, events)](./core/observeparticipantevents.md) | |
67
- | [observeParticipantMedia(participant)](./core/observeparticipantmedia.md) | |
68
- | [observeRoomEvents(room, events)](./core/observeroomevents.md) | |
69
- | [observeTrackEvents(track, events)](./core/observetrackevents.md) | |
70
- | [participantEventSelector(participant, event)](./core/participanteventselector.md) | |
71
- | [ParticipantFilter](./core/participantfilter.md) | |
72
- | [participantInfoObserver(participant)](./core/participantinfoobserver.md) | |
73
- | [ParticipantMedia](./core/participantmedia.md) | |
74
- | [participantPermissionObserver(participant)](./core/participantpermissionobserver.md) | |
75
- | [participantTrackEvents](./core/participanttrackevents.md) | |
76
- | [ParticipantTrackIdentifier](./core/participanttrackidentifier.md) | |
77
- | [participantTracksObservable(participant, trackIdentifier)](./core/participanttracksobservable.md) | |
78
- | [PIN_DEFAULT_STATE](./core/pin_default_state.md) | |
79
- | [PinState](./core/pinstate.md) | |
80
- | [ReceivedChatMessage](./core/receivedchatmessage.md) | |
81
- | [ReceivedDataMessage](./core/receiveddatamessage.md) | |
82
- | [ReceivedTranscriptionSegment](./core/receivedtranscriptionsegment.md) | |
83
- | [RequireOnlyOne](./core/requireonlyone.md) | |
84
- | [roomAudioPlaybackAllowedObservable(room)](./core/roomaudioplaybackallowedobservable.md) | |
85
- | [roomEventSelector(room, event)](./core/roomeventselector.md) | |
86
- | [roomInfoObserver(room)](./core/roominfoobserver.md) | |
87
- | [roomObserver(room)](./core/roomobserver.md) | |
88
- | [roomVideoPlaybackAllowedObservable(room)](./core/roomvideoplaybackallowedobservable.md) | |
89
- | [saveUserChoices(userChoices, preventSave)](./core/saveuserchoices.md) | Saves user choices to local storage. |
90
- | [screenShareObserver(room)](./core/screenshareobserver.md) | |
91
- | [ScreenShareTrackMap](./core/screensharetrackmap.md) | |
92
- | [selectGridLayout(layouts, participantCount, width, height)](./core/selectgridlayout.md) | |
93
- | [sendMessage(localParticipant, payload, options)](./core/sendmessage.md) | Publish data from the LocalParticipant. |
94
- | [setDifference(setA, setB)](./core/setdifference.md) | |
95
- | [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. |
96
- | [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. |
97
- | [SetMediaDeviceOptions](./core/setmediadeviceoptions.md) | |
98
- | [setupChat(room, options)](./core/setupchat.md) | |
99
- | [setupChatToggle()](./core/setupchattoggle.md) | |
100
- | [setupClearPinButton()](./core/setupclearpinbutton.md) | |
101
- | [setupConnectionQualityIndicator(participant)](./core/setupconnectionqualityindicator.md) | |
102
- | [setupDataMessageHandler(room, topic, onMessage)](./core/setupdatamessagehandler.md) | |
103
- | [setupDeviceSelector(kind, room, localTrack)](./core/setupdeviceselector.md) | |
104
- | [setupDisconnectButton(room)](./core/setupdisconnectbutton.md) | |
105
- | [setupFocusToggle()](./core/setupfocustoggle.md) | |
106
- | [setupLiveKitRoom()](./core/setuplivekitroom.md) | |
107
- | [setupManualToggle()](./core/setupmanualtoggle.md) | |
108
- | [setupMediaToggle(source, room, options, publishOptions, onError)](./core/setupmediatoggle.md) | |
109
- | [setupMediaTrack(trackIdentifier)](./core/setupmediatrack.md) | |
110
- | [setupParticipantName(participant)](./core/setupparticipantname.md) | |
111
- | [setupParticipantTile()](./core/setupparticipanttile.md) | |
112
- | [setupStartAudio()](./core/setupstartaudio.md) | |
113
- | [setupStartVideo()](./core/setupstartvideo.md) | |
114
- | [setupTrackMutedIndicator(trackRef)](./core/setuptrackmutedindicator.md) | |
115
- | [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 |
116
- | [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 |
117
- | [SourcesArray](./core/sourcesarray.md) | |
118
- | [supportsScreenSharing()](./core/supportsscreensharing.md) | Returns <code>true</code> if the browser supports screen sharing. |
119
- | [ToggleSource](./core/togglesource.md) | |
120
- | [tokenize(input, grammar)](./core/tokenize.md) | |
121
- | [TokenizeGrammar](./core/tokenizegrammar.md) | |
122
- | [trackEventSelector(publication, event)](./core/trackeventselector.md) | |
123
- | [trackObservable(track)](./core/trackobservable.md) | |
124
- | [TrackReference](./core/trackreference.md) | |
125
- | [TrackReferenceFilter](./core/trackreferencefilter.md) | |
126
- | [TrackReferenceId](./core/trackreferenceid.md) | |
127
- | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) | |
128
- | [TrackReferencePlaceholder](./core/trackreferenceplaceholder.md) | |
129
- | [trackReferencesObservable(room, sources, options)](./core/trackreferencesobservable.md) | |
130
- | [TrackSource](./core/tracksource.md) | |
131
- | [TrackSourceWithOptions](./core/tracksourcewithoptions.md) | |
132
- | [trackSyncTimeObserver(track)](./core/tracksynctimeobserver.md) | |
133
- | [trackTranscriptionObserver(publication)](./core/tracktranscriptionobserver.md) | |
134
- | [updatePages(currentList, nextList, maxItemsOnPage)](./core/updatepages.md) | Divide the list of elements into pages and and check if pages need updating. |
135
- | [VideoSource](./core/videosource.md) | |
136
- | [wasClickOutside(insideElement, event)](./core/wasclickoutside.md) | |
137
- | [WIDGET_DEFAULT_STATE](./core/widget_default_state.md) | |
138
- | [WidgetState](./core/widgetstate.md) | |
11
+ | Other | Description |
12
+ | --------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
+ | [activeSpeakerObserver(room)](./core/activespeakerobserver.md) | |
14
+ | [addMediaTimestampToTranscription(segment, timestamps)](./core/addmediatimestamptotranscription.md) | |
15
+ | [allParticipantEvents](./core/allparticipantevents.md) | |
16
+ | [allParticipantRoomEvents](./core/allparticipantroomevents.md) | |
17
+ | [allRemoteParticipantEvents](./core/allremoteparticipantevents.md) | |
18
+ | [allRemoteParticipantRoomEvents](./core/allremoteparticipantroomevents.md) | |
19
+ | [attachIfSubscribed(publication, element)](./core/attachifsubscribed.md) | |
20
+ | [AudioSource](./core/audiosource.md) | |
21
+ | [BaseDataMessage](./core/basedatamessage.md) | |
22
+ | [CaptureOptionsBySource](./core/captureoptionsbysource.md) | |
23
+ | [ChatMessage](./core/chatmessage.md) | |
24
+ | [ChatOptions](./core/chatoptions.md) | |
25
+ | [computeMenuPosition(button, menu)](./core/computemenuposition.md) | |
26
+ | [connectedParticipantObserver(room, identity, options)](./core/connectedparticipantobserver.md) | |
27
+ | [ConnectedParticipantObserverOptions](./core/connectedparticipantobserveroptions.md) | |
28
+ | [connectedParticipantsObserver(room, options)](./core/connectedparticipantsobserver.md) | |
29
+ | [connectionStateObserver(room)](./core/connectionstateobserver.md) | |
30
+ | [createActiveDeviceObservable(room, kind)](./core/createactivedeviceobservable.md) | |
31
+ | [createConnectionQualityObserver(participant)](./core/createconnectionqualityobserver.md) | |
32
+ | [createDataObserver(room)](./core/createdataobserver.md) | |
33
+ | [createDefaultGrammar()](./core/createdefaultgrammar.md) | |
34
+ | [createEmailRegExp({ exact })](./core/createemailregexp.md) | |
35
+ | [createIsSpeakingObserver(participant)](./core/createisspeakingobserver.md) | |
36
+ | [createMediaDeviceObserver(kind, onError, requestPermissions)](./core/createmediadeviceobserver.md) | |
37
+ | [createTrackObserver(participant, options)](./core/createtrackobserver.md) | |
38
+ | [createUrlRegExp(options)](./core/createurlregexp.md) | |
39
+ | [cssPrefix](./core/cssprefix.md) | |
40
+ | [DataTopic](./core/datatopic.md) | |
41
+ | [dedupeSegments(prevSegments, newSegments, windowSize)](./core/dedupesegments.md) | |
42
+ | [defaultUserChoices](./core/defaultuserchoices.md) | |
43
+ | [didActiveSegmentsChange(prevActive, newActive)](./core/didactivesegmentschange.md) | |
44
+ | [encryptionStatusObservable(room, participant)](./core/encryptionstatusobservable.md) | |
45
+ | [getActiveTranscriptionSegments(segments, syncTimes, maxAge)](./core/getactivetranscriptionsegments.md) | |
46
+ | [getTrackByIdentifier(options)](./core/gettrackbyidentifier.md) | |
47
+ | [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. |
48
+ | [getTrackReferenceSource(trackReference)](./core/gettrackreferencesource.md) | Returns the Source of the TrackReference. |
49
+ | [GRID_LAYOUTS](./core/grid_layouts.md) | |
50
+ | [GridLayoutDefinition](./core/gridlayoutdefinition.md) | |
51
+ | [isEqualTrackRef(a, b)](./core/isequaltrackref.md) | |
52
+ | [isLocal(p)](./core/islocal.md) | |
53
+ | [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. |
54
+ | [isParticipantTrackReferencePinned(trackRef, pinState)](./core/isparticipanttrackreferencepinned.md) | Check if the participant track reference is pinned. |
55
+ | [isRemote(p)](./core/isremote.md) | |
56
+ | [isSourcesWithOptions(sources)](./core/issourceswithoptions.md) | |
57
+ | [isSourceWitOptions(source)](./core/issourcewitoptions.md) | |
58
+ | [isTrackReferencePinned(trackReference, pinState)](./core/istrackreferencepinned.md) | Check if the <code>TrackReference</code> is pinned. |
59
+ | [isTrackReferencePlaceholder(trackReference)](./core/istrackreferenceplaceholder.md) | |
60
+ | [loadUserChoices(defaults, preventLoad)](./core/loaduserchoices.md) | Reads the user choices from local storage, or returns the default settings if none are found. |
61
+ | [LocalUserChoices](./core/localuserchoices.md) | Represents the user's choices for video and audio input devices, as well as their username. |
62
+ | [log](./core/log.md) | |
63
+ | [MediaToggleType](./core/mediatoggletype.md) | |
64
+ | [MessageDecoder](./core/messagedecoder.md) | |
65
+ | [MessageEncoder](./core/messageencoder.md) | |
66
+ | [mutedObserver(trackRef)](./core/mutedobserver.md) | |
67
+ | [observeParticipantEvents(participant, events)](./core/observeparticipantevents.md) | |
68
+ | [observeParticipantMedia(participant)](./core/observeparticipantmedia.md) | |
69
+ | [observeRoomEvents(room, events)](./core/observeroomevents.md) | |
70
+ | [observeTrackEvents(track, events)](./core/observetrackevents.md) | |
71
+ | [participantByIdentifierObserver(room, { kind, identity }, options)](./core/participantbyidentifierobserver.md) | |
72
+ | [participantEventSelector(participant, event)](./core/participanteventselector.md) | |
73
+ | [ParticipantFilter](./core/participantfilter.md) | |
74
+ | [ParticipantIdentifier](./core/participantidentifier.md) | **_(BETA)_** |
75
+ | [participantInfoObserver(participant)](./core/participantinfoobserver.md) | |
76
+ | [ParticipantMedia](./core/participantmedia.md) | |
77
+ | [participantPermissionObserver(participant)](./core/participantpermissionobserver.md) | |
78
+ | [participantTrackEvents](./core/participanttrackevents.md) | |
79
+ | [ParticipantTrackIdentifier](./core/participanttrackidentifier.md) | |
80
+ | [participantTracksObservable(participant, trackIdentifier)](./core/participanttracksobservable.md) | |
81
+ | [PIN_DEFAULT_STATE](./core/pin_default_state.md) | |
82
+ | [PinState](./core/pinstate.md) | |
83
+ | [ReceivedChatMessage](./core/receivedchatmessage.md) | |
84
+ | [ReceivedDataMessage](./core/receiveddatamessage.md) | |
85
+ | [ReceivedTranscriptionSegment](./core/receivedtranscriptionsegment.md) | |
86
+ | [RequireOnlyOne](./core/requireonlyone.md) | |
87
+ | [roomAudioPlaybackAllowedObservable(room)](./core/roomaudioplaybackallowedobservable.md) | |
88
+ | [roomEventSelector(room, event)](./core/roomeventselector.md) | |
89
+ | [roomInfoObserver(room)](./core/roominfoobserver.md) | |
90
+ | [roomObserver(room)](./core/roomobserver.md) | |
91
+ | [roomVideoPlaybackAllowedObservable(room)](./core/roomvideoplaybackallowedobservable.md) | |
92
+ | [saveUserChoices(userChoices, preventSave)](./core/saveuserchoices.md) | Saves user choices to local storage. |
93
+ | [screenShareObserver(room)](./core/screenshareobserver.md) | |
94
+ | [ScreenShareTrackMap](./core/screensharetrackmap.md) | |
95
+ | [selectGridLayout(layouts, participantCount, width, height)](./core/selectgridlayout.md) | |
96
+ | [sendMessage(localParticipant, payload, options)](./core/sendmessage.md) | Publish data from the LocalParticipant. |
97
+ | [setDifference(setA, setB)](./core/setdifference.md) | |
98
+ | [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. |
99
+ | [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. |
100
+ | [SetMediaDeviceOptions](./core/setmediadeviceoptions.md) | |
101
+ | [setupChat(room, options)](./core/setupchat.md) | |
102
+ | [setupChatToggle()](./core/setupchattoggle.md) | |
103
+ | [setupClearPinButton()](./core/setupclearpinbutton.md) | |
104
+ | [setupConnectionQualityIndicator(participant)](./core/setupconnectionqualityindicator.md) | |
105
+ | [setupDataMessageHandler(room, topic, onMessage)](./core/setupdatamessagehandler.md) | |
106
+ | [setupDeviceSelector(kind, room, localTrack)](./core/setupdeviceselector.md) | |
107
+ | [setupDisconnectButton(room)](./core/setupdisconnectbutton.md) | |
108
+ | [setupFocusToggle()](./core/setupfocustoggle.md) | |
109
+ | [setupLiveKitRoom()](./core/setuplivekitroom.md) | |
110
+ | [setupManualToggle()](./core/setupmanualtoggle.md) | |
111
+ | [setupMediaToggle(source, room, options, publishOptions, onError)](./core/setupmediatoggle.md) | |
112
+ | [setupMediaTrack(trackIdentifier)](./core/setupmediatrack.md) | |
113
+ | [setupParticipantName(participant)](./core/setupparticipantname.md) | |
114
+ | [setupParticipantTile()](./core/setupparticipanttile.md) | |
115
+ | [setupStartAudio()](./core/setupstartaudio.md) | |
116
+ | [setupStartVideo()](./core/setupstartvideo.md) | |
117
+ | [setupTrackMutedIndicator(trackRef)](./core/setuptrackmutedindicator.md) | |
118
+ | [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 |
119
+ | [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 |
120
+ | [SourcesArray](./core/sourcesarray.md) | |
121
+ | [supportsScreenSharing()](./core/supportsscreensharing.md) | Returns <code>true</code> if the browser supports screen sharing. |
122
+ | [ToggleSource](./core/togglesource.md) | |
123
+ | [tokenize(input, grammar)](./core/tokenize.md) | |
124
+ | [TokenizeGrammar](./core/tokenizegrammar.md) | |
125
+ | [trackEventSelector(publication, event)](./core/trackeventselector.md) | |
126
+ | [trackObservable(track)](./core/trackobservable.md) | |
127
+ | [TrackReference](./core/trackreference.md) | |
128
+ | [TrackReferenceFilter](./core/trackreferencefilter.md) | |
129
+ | [TrackReferenceId](./core/trackreferenceid.md) | |
130
+ | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) | |
131
+ | [TrackReferencePlaceholder](./core/trackreferenceplaceholder.md) | |
132
+ | [trackReferencesObservable(room, sources, options)](./core/trackreferencesobservable.md) | |
133
+ | [TrackSource](./core/tracksource.md) | |
134
+ | [TrackSourceWithOptions](./core/tracksourcewithoptions.md) | |
135
+ | [trackSyncTimeObserver(track)](./core/tracksynctimeobserver.md) | |
136
+ | [trackTranscriptionObserver(publication)](./core/tracktranscriptionobserver.md) | |
137
+ | [updatePages(currentList, nextList, maxItemsOnPage)](./core/updatepages.md) | Divide the list of elements into pages and and check if pages need updating. |
138
+ | [VideoSource](./core/videosource.md) | |
139
+ | [wasClickOutside(insideElement, event)](./core/wasclickoutside.md) | |
140
+ | [WIDGET_DEFAULT_STATE](./core/widget_default_state.md) | |
141
+ | [WidgetState](./core/widgetstate.md) | |
package/generated-docs/core/participantbyidentifierobserver.md ADDED
@@ -0,0 +1,20 @@
1
+ ---
2
+ {
3
+ "title": "participantByIdentifierObserver",
4
+ "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/participant.ts"
5
+ }
6
+ ---
7
+
8
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
9
+
10
+ # participantByIdentifierObserver
11
+
12
+ **Signature:**
13
+
14
+ ```typescript
15
+ export declare function participantByIdentifierObserver(
16
+ room: Room,
17
+ { kind, identity }: ParticipantIdentifier,
18
+ options?: ConnectedParticipantObserverOptions
19
+ ): Observable<RemoteParticipant | undefined>;
20
+ ```
package/generated-docs/core/participantidentifier.md ADDED
@@ -0,0 +1,26 @@
1
+ ---
2
+ {
3
+ "title": "ParticipantIdentifier type",
4
+ "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/types.ts"
5
+ }
6
+ ---
7
+
8
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
9
+
10
+ # ParticipantIdentifier type
11
+
12
+ > This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
13
+
14
+ **Signature:**
15
+
16
+ ```typescript
17
+ export type ParticipantIdentifier = RequireAtLeastOne<
18
+ {
19
+ kind: ParticipantKind;
20
+ identity: string;
21
+ },
22
+ "identity" | "kind"
23
+ >;
24
+ ```
25
+
26
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
package/generated-docs/react/hook/usedatachannel.md CHANGED
@@ -25,7 +25,9 @@ There is only one data channel. Passing a `topic` does not open a new data chann
25
25
 
26
26
  ```tsx
27
27
  // Send messages to all participants via the 'chat' topic.
28
- const { message, send } = useDataChannel("chat");
28
+ const { message: latestMessage, send } = useDataChannel("chat", (msg) =>
29
+ console.log("message received", msg)
30
+ );
29
31
  ```
30
32
 
31
33
  {% partial file="p_usage.md" variables={exampleCount: 1} /%}
package/generated-docs/react/hook/usedatachannel_1.md CHANGED
@@ -25,7 +25,9 @@ There is only one data channel. Passing a `topic` does not open a new data chann
25
25
 
26
26
  ```tsx
27
27
  // Send messages to all participants
28
- const { message, send } = useDataChannel(callback);
28
+ const { message: latestMessage, send } = useDataChannel("chat", (msg) =>
29
+ console.log("message received", msg)
30
+ );
29
31
  ```
30
32
 
31
33
  {% partial file="p_usage.md" variables={exampleCount: 1} /%}
package/generated-docs/react/hook/useremoteparticipant.md CHANGED
@@ -9,7 +9,7 @@
9
9
 
10
10
  # useRemoteParticipant
11
11
 
12
- The `useRemoteParticipant` hook returns the RemoteParticipant with the given `identity`<!-- -->.
12
+ The `useRemoteParticipant` hook returns the first RemoteParticipant by either identity and/or based on the participant kind.
13
13
 
14
14
  ## Import
15
15
 
@@ -24,14 +24,14 @@ To optimize performance, you can use the `updateOnlyOn` property to decide on wh
24
24
  ## Usage
25
25
 
26
26
  ```tsx
27
- const participant = useRemoteParticipant("Russ");
27
+ const participant = useRemoteParticipant({ kind: ParticipantKind.Agent, identity: "myAgent" });
28
28
  ```
29
29
 
30
30
  {% partial file="p_usage.md" variables={exampleCount: 1} /%}
31
31
 
32
32
  ## Properties
33
33
 
34
- {% parameter name="identity" type="string" optional=false %}
34
+ {% parameter name="identifier" type="ParticipantIdentifier" optional=false %}
35
35
  {% /parameter %}
36
36
 
37
37
  {% parameter name="options" type="UseRemoteParticipantOptions" optional=true %}
package/generated-docs/react/hook/useremoteparticipant_1.md ADDED
@@ -0,0 +1,44 @@
1
+ ---
2
+ {
3
+ "title": "useRemoteParticipant",
4
+ "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useRemoteParticipant.ts"
5
+ }
6
+ ---
7
+
8
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
9
+
10
+ # useRemoteParticipant
11
+
12
+ The `useRemoteParticipant` hook returns the first RemoteParticipant by either identity or based on the participant kind.
13
+
14
+ ## Import
15
+
16
+ ```typescript
17
+ import { useRemoteParticipant } from "@livekit/components-react";
18
+ ```
19
+
20
+ ## Remarks
21
+
22
+ To optimize performance, you can use the `updateOnlyOn` property to decide on what `ParticipantEvents` the hook updates.
23
+
24
+ ## Usage
25
+
26
+ ```tsx
27
+ const participant = useRemoteParticipant("Russ");
28
+ ```
29
+
30
+ {% partial file="p_usage.md" variables={exampleCount: 1} /%}
31
+
32
+ ## Properties
33
+
34
+ {% parameter name="identity" type="string" optional=false %}
35
+ {% /parameter %}
36
+
37
+ {% parameter name="options" type="UseRemoteParticipantOptions" optional=true %}
38
+ {% /parameter %}
39
+
40
+ ## Returns
41
+
42
+ ```typescript
43
+ RemoteParticipant | undefined;
44
+ ```
package/generated-docs/react/index.md CHANGED
@@ -85,7 +85,8 @@
85
85
  | [usePinnedTracks(layoutContext)](./react/hook/usepinnedtracks.md) | The <code>usePinnedTracks</code> hook returns a array of the pinned tracks of the current room. |
86
86
  | [usePreviewDevice(enabled, deviceId, kind)](./react/hook/usepreviewdevice.md) | |
87
87
  | [usePreviewTracks(options, onError)](./react/hook/usepreviewtracks.md) | |
88
- | [useRemoteParticipant(identity, options)](./react/hook/useremoteparticipant.md) | The <code>useRemoteParticipant</code> hook returns the RemoteParticipant with the given <code>identity</code>. |
88
+ | [useRemoteParticipant(identifier, options)](./react/hook/useremoteparticipant.md) | The <code>useRemoteParticipant</code> hook returns the first RemoteParticipant by either identity and/or based on the participant kind. |
89
+ | [useRemoteParticipant(identity, options)](./react/hook/useremoteparticipant_1.md) | The <code>useRemoteParticipant</code> hook returns the first RemoteParticipant by either identity or based on the participant kind. |
89
90
  | [useRemoteParticipants(options)](./react/hook/useremoteparticipants.md) | The <code>useRemoteParticipants</code> hook returns all remote participants (without the local) of the current room. |
90
91
  | [useRoomContext()](./react/hook/useroomcontext.md) | Ensures that a room is provided via context. If no room is provided, an error is thrown. |
91
92
  | [useRoomInfo(options)](./react/hook/useroominfo.md) | |
@@ -151,6 +152,7 @@
151
152
  | [MessageFormatter](./react/messageformatter.md) | |
152
153
  | [MultiBandTrackVolumeOptions](./react/multibandtrackvolumeoptions.md) | Interface for configuring options for the useMultibandTrackVolume hook. |
153
154
  | [ParticipantAudioTile](./react/participantaudiotile.md) | The <code>ParticipantAudioTile</code> component is the base utility wrapper for displaying a visual representation of a participant. This component can be used as a child of the <code>TileLoop</code> or independently if a participant is passed as a property. |
155
+ | [ParticipantIdentifier](./react/participantidentifier.md) | **_(BETA)_** |
154
156
  | [ParticipantLoopProps](./react/participantloopprops.md) | |
155
157
  | [ParticipantName](./react/participantname.md) | The <code>ParticipantName</code> component displays the name of the participant as a string within an HTML span element. If no participant name is undefined the participant identity string is displayed. |
156
158
  | [ParticipantNameProps](./react/participantnameprops.md) | |
package/generated-docs/react/meta-data.json CHANGED
@@ -1 +1 @@
1
- {"components":[{"filename":"audioconference.md","title":"AudioConference"},{"filename":"carousellayout.md","title":"CarouselLayout"},{"filename":"chat.md","title":"Chat"},{"filename":"connectionstatetoast.md","title":"ConnectionStateToast"},{"filename":"controlbar.md","title":"ControlBar"},{"filename":"focuslayout.md","title":"FocusLayout"},{"filename":"focuslayoutcontainer.md","title":"FocusLayoutContainer"},{"filename":"gridlayout.md","title":"GridLayout"},{"filename":"layoutcontext.md","title":"LayoutContext"},{"filename":"layoutcontextprovider.md","title":"LayoutContextProvider"},{"filename":"livekitroom.md","title":"LiveKitRoom"},{"filename":"mediadevicemenu.md","title":"MediaDeviceMenu"},{"filename":"participantcontext.md","title":"ParticipantContext"},{"filename":"participantcontextifneeded.md","title":"ParticipantContextIfNeeded"},{"filename":"participantloop.md","title":"ParticipantLoop"},{"filename":"prejoin.md","title":"PreJoin"},{"filename":"roomaudiorenderer.md","title":"RoomAudioRenderer"},{"filename":"roomcontext.md","title":"RoomContext"},{"filename":"toast.md","title":"Toast"},{"filename":"trackloop.md","title":"TrackLoop"},{"filename":"trackrefcontext.md","title":"TrackRefContext"},{"filename":"videoconference.md","title":"VideoConference"}],"hooks":[{"filename":"useaudioplayback.md","title":"useAudioPlayback"},{"filename":"usechat.md","title":"useChat"},{"filename":"usechattoggle.md","title":"useChatToggle"},{"filename":"useclearpinbutton.md","title":"useClearPinButton"},{"filename":"useconnectionqualityindicator.md","title":"useConnectionQualityIndicator"},{"filename":"useconnectionstate.md","title":"useConnectionState"},{"filename":"usecreatelayoutcontext.md","title":"useCreateLayoutContext"},{"filename":"usedatachannel.md","title":"useDataChannel"},{"filename":"usedatachannel_1.md","title":"useDataChannel"},{"filename":"usedisconnectbutton.md","title":"useDisconnectButton"},{"filename":"useensurecreatelayoutcontext.md","title":"useEnsureCreateLayoutContext"},{"filename":"useensurelayoutcontext.md","title":"useEnsureLayoutContext"},{"filename":"useensureparticipant.md","title":"useEnsureParticipant"},{"filename":"useensureroom.md","title":"useEnsureRoom"},{"filename":"useensuretrackref.md","title":"useEnsureTrackRef"},{"filename":"usefacingmode.md","title":"useFacingMode"},{"filename":"usefocustoggle.md","title":"useFocusToggle"},{"filename":"usegridlayout.md","title":"useGridLayout"},{"filename":"useisencrypted.md","title":"useIsEncrypted"},{"filename":"useismuted.md","title":"useIsMuted"},{"filename":"useisspeaking.md","title":"useIsSpeaking"},{"filename":"uselayoutcontext.md","title":"useLayoutContext"},{"filename":"uselivekitroom.md","title":"useLiveKitRoom"},{"filename":"uselocalparticipant.md","title":"useLocalParticipant"},{"filename":"uselocalparticipantpermissions.md","title":"useLocalParticipantPermissions"},{"filename":"usemaybelayoutcontext.md","title":"useMaybeLayoutContext"},{"filename":"usemaybeparticipantcontext.md","title":"useMaybeParticipantContext"},{"filename":"usemayberoomcontext.md","title":"useMaybeRoomContext"},{"filename":"usemaybetrackrefcontext.md","title":"useMaybeTrackRefContext"},{"filename":"usemediadevices.md","title":"useMediaDevices"},{"filename":"usemediadeviceselect.md","title":"useMediaDeviceSelect"},{"filename":"usemultibandtrackvolume.md","title":"useMultibandTrackVolume"},{"filename":"usepagination.md","title":"usePagination"},{"filename":"useparticipantcontext.md","title":"useParticipantContext"},{"filename":"useparticipantinfo.md","title":"useParticipantInfo"},{"filename":"useparticipantpermissions.md","title":"useParticipantPermissions"},{"filename":"useparticipants.md","title":"useParticipants"},{"filename":"useparticipanttile.md","title":"useParticipantTile"},{"filename":"useparticipanttracks.md","title":"useParticipantTracks"},{"filename":"usepersistentuserchoices.md","title":"usePersistentUserChoices"},{"filename":"usepinnedtracks.md","title":"usePinnedTracks"},{"filename":"usepreviewdevice.md","title":"usePreviewDevice"},{"filename":"usepreviewtracks.md","title":"usePreviewTracks"},{"filename":"useremoteparticipant.md","title":"useRemoteParticipant"},{"filename":"useremoteparticipants.md","title":"useRemoteParticipants"},{"filename":"useroomcontext.md","title":"useRoomContext"},{"filename":"useroominfo.md","title":"useRoomInfo"},{"filename":"usesortedparticipants.md","title":"useSortedParticipants"},{"filename":"usespeakingparticipants.md","title":"useSpeakingParticipants"},{"filename":"usestartaudio.md","title":"useStartAudio"},{"filename":"usestartvideo.md","title":"useStartVideo"},{"filename":"useswipe.md","title":"useSwipe"},{"filename":"usetoken.md","title":"useToken"},{"filename":"usetrackbyname.md","title":"useTrackByName"},{"filename":"usetrackmutedindicator.md","title":"useTrackMutedIndicator"},{"filename":"usetrackrefcontext.md","title":"useTrackRefContext"},{"filename":"usetracks.md","title":"useTracks"},{"filename":"usetracktoggle.md","title":"useTrackToggle"},{"filename":"usetracktranscription.md","title":"useTrackTranscription"},{"filename":"usetrackvolume.md","title":"useTrackVolume"},{"filename":"usevisualstableupdate.md","title":"useVisualStableUpdate"}]}
1
+ {"components":[{"filename":"audioconference.md","title":"AudioConference"},{"filename":"carousellayout.md","title":"CarouselLayout"},{"filename":"chat.md","title":"Chat"},{"filename":"connectionstatetoast.md","title":"ConnectionStateToast"},{"filename":"controlbar.md","title":"ControlBar"},{"filename":"focuslayout.md","title":"FocusLayout"},{"filename":"focuslayoutcontainer.md","title":"FocusLayoutContainer"},{"filename":"gridlayout.md","title":"GridLayout"},{"filename":"layoutcontext.md","title":"LayoutContext"},{"filename":"layoutcontextprovider.md","title":"LayoutContextProvider"},{"filename":"livekitroom.md","title":"LiveKitRoom"},{"filename":"mediadevicemenu.md","title":"MediaDeviceMenu"},{"filename":"participantcontext.md","title":"ParticipantContext"},{"filename":"participantcontextifneeded.md","title":"ParticipantContextIfNeeded"},{"filename":"participantloop.md","title":"ParticipantLoop"},{"filename":"prejoin.md","title":"PreJoin"},{"filename":"roomaudiorenderer.md","title":"RoomAudioRenderer"},{"filename":"roomcontext.md","title":"RoomContext"},{"filename":"toast.md","title":"Toast"},{"filename":"trackloop.md","title":"TrackLoop"},{"filename":"trackrefcontext.md","title":"TrackRefContext"},{"filename":"videoconference.md","title":"VideoConference"}],"hooks":[{"filename":"useaudioplayback.md","title":"useAudioPlayback"},{"filename":"usechat.md","title":"useChat"},{"filename":"usechattoggle.md","title":"useChatToggle"},{"filename":"useclearpinbutton.md","title":"useClearPinButton"},{"filename":"useconnectionqualityindicator.md","title":"useConnectionQualityIndicator"},{"filename":"useconnectionstate.md","title":"useConnectionState"},{"filename":"usecreatelayoutcontext.md","title":"useCreateLayoutContext"},{"filename":"usedatachannel.md","title":"useDataChannel"},{"filename":"usedatachannel_1.md","title":"useDataChannel"},{"filename":"usedisconnectbutton.md","title":"useDisconnectButton"},{"filename":"useensurecreatelayoutcontext.md","title":"useEnsureCreateLayoutContext"},{"filename":"useensurelayoutcontext.md","title":"useEnsureLayoutContext"},{"filename":"useensureparticipant.md","title":"useEnsureParticipant"},{"filename":"useensureroom.md","title":"useEnsureRoom"},{"filename":"useensuretrackref.md","title":"useEnsureTrackRef"},{"filename":"usefacingmode.md","title":"useFacingMode"},{"filename":"usefocustoggle.md","title":"useFocusToggle"},{"filename":"usegridlayout.md","title":"useGridLayout"},{"filename":"useisencrypted.md","title":"useIsEncrypted"},{"filename":"useismuted.md","title":"useIsMuted"},{"filename":"useisspeaking.md","title":"useIsSpeaking"},{"filename":"uselayoutcontext.md","title":"useLayoutContext"},{"filename":"uselivekitroom.md","title":"useLiveKitRoom"},{"filename":"uselocalparticipant.md","title":"useLocalParticipant"},{"filename":"uselocalparticipantpermissions.md","title":"useLocalParticipantPermissions"},{"filename":"usemaybelayoutcontext.md","title":"useMaybeLayoutContext"},{"filename":"usemaybeparticipantcontext.md","title":"useMaybeParticipantContext"},{"filename":"usemayberoomcontext.md","title":"useMaybeRoomContext"},{"filename":"usemaybetrackrefcontext.md","title":"useMaybeTrackRefContext"},{"filename":"usemediadevices.md","title":"useMediaDevices"},{"filename":"usemediadeviceselect.md","title":"useMediaDeviceSelect"},{"filename":"usemultibandtrackvolume.md","title":"useMultibandTrackVolume"},{"filename":"usepagination.md","title":"usePagination"},{"filename":"useparticipantcontext.md","title":"useParticipantContext"},{"filename":"useparticipantinfo.md","title":"useParticipantInfo"},{"filename":"useparticipantpermissions.md","title":"useParticipantPermissions"},{"filename":"useparticipants.md","title":"useParticipants"},{"filename":"useparticipanttile.md","title":"useParticipantTile"},{"filename":"useparticipanttracks.md","title":"useParticipantTracks"},{"filename":"usepersistentuserchoices.md","title":"usePersistentUserChoices"},{"filename":"usepinnedtracks.md","title":"usePinnedTracks"},{"filename":"usepreviewdevice.md","title":"usePreviewDevice"},{"filename":"usepreviewtracks.md","title":"usePreviewTracks"},{"filename":"useremoteparticipant.md","title":"useRemoteParticipant"},{"filename":"useremoteparticipant_1.md","title":"useRemoteParticipant"},{"filename":"useremoteparticipants.md","title":"useRemoteParticipants"},{"filename":"useroomcontext.md","title":"useRoomContext"},{"filename":"useroominfo.md","title":"useRoomInfo"},{"filename":"usesortedparticipants.md","title":"useSortedParticipants"},{"filename":"usespeakingparticipants.md","title":"useSpeakingParticipants"},{"filename":"usestartaudio.md","title":"useStartAudio"},{"filename":"usestartvideo.md","title":"useStartVideo"},{"filename":"useswipe.md","title":"useSwipe"},{"filename":"usetoken.md","title":"useToken"},{"filename":"usetrackbyname.md","title":"useTrackByName"},{"filename":"usetrackmutedindicator.md","title":"useTrackMutedIndicator"},{"filename":"usetrackrefcontext.md","title":"useTrackRefContext"},{"filename":"usetracks.md","title":"useTracks"},{"filename":"usetracktoggle.md","title":"useTrackToggle"},{"filename":"usetracktranscription.md","title":"useTrackTranscription"},{"filename":"usetrackvolume.md","title":"useTrackVolume"},{"filename":"usevisualstableupdate.md","title":"useVisualStableUpdate"}]}
package/generated-docs/react/participantidentifier.md ADDED
@@ -0,0 +1,26 @@
1
+ ---
2
+ {
3
+ "title": "ParticipantIdentifier type",
4
+ "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/../core/src/types.ts"
5
+ }
6
+ ---
7
+
8
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
9
+
10
+ # ParticipantIdentifier type
11
+
12
+ > This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
13
+
14
+ **Signature:**
15
+
16
+ ```typescript
17
+ export type ParticipantIdentifier = RequireAtLeastOne<
18
+ {
19
+ kind: ParticipantKind;
20
+ identity: string;
21
+ },
22
+ "identity" | "kind"
23
+ >;
24
+ ```
25
+
26
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@livekit/components-js-docs",
3
- "version": "0.1.24",
3
+ "version": "0.1.26",
4
4
  "description": "Automatically generated documentation pages for LiveKit Components JS. Intended to be consumed by the documentation page.",
5
5
  "repository": {
6
6
  "type": "git",
@@ -8,7 +8,7 @@
8
8
  "directory": "/docs/beta-docs"
9
9
  },
10
10
  "dependencies": {
11
- "@livekit/components-react": "2.3.2"
11
+ "@livekit/components-react": "2.3.4"
12
12
  },
13
13
  "author": "",
14
14
  "license": "Apache-2.0",