@livekit/components-js-docs 0.1.22 → 0.1.23

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 (15) hide show
  1. package/generated-docs/core/addmediatimestamptotranscription.md +22 -0
  2. package/generated-docs/core/dedupesegments.md +22 -0
  3. package/generated-docs/core/didactivesegmentschange.md +19 -0
  4. package/generated-docs/core/getactivetranscriptionsegments.md +23 -0
  5. package/generated-docs/core/index.md +128 -120
  6. package/generated-docs/core/receivedtranscriptionsegment.md +19 -0
  7. package/generated-docs/core/trackeventselector.md +19 -0
  8. package/generated-docs/core/tracksynctimeobserver.md +16 -0
  9. package/generated-docs/core/tracktranscriptionobserver.md +18 -0
  10. package/generated-docs/react/hook/usetracktranscription.md +34 -0
  11. package/generated-docs/react/index.md +2 -0
  12. package/generated-docs/react/meta-data.json +1 -1
  13. package/generated-docs/react/tracktranscriptionoptions.buffersize.md +17 -0
  14. package/generated-docs/react/tracktranscriptionoptions.md +24 -0
  15. package/package.json +2 -2
package/generated-docs/core/addmediatimestamptotranscription.md ADDED
@@ -0,0 +1,22 @@
1
+ ---
2
+ {
3
+ "title": "addMediaTimestampToTranscription",
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
+ # addMediaTimestampToTranscription
11
+
12
+ **Signature:**
13
+
14
+ ```typescript
15
+ export declare function addMediaTimestampToTranscription(
16
+ segment: TranscriptionSegment,
17
+ timestamps: {
18
+ timestamp: number;
19
+ rtpTimestamp?: number;
20
+ }
21
+ ): ReceivedTranscriptionSegment;
22
+ ```
package/generated-docs/core/dedupesegments.md ADDED
@@ -0,0 +1,22 @@
1
+ ---
2
+ {
3
+ "title": "dedupeSegments",
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
+ # dedupeSegments
11
+
12
+ **Signature:**
13
+
14
+ ```typescript
15
+ export declare function dedupeSegments<T extends TranscriptionSegment>(
16
+ prevSegments: T[],
17
+ newSegments: T[],
18
+ windowSize: number
19
+ ): T[];
20
+ ```
21
+
22
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
package/generated-docs/core/didactivesegmentschange.md ADDED
@@ -0,0 +1,19 @@
1
+ ---
2
+ {
3
+ "title": "didActiveSegmentsChange",
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
+ # didActiveSegmentsChange
11
+
12
+ **Signature:**
13
+
14
+ ```typescript
15
+ export declare function didActiveSegmentsChange<T extends TranscriptionSegment>(
16
+ prevActive: T[],
17
+ newActive: T[]
18
+ ): boolean;
19
+ ```
package/generated-docs/core/getactivetranscriptionsegments.md ADDED
@@ -0,0 +1,23 @@
1
+ ---
2
+ {
3
+ "title": "getActiveTranscriptionSegments",
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
+ # getActiveTranscriptionSegments
11
+
12
+ **Signature:**
13
+
14
+ ```typescript
15
+ export declare function getActiveTranscriptionSegments(
16
+ segments: ReceivedTranscriptionSegment[],
17
+ syncTimes: {
18
+ timestamp: number;
19
+ rtpTimestamp?: number;
20
+ },
21
+ maxAge?: number
22
+ ): ReceivedTranscriptionSegment[];
23
+ ```
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/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
+ ```
package/generated-docs/core/tracksynctimeobserver.md ADDED
@@ -0,0 +1,16 @@
1
+ ---
2
+ {
3
+ "title": "trackSyncTimeObserver",
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
+ # trackSyncTimeObserver
11
+
12
+ **Signature:**
13
+
14
+ ```typescript
15
+ export declare function trackSyncTimeObserver(track: Track): Observable<number>;
16
+ ```
package/generated-docs/core/tracktranscriptionobserver.md ADDED
@@ -0,0 +1,18 @@
1
+ ---
2
+ {
3
+ "title": "trackTranscriptionObserver",
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
+ # trackTranscriptionObserver
11
+
12
+ **Signature:**
13
+
14
+ ```typescript
15
+ export declare function trackTranscriptionObserver(
16
+ publication: TrackPublication
17
+ ): Observable<[transcription: import("livekit-client").TranscriptionSegment[]]>;
18
+ ```
package/generated-docs/react/hook/usetracktranscription.md ADDED
@@ -0,0 +1,34 @@
1
+ ---
2
+ {
3
+ "title": "useTrackTranscription",
4
+ "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTrackTranscription.ts"
5
+ }
6
+ ---
7
+
8
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
9
+
10
+ # useTrackTranscription
11
+
12
+ ## Import
13
+
14
+ ```typescript
15
+ import { useTrackTranscription } from "@livekit/components-react";
16
+ ```
17
+
18
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
19
+
20
+ ## Properties
21
+
22
+ {% parameter name="trackRef" type="TrackReferenceOrPlaceholder" optional=false %}
23
+ {% /parameter %}
24
+
25
+ {% parameter name="options" type="TrackTranscriptionOptions" optional=true %}
26
+ {% /parameter %}
27
+
28
+ ## Returns
29
+
30
+ ```typescript
31
+ {
32
+ segments: ReceivedTranscriptionSegment[];
33
+ }
34
+ ```
package/generated-docs/react/index.md CHANGED
@@ -95,6 +95,7 @@
95
95
  | [useTrackRefContext()](./react/hook/usetrackrefcontext.md) | Ensures that a track reference is provided via context. If not inside a <code>TrackRefContext</code>, an error is thrown. |
96
96
  | [useTracks(sources, options)](./react/hook/usetracks.md) | The <code>useTracks</code> hook returns an array of <code>TrackReference</code> or <code>TrackReferenceOrPlaceholder</code> depending on the provided <code>sources</code> property. If only subscribed tracks are desired, set the <code>onlySubscribed</code> property to <code>true</code>. |
97
97
  | [useTrackToggle({ source, onChange, initialState, captureOptions, publishOptions, onDeviceError, ...rest })](./react/hook/usetracktoggle.md) | The <code>useTrackToggle</code> hook is used to implement the <code>TrackToggle</code> component and returns state and functionality of the given track. |
98
+ | [useTrackTranscription(trackRef, options)](./react/hook/usetracktranscription.md) | |
98
99
  | [useTrackVolume(trackOrTrackReference, options)](./react/hook/usetrackvolume.md) | Hook for tracking the volume of an audio track using the Web Audio API. |
99
100
  | [useVisualStableUpdate(trackReferences, maxItemsOnPage, options)](./react/hook/usevisualstableupdate.md) | The <code>useVisualStableUpdate</code> hook is used to prevent visually jarring jumps and shifts of elements in an array. The algorithm only starts to update when there are more items than visually fit on a page. If this is the case, it will make sure that speaking participants move to the first page and are always visible. |
100
101
 
@@ -171,6 +172,7 @@
171
172
  | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | |
172
173
  | [TrackToggle](./react/tracktoggle.md) | With the <code>TrackToggle</code> component it is possible to mute and unmute your camera and microphone. The component uses an html button element under the hood so you can treat it like a button. |
173
174
  | [TrackToggleProps](./react/tracktoggleprops.md) | |
175
+ | [TrackTranscriptionOptions](./react/tracktranscriptionoptions.md) | |
174
176
  | [UseChatToggleProps](./react/usechattoggleprops.md) | |
175
177
  | [UseFocusToggleProps](./react/usefocustoggleprops.md) | |
176
178
  | [UseIsMutedOptions](./react/useismutedoptions.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":"layoutcontextprovider.md","title":"LayoutContextProvider"},{"filename":"mediadevicemenu.md","title":"MediaDeviceMenu"},{"filename":"participantcontextifneeded.md","title":"ParticipantContextIfNeeded"},{"filename":"participantloop.md","title":"ParticipantLoop"},{"filename":"prejoin.md","title":"PreJoin"},{"filename":"roomaudiorenderer.md","title":"RoomAudioRenderer"},{"filename":"toast.md","title":"Toast"},{"filename":"trackloop.md","title":"TrackLoop"},{"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":"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":"layoutcontextprovider.md","title":"LayoutContextProvider"},{"filename":"mediadevicemenu.md","title":"MediaDeviceMenu"},{"filename":"participantcontextifneeded.md","title":"ParticipantContextIfNeeded"},{"filename":"participantloop.md","title":"ParticipantLoop"},{"filename":"prejoin.md","title":"PreJoin"},{"filename":"roomaudiorenderer.md","title":"RoomAudioRenderer"},{"filename":"toast.md","title":"Toast"},{"filename":"trackloop.md","title":"TrackLoop"},{"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"}]}
package/generated-docs/react/tracktranscriptionoptions.buffersize.md ADDED
@@ -0,0 +1,17 @@
1
+ ---
2
+ { "title": "TrackTranscriptionOptions.bufferSize property" }
3
+ ---
4
+
5
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
6
+
7
+ # TrackTranscriptionOptions.bufferSize property
8
+
9
+ how many transcription segments should be buffered in state
10
+
11
+ **Signature:**
12
+
13
+ ```typescript
14
+ bufferSize?: number;
15
+ ```
16
+
17
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
package/generated-docs/react/tracktranscriptionoptions.md ADDED
@@ -0,0 +1,24 @@
1
+ ---
2
+ {
3
+ "title": "TrackTranscriptionOptions interface",
4
+ "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTrackTranscription.ts"
5
+ }
6
+ ---
7
+
8
+ <!-- Do not edit this file. It is automatically generated by API Documenter. -->
9
+
10
+ # TrackTranscriptionOptions interface
11
+
12
+ **Signature:**
13
+
14
+ ```typescript
15
+ export interface TrackTranscriptionOptions
16
+ ```
17
+
18
+ {% partial file="p_usage.md" variables={exampleCount: 0} /%}
19
+
20
+ ## Properties
21
+
22
+ | Property | Type | Description |
23
+ | -------------------------------------------------------------- | ------ | ------------------------------------------------------------------------ |
24
+ | [bufferSize?](./react/tracktranscriptionoptions.buffersize.md) | number | _(Optional)_ how many transcription segments should be buffered in state |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@livekit/components-js-docs",
3
- "version": "0.1.22",
3
+ "version": "0.1.23",
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.0"
11
+ "@livekit/components-react": "2.3.1"
12
12
  },
13
13
  "author": "",
14
14
  "license": "Apache-2.0",