@livekit/components-js-docs 0.1.22 → 0.1.24

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 (53) hide show
  1. package/generated-docs/core/addmediatimestamptotranscription.md +22 -0
  2. package/generated-docs/core/allparticipantevents.md +2 -2
  3. package/generated-docs/core/allparticipantroomevents.md +2 -2
  4. package/generated-docs/core/allremoteparticipantevents.md +2 -2
  5. package/generated-docs/core/allremoteparticipantroomevents.md +2 -2
  6. package/generated-docs/core/cssprefix.md +2 -2
  7. package/generated-docs/core/datatopic.md +2 -2
  8. package/generated-docs/core/dedupesegments.md +22 -0
  9. package/generated-docs/core/defaultuserchoices.md +2 -2
  10. package/generated-docs/core/didactivesegmentschange.md +19 -0
  11. package/generated-docs/core/getactivetranscriptionsegments.md +23 -0
  12. package/generated-docs/core/grid_layouts.md +2 -2
  13. package/generated-docs/core/index.md +128 -120
  14. package/generated-docs/core/log.md +2 -2
  15. package/generated-docs/core/participanttrackevents.md +2 -2
  16. package/generated-docs/core/pin_default_state.md +2 -2
  17. package/generated-docs/core/receivedtranscriptionsegment.md +19 -0
  18. package/generated-docs/core/trackeventselector.md +19 -0
  19. package/generated-docs/core/tracksynctimeobserver.md +16 -0
  20. package/generated-docs/core/tracktranscriptionobserver.md +18 -0
  21. package/generated-docs/core/widget_default_state.md +2 -2
  22. package/generated-docs/react/audiotrack.md +2 -2
  23. package/generated-docs/react/audiovisualizer.md +2 -2
  24. package/generated-docs/react/chatentry.md +2 -2
  25. package/generated-docs/react/chattoggle.md +2 -2
  26. package/generated-docs/react/clearpinbutton.md +2 -2
  27. package/generated-docs/react/{layoutcontext.md → component/layoutcontext.md} +4 -4
  28. package/generated-docs/react/{livekitroom.md → component/livekitroom.md} +4 -8
  29. package/generated-docs/react/{participantcontext.md → component/participantcontext.md} +4 -4
  30. package/generated-docs/react/{roomcontext.md → component/roomcontext.md} +4 -4
  31. package/generated-docs/react/{trackrefcontext.md → component/trackrefcontext.md} +4 -4
  32. package/generated-docs/react/connectionqualityindicator.md +2 -2
  33. package/generated-docs/react/connectionstate.md +2 -2
  34. package/generated-docs/react/disconnectbutton.md +2 -2
  35. package/generated-docs/react/focustoggle.md +2 -2
  36. package/generated-docs/react/hook/useisencrypted.md +3 -0
  37. package/generated-docs/react/hook/usetracktranscription.md +34 -0
  38. package/generated-docs/react/index.md +9 -6
  39. package/generated-docs/react/mediadeviceselect.md +2 -2
  40. package/generated-docs/react/meta-data.json +1 -1
  41. package/generated-docs/react/participantaudiotile.md +2 -2
  42. package/generated-docs/react/participantname.md +2 -2
  43. package/generated-docs/react/participanttile.md +2 -2
  44. package/generated-docs/react/roomname.md +2 -2
  45. package/generated-docs/react/startaudio.md +2 -2
  46. package/generated-docs/react/trackmutedindicator.md +2 -2
  47. package/generated-docs/react/tracktoggle.md +2 -2
  48. package/generated-docs/react/tracktranscriptionoptions.buffersize.md +17 -0
  49. package/generated-docs/react/tracktranscriptionoptions.md +24 -0
  50. package/generated-docs/react/useisencryptedoptions.md +24 -0
  51. package/generated-docs/react/useisencryptedoptions.room.md +13 -0
  52. package/generated-docs/react/videotrack.md +2 -2
  53. package/package.json +2 -2
package/generated-docs/core/index.md CHANGED
@@ -8,123 +8,131 @@
8
8
 
9
9
  ## Others
10
10
 
11
- | Other | Description |
12
- | ---------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
13
- | [activeSpeakerObserver(room)](./core/activespeakerobserver.md) | |
14
- | [allParticipantEvents](./core/allparticipantevents.md) | |
15
- | [allParticipantRoomEvents](./core/allparticipantroomevents.md) | |
16
- | [allRemoteParticipantEvents](./core/allremoteparticipantevents.md) | |
17
- | [allRemoteParticipantRoomEvents](./core/allremoteparticipantroomevents.md) | |
18
- | [attachIfSubscribed(publication, element)](./core/attachifsubscribed.md) | |
19
- | [AudioSource](./core/audiosource.md) | |
20
- | [BaseDataMessage](./core/basedatamessage.md) | |
21
- | [CaptureOptionsBySource](./core/captureoptionsbysource.md) | |
22
- | [ChatMessage](./core/chatmessage.md) | |
23
- | [ChatOptions](./core/chatoptions.md) | |
24
- | [computeMenuPosition(button, menu)](./core/computemenuposition.md) | |
25
- | [connectedParticipantObserver(room, identity, options)](./core/connectedparticipantobserver.md) | |
26
- | [ConnectedParticipantObserverOptions](./core/connectedparticipantobserveroptions.md) | |
27
- | [connectedParticipantsObserver(room, options)](./core/connectedparticipantsobserver.md) | |
28
- | [connectionStateObserver(room)](./core/connectionstateobserver.md) | |
29
- | [createActiveDeviceObservable(room, kind)](./core/createactivedeviceobservable.md) | |
30
- | [createConnectionQualityObserver(participant)](./core/createconnectionqualityobserver.md) | |
31
- | [createDataObserver(room)](./core/createdataobserver.md) | |
32
- | [createDefaultGrammar()](./core/createdefaultgrammar.md) | |
33
- | [createIsSpeakingObserver(participant)](./core/createisspeakingobserver.md) | |
34
- | [createMediaDeviceObserver(kind, onError, requestPermissions)](./core/createmediadeviceobserver.md) | |
35
- | [createTrackObserver(participant, options)](./core/createtrackobserver.md) | |
36
- | [createUrlRegExp(options)](./core/createurlregexp.md) | |
37
- | [cssPrefix](./core/cssprefix.md) | |
38
- | [DataTopic](./core/datatopic.md) | |
39
- | [defaultUserChoices](./core/defaultuserchoices.md) | |
40
- | [encryptionStatusObservable(room, participant)](./core/encryptionstatusobservable.md) | |
41
- | [getTrackByIdentifier(options)](./core/gettrackbyidentifier.md) | |
42
- | [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. |
43
- | [getTrackReferenceSource(trackReference)](./core/gettrackreferencesource.md) | Returns the Source of the TrackReference. |
44
- | [GRID_LAYOUTS](./core/grid_layouts.md) | |
45
- | [GridLayoutDefinition](./core/gridlayoutdefinition.md) | |
46
- | [isEqualTrackRef(a, b)](./core/isequaltrackref.md) | |
47
- | [isLocal(p)](./core/islocal.md) | |
48
- | [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. |
49
- | [isParticipantTrackReferencePinned(trackRef, pinState)](./core/isparticipanttrackreferencepinned.md) | Check if the participant track reference is pinned. |
50
- | [isRemote(p)](./core/isremote.md) | |
51
- | [isSourcesWithOptions(sources)](./core/issourceswithoptions.md) | |
52
- | [isSourceWitOptions(source)](./core/issourcewitoptions.md) | |
53
- | [isTrackReferencePinned(trackReference, pinState)](./core/istrackreferencepinned.md) | Check if the <code>TrackReference</code> is pinned. |
54
- | [isTrackReferencePlaceholder(trackReference)](./core/istrackreferenceplaceholder.md) | |
55
- | [loadUserChoices(defaults, preventLoad)](./core/loaduserchoices.md) | Reads the user choices from local storage, or returns the default settings if none are found. |
56
- | [LocalUserChoices](./core/localuserchoices.md) | Represents the user's choices for video and audio input devices, as well as their username. |
57
- | [log](./core/log.md) | |
58
- | [MediaToggleType](./core/mediatoggletype.md) | |
59
- | [MessageDecoder](./core/messagedecoder.md) | |
60
- | [MessageEncoder](./core/messageencoder.md) | |
61
- | [mutedObserver(trackRef)](./core/mutedobserver.md) | |
62
- | [observeParticipantEvents(participant, events)](./core/observeparticipantevents.md) | |
63
- | [observeParticipantMedia(participant)](./core/observeparticipantmedia.md) | |
64
- | [observeRoomEvents(room, events)](./core/observeroomevents.md) | |
65
- | [observeTrackEvents(track, events)](./core/observetrackevents.md) | |
66
- | [participantEventSelector(participant, event)](./core/participanteventselector.md) | |
67
- | [ParticipantFilter](./core/participantfilter.md) | |
68
- | [participantInfoObserver(participant)](./core/participantinfoobserver.md) | |
69
- | [ParticipantMedia](./core/participantmedia.md) | |
70
- | [participantPermissionObserver(participant)](./core/participantpermissionobserver.md) | |
71
- | [participantTrackEvents](./core/participanttrackevents.md) | |
72
- | [ParticipantTrackIdentifier](./core/participanttrackidentifier.md) | |
73
- | [participantTracksObservable(participant, trackIdentifier)](./core/participanttracksobservable.md) | |
74
- | [PIN_DEFAULT_STATE](./core/pin_default_state.md) | |
75
- | [PinState](./core/pinstate.md) | |
76
- | [ReceivedChatMessage](./core/receivedchatmessage.md) | |
77
- | [ReceivedDataMessage](./core/receiveddatamessage.md) | |
78
- | [RequireOnlyOne](./core/requireonlyone.md) | |
79
- | [roomAudioPlaybackAllowedObservable(room)](./core/roomaudioplaybackallowedobservable.md) | |
80
- | [roomEventSelector(room, event)](./core/roomeventselector.md) | |
81
- | [roomInfoObserver(room)](./core/roominfoobserver.md) | |
82
- | [roomObserver(room)](./core/roomobserver.md) | |
83
- | [roomVideoPlaybackAllowedObservable(room)](./core/roomvideoplaybackallowedobservable.md) | |
84
- | [saveUserChoices(userChoices, preventSave)](./core/saveuserchoices.md) | Saves user choices to local storage. |
85
- | [screenShareObserver(room)](./core/screenshareobserver.md) | |
86
- | [ScreenShareTrackMap](./core/screensharetrackmap.md) | |
87
- | [selectGridLayout(layouts, participantCount, width, height)](./core/selectgridlayout.md) | |
88
- | [sendMessage(localParticipant, payload, options)](./core/sendmessage.md) | Publish data from the LocalParticipant. |
89
- | [setDifference(setA, setB)](./core/setdifference.md) | |
90
- | [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. |
91
- | [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. |
92
- | [SetMediaDeviceOptions](./core/setmediadeviceoptions.md) | |
93
- | [setupChat(room, options)](./core/setupchat.md) | |
94
- | [setupChatToggle()](./core/setupchattoggle.md) | |
95
- | [setupClearPinButton()](./core/setupclearpinbutton.md) | |
96
- | [setupConnectionQualityIndicator(participant)](./core/setupconnectionqualityindicator.md) | |
97
- | [setupDataMessageHandler(room, topic, onMessage)](./core/setupdatamessagehandler.md) | |
98
- | [setupDeviceSelector(kind, room, localTrack)](./core/setupdeviceselector.md) | |
99
- | [setupDisconnectButton(room)](./core/setupdisconnectbutton.md) | |
100
- | [setupFocusToggle()](./core/setupfocustoggle.md) | |
101
- | [setupLiveKitRoom()](./core/setuplivekitroom.md) | |
102
- | [setupManualToggle()](./core/setupmanualtoggle.md) | |
103
- | [setupMediaToggle(source, room, options, publishOptions, onError)](./core/setupmediatoggle.md) | |
104
- | [setupMediaTrack(trackIdentifier)](./core/setupmediatrack.md) | |
105
- | [setupParticipantName(participant)](./core/setupparticipantname.md) | |
106
- | [setupParticipantTile()](./core/setupparticipanttile.md) | |
107
- | [setupStartAudio()](./core/setupstartaudio.md) | |
108
- | [setupStartVideo()](./core/setupstartvideo.md) | |
109
- | [setupTrackMutedIndicator(trackRef)](./core/setuptrackmutedindicator.md) | |
110
- | [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 |
111
- | [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 |
112
- | [SourcesArray](./core/sourcesarray.md) | |
113
- | [supportsScreenSharing()](./core/supportsscreensharing.md) | Returns <code>true</code> if the browser supports screen sharing. |
114
- | [ToggleSource](./core/togglesource.md) | |
115
- | [tokenize(input, grammar)](./core/tokenize.md) | |
116
- | [TokenizeGrammar](./core/tokenizegrammar.md) | |
117
- | [trackObservable(track)](./core/trackobservable.md) | |
118
- | [TrackReference](./core/trackreference.md) | |
119
- | [TrackReferenceFilter](./core/trackreferencefilter.md) | |
120
- | [TrackReferenceId](./core/trackreferenceid.md) | |
121
- | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) | |
122
- | [TrackReferencePlaceholder](./core/trackreferenceplaceholder.md) | |
123
- | [trackReferencesObservable(room, sources, options)](./core/trackreferencesobservable.md) | |
124
- | [TrackSource](./core/tracksource.md) | |
125
- | [TrackSourceWithOptions](./core/tracksourcewithoptions.md) | |
126
- | [updatePages(currentList, nextList, maxItemsOnPage)](./core/updatepages.md) | Divide the list of elements into pages and and check if pages need updating. |
127
- | [VideoSource](./core/videosource.md) | |
128
- | [wasClickOutside(insideElement, event)](./core/wasclickoutside.md) | |
129
- | [WIDGET_DEFAULT_STATE](./core/widget_default_state.md) | |
130
- | [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
+ | [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) | |
package/generated-docs/core/log.md CHANGED
@@ -1,13 +1,13 @@
1
1
  ---
2
2
  {
3
- "title": "log variable",
3
+ "title": "log",
4
4
  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/logger.ts"
5
5
  }
6
6
  ---
7
7
 
8
8
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
9
9
 
10
- # log variable
10
+ # log
11
11
 
12
12
  **Signature:**
13
13
 
package/generated-docs/core/participanttrackevents.md CHANGED
@@ -1,13 +1,13 @@
1
1
  ---
2
2
  {
3
- "title": "participantTrackEvents variable",
3
+ "title": "participantTrackEvents",
4
4
  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/eventGroups.ts"
5
5
  }
6
6
  ---
7
7
 
8
8
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
9
9
 
10
- # participantTrackEvents variable
10
+ # participantTrackEvents
11
11
 
12
12
  **Signature:**
13
13
 
package/generated-docs/core/pin_default_state.md CHANGED
@@ -1,13 +1,13 @@
1
1
  ---
2
2
  {
3
- "title": "PIN_DEFAULT_STATE variable",
3
+ "title": "PIN_DEFAULT_STATE",
4
4
  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/types.ts"
5
5
  }
6
6
  ---
7
7
 
8
8
  <!-- Do not edit this file. It is automatically generated by API Documenter. -->
9
9
 
10
- # PIN_DEFAULT_STATE variable
10
+ # PIN_DEFAULT_STATE
11
11
 
12
12
  **Signature:**
13
13
 
package/generated-docs/core/receivedtranscriptionsegment.md ADDED
@@ -0,0 +1,19 @@
1
+ ---
2
+ {
3
+ "title": "ReceivedTranscriptionSegment type",
4
+ "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/transcriptions.ts"
5
+ }
6
+ ---
7
+
8
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
9
+
10
+ # ReceivedTranscriptionSegment type
11
+
12
+ **Signature:**
13
+
14
+ ```typescript
15
+ export type ReceivedTranscriptionSegment = TranscriptionSegment & {
16
+ receivedAtMediaTimestamp: number;
17
+ receivedAt: number;
18
+ };
19
+ ```
package/generated-docs/core/trackeventselector.md ADDED
@@ -0,0 +1,19 @@
1
+ ---
2
+ {
3
+ "title": "trackEventSelector",
4
+ "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/observables/track.ts"
5
+ }
6
+ ---
7
+
8
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
9
+
10
+ # trackEventSelector
11
+
12
+ **Signature:**
13
+
14
+ ```typescript
15
+ export declare function trackEventSelector<T extends TrackEvent>(
16
+ publication: TrackPublication | Track,
17
+ event: T
18
+ ): Observable<Parameters<PublicationEventCallbacks[Extract<T, keyof PublicationEventCallbacks>]>>;
19
+ ```