@livekit/components-js-docs 0.1.25 → 0.1.27
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.
- package/generated-docs/core/index.md +131 -129
- package/generated-docs/core/participantbyidentifierobserver.md +20 -0
- package/generated-docs/core/participantidentifier.md +26 -0
- package/generated-docs/react/component/audiotrack.md +50 -0
- package/generated-docs/react/{audiovisualizer.md → component/audiovisualizer.md} +9 -4
- package/generated-docs/react/component/chatentry.md +50 -0
- package/generated-docs/react/{chattoggle.md → component/chattoggle.md} +2 -4
- package/generated-docs/react/{clearpinbutton.md → component/clearpinbutton.md} +2 -4
- package/generated-docs/react/{connectionqualityindicator.md → component/connectionqualityindicator.md} +2 -4
- package/generated-docs/react/{connectionstate.md → component/connectionstate.md} +9 -4
- package/generated-docs/react/{disconnectbutton.md → component/disconnectbutton.md} +9 -4
- package/generated-docs/react/{focustoggle.md → component/focustoggle.md} +9 -4
- package/generated-docs/react/component/livekitroom.md +77 -0
- package/generated-docs/react/component/mediadeviceselect.md +73 -0
- package/generated-docs/react/{participantaudiotile.md → component/participantaudiotile.md} +19 -4
- package/generated-docs/react/{participantname.md → component/participantname.md} +2 -4
- package/generated-docs/react/{participanttile.md → component/participanttile.md} +19 -4
- package/generated-docs/react/{roomname.md → component/roomname.md} +9 -2
- package/generated-docs/react/{startaudio.md → component/startaudio.md} +7 -4
- package/generated-docs/react/{trackmutedindicator.md → component/trackmutedindicator.md} +12 -4
- package/generated-docs/react/component/tracktoggle.md +64 -0
- package/generated-docs/react/{videotrack.md → component/videotrack.md} +24 -4
- package/generated-docs/react/hook/useclearpinbutton.md +1 -1
- package/generated-docs/react/hook/useremoteparticipant.md +3 -3
- package/generated-docs/react/hook/useremoteparticipant_1.md +44 -0
- package/generated-docs/react/index.md +99 -97
- package/generated-docs/react/meta-data.json +1 -1
- package/generated-docs/react/participantidentifier.md +26 -0
- package/package.json +2 -2
- package/generated-docs/react/audiotrack.md +0 -30
- package/generated-docs/react/chatentry.md +0 -28
- package/generated-docs/react/mediadeviceselect.md +0 -30
- package/generated-docs/react/tracktoggle.md +0 -31
|
@@ -8,132 +8,134 @@
|
|
|
8
8
|
|
|
9
9
|
## Others
|
|
10
10
|
|
|
11
|
-
| Other
|
|
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)
|
|
48
|
-
| [getTrackReferenceSource(trackReference)](./core/gettrackreferencesource.md)
|
|
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)
|
|
54
|
-
| [isParticipantTrackReferencePinned(trackRef, pinState)](./core/isparticipanttrackreferencepinned.md)
|
|
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)
|
|
59
|
-
| [isTrackReferencePlaceholder(trackReference)](./core/istrackreferenceplaceholder.md)
|
|
60
|
-
| [loadUserChoices(defaults, preventLoad)](./core/loaduserchoices.md)
|
|
61
|
-
| [LocalUserChoices](./core/localuserchoices.md)
|
|
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
|
-
| [
|
|
72
|
-
| [
|
|
73
|
-
| [
|
|
74
|
-
| [
|
|
75
|
-
| [
|
|
76
|
-
| [
|
|
77
|
-
| [
|
|
78
|
-
| [
|
|
79
|
-
| [
|
|
80
|
-
| [
|
|
81
|
-
| [
|
|
82
|
-
| [
|
|
83
|
-
| [
|
|
84
|
-
| [
|
|
85
|
-
| [
|
|
86
|
-
| [
|
|
87
|
-
| [
|
|
88
|
-
| [
|
|
89
|
-
| [
|
|
90
|
-
| [
|
|
91
|
-
| [
|
|
92
|
-
| [
|
|
93
|
-
| [
|
|
94
|
-
| [
|
|
95
|
-
| [
|
|
96
|
-
| [
|
|
97
|
-
| [
|
|
98
|
-
| [
|
|
99
|
-
| [
|
|
100
|
-
| [
|
|
101
|
-
| [
|
|
102
|
-
| [
|
|
103
|
-
| [
|
|
104
|
-
| [
|
|
105
|
-
| [
|
|
106
|
-
| [
|
|
107
|
-
| [
|
|
108
|
-
| [
|
|
109
|
-
| [
|
|
110
|
-
| [
|
|
111
|
-
| [
|
|
112
|
-
| [
|
|
113
|
-
| [
|
|
114
|
-
| [
|
|
115
|
-
| [
|
|
116
|
-
| [
|
|
117
|
-
| [
|
|
118
|
-
| [
|
|
119
|
-
| [
|
|
120
|
-
| [
|
|
121
|
-
| [
|
|
122
|
-
| [
|
|
123
|
-
| [
|
|
124
|
-
| [
|
|
125
|
-
| [
|
|
126
|
-
| [
|
|
127
|
-
| [
|
|
128
|
-
| [
|
|
129
|
-
| [
|
|
130
|
-
| [
|
|
131
|
-
| [
|
|
132
|
-
| [
|
|
133
|
-
| [
|
|
134
|
-
| [
|
|
135
|
-
| [
|
|
136
|
-
| [
|
|
137
|
-
| [
|
|
138
|
-
| [
|
|
139
|
-
| [
|
|
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) | |
|
|
@@ -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
|
+
```
|
|
@@ -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} /%}
|