@livekit/components-js-docs 0.1.67 → 0.1.68
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/react/hook/usesequentialroomconnectdisconnect.md +41 -0
- package/generated-docs/react/hook/usetracktranscription.md +6 -0
- package/generated-docs/react/index.md +78 -76
- package/generated-docs/react/meta-data.json +1 -1
- package/generated-docs/react/tracktranscriptionoptions.md +6 -0
- package/generated-docs/react/usesequentialroomconnectdisconnectresults.md +19 -0
- package/package.json +3 -6
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "useSequentialRoomConnectDisconnect",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useSequentialRoomConnectDisconnect.ts"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
# useSequentialRoomConnectDisconnect
|
|
11
|
+
|
|
12
|
+
When calling room.disconnect() as part of a React useEffect cleanup function, it is possible for a room.connect(...) in the effect body to start running while the room.disconnect() is still running. This hook sequentializes these two operations, so they always happen in order and never overlap.
|
|
13
|
+
|
|
14
|
+
## Import
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { useSequentialRoomConnectDisconnect } from "@livekit/components-react";
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Usage
|
|
21
|
+
|
|
22
|
+
```ts
|
|
23
|
+
const { connect, disconnect } = useSequentialRoomConnectDisconnect(room);
|
|
24
|
+
|
|
25
|
+
// Connecting to a room:
|
|
26
|
+
useEffect(() => {
|
|
27
|
+
connect();
|
|
28
|
+
return () => disconnect();
|
|
29
|
+
}, [connect, disconnect]);
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Properties
|
|
33
|
+
|
|
34
|
+
{% parameter name="room" type="R" optional=false %}
|
|
35
|
+
{% /parameter %}
|
|
36
|
+
|
|
37
|
+
## Returns
|
|
38
|
+
|
|
39
|
+
```typescript
|
|
40
|
+
UseSequentialRoomConnectDisconnectResults<R>;
|
|
41
|
+
```
|
|
@@ -15,6 +15,12 @@ This feature is experimental and may change or be removed based on developer fee
|
|
|
15
15
|
|
|
16
16
|
{% /callout %}
|
|
17
17
|
|
|
18
|
+
{% callout type="caution" variation="normal" %}
|
|
19
|
+
|
|
20
|
+
This API is deprecated: Use useTranscription instead
|
|
21
|
+
|
|
22
|
+
{% /callout %}
|
|
23
|
+
|
|
18
24
|
## Import
|
|
19
25
|
|
|
20
26
|
```typescript
|
|
@@ -116,6 +116,7 @@
|
|
|
116
116
|
| [useRemoteParticipants(options)](./react/hook/useremoteparticipants.md) | The <code>useRemoteParticipants</code> hook returns all remote participants (without the local) of the current room. |
|
|
117
117
|
| [useRoomContext()](./react/hook/useroomcontext.md) | Ensures that a room is provided via context. If no room is provided, an error is thrown. |
|
|
118
118
|
| [useRoomInfo(options)](./react/hook/useroominfo.md) | |
|
|
119
|
+
| [useSequentialRoomConnectDisconnect(room)](./react/hook/usesequentialroomconnectdisconnect.md) | When calling room.disconnect() as part of a React useEffect cleanup function, it is possible for a room.connect(...) in the effect body to start running while the room.disconnect() is still running. This hook sequentializes these two operations, so they always happen in order and never overlap. |
|
|
119
120
|
| [useSortedParticipants(participants)](./react/hook/usesortedparticipants.md) | The <code>useSortedParticipants</code> hook returns the participants sorted by importance. |
|
|
120
121
|
| [useSpeakingParticipants()](./react/hook/usespeakingparticipants.md) | The <code>useSpeakingParticipants</code> hook returns only the active speakers of all participants. |
|
|
121
122
|
| [useStartAudio({ room, props })](./react/hook/usestartaudio.md) | In many browsers to start audio playback, the user must perform a user-initiated event such as clicking a button. The <code>useStatAudio</code> hook returns an object with a boolean <code>canPlayAudio</code> flag that indicates whether audio playback is allowed in the current context, as well as a <code>startAudio</code> function that can be called in a button <code>onClick</code> callback to start audio playback in the current context. |
|
|
@@ -136,79 +137,80 @@
|
|
|
136
137
|
|
|
137
138
|
## Others
|
|
138
139
|
|
|
139
|
-
| Other
|
|
140
|
-
|
|
|
141
|
-
| [AgentState](./react/agentstate.md)
|
|
142
|
-
| [AllowAudioPlaybackProps](./react/allowaudioplaybackprops.md)
|
|
143
|
-
| [AllowMediaPlaybackProps](./react/allowmediaplaybackprops.md)
|
|
144
|
-
| [AudioConferenceProps](./react/audioconferenceprops.md)
|
|
145
|
-
| [AudioTrackProps](./react/audiotrackprops.md)
|
|
146
|
-
| [AudioVisualizerProps](./react/audiovisualizerprops.md)
|
|
147
|
-
| [AudioWaveformOptions](./react/audiowaveformoptions.md)
|
|
148
|
-
| [BarVisualizerOptions](./react/barvisualizeroptions.md)
|
|
149
|
-
| [BarVisualizerProps](./react/barvisualizerprops.md)
|
|
150
|
-
| [CarouselLayoutProps](./react/carousellayoutprops.md)
|
|
151
|
-
| [ChatEntryProps](./react/chatentryprops.md)
|
|
152
|
-
| [ChatProps](./react/chatprops.md)
|
|
153
|
-
| [ChatToggleProps](./react/chattoggleprops.md)
|
|
154
|
-
| [ClearPinButtonProps](./react/clearpinbuttonprops.md)
|
|
155
|
-
| [ConnectionQualityIndicatorOptions](./react/connectionqualityindicatoroptions.md)
|
|
156
|
-
| [ConnectionQualityIndicatorProps](./react/connectionqualityindicatorprops.md)
|
|
157
|
-
| [ConnectionStateToastProps](./react/connectionstatetoastprops.md)
|
|
158
|
-
| [ConnectionStatusProps](./react/connectionstatusprops.md)
|
|
159
|
-
| [ControlBarControls](./react/controlbarcontrols.md)
|
|
160
|
-
| [ControlBarProps](./react/controlbarprops.md)
|
|
161
|
-
| [DisconnectButtonProps](./react/disconnectbuttonprops.md)
|
|
162
|
-
| [FocusLayoutContainerProps](./react/focuslayoutcontainerprops.md)
|
|
163
|
-
| [FocusLayoutProps](./react/focuslayoutprops.md)
|
|
164
|
-
| [FocusToggleProps](./react/focustoggleprops.md)
|
|
165
|
-
| [formatChatMessageLinks(message)](./react/formatchatmessagelinks.md)
|
|
166
|
-
| [GridLayoutProps](./react/gridlayoutprops.md)
|
|
167
|
-
| [LayoutContextProviderProps](./react/layoutcontextproviderprops.md)
|
|
168
|
-
| [LayoutContextType](./react/layoutcontexttype.md)
|
|
169
|
-
| [LiveKitRoomProps](./react/livekitroomprops.md)
|
|
170
|
-
| [MediaDeviceMenuProps](./react/mediadevicemenuprops.md)
|
|
171
|
-
| [MediaDeviceSelectProps](./react/mediadeviceselectprops.md)
|
|
172
|
-
| [MessageFormatter](./react/messageformatter.md)
|
|
173
|
-
| [MultiBandTrackVolumeOptions](./react/multibandtrackvolumeoptions.md)
|
|
174
|
-
| [ParticipantLoopProps](./react/participantloopprops.md)
|
|
175
|
-
| [ParticipantNameProps](./react/participantnameprops.md)
|
|
176
|
-
| [ParticipantTileProps](./react/participanttileprops.md)
|
|
177
|
-
| [PreJoinProps](./react/prejoinprops.md)
|
|
178
|
-
| [RoomAudioRendererProps](./react/roomaudiorendererprops.md)
|
|
179
|
-
| [RoomNameProps](./react/roomnameprops.md)
|
|
180
|
-
| [TrackLoopProps](./react/trackloopprops.md)
|
|
181
|
-
| [TrackMutedIndicatorProps](./react/trackmutedindicatorprops.md)
|
|
182
|
-
| [TrackToggleProps](./react/tracktoggleprops.md)
|
|
183
|
-
| [TrackTranscriptionOptions](./react/tracktranscriptionoptions.md)
|
|
184
|
-
| [UseChatToggleProps](./react/usechattoggleprops.md)
|
|
185
|
-
| [UseFocusToggleProps](./react/usefocustoggleprops.md)
|
|
186
|
-
| [UseIsEncryptedOptions](./react/useisencryptedoptions.md)
|
|
187
|
-
| [UseIsMutedOptions](./react/useismutedoptions.md)
|
|
188
|
-
| [useKrispNoiseFilterOptions](./react/usekrispnoisefilteroptions.md)
|
|
189
|
-
| [UseLocalParticipantOptions](./react/uselocalparticipantoptions.md)
|
|
190
|
-
| [UseMediaDeviceSelectProps](./react/usemediadeviceselectprops.md)
|
|
191
|
-
| [UseParticipantAttributesOptions](./react/useparticipantattributesoptions.md)
|
|
192
|
-
| [UseParticipantInfoOptions](./react/useparticipantinfooptions.md)
|
|
193
|
-
| [UseParticipantPermissionsOptions](./react/useparticipantpermissionsoptions.md)
|
|
194
|
-
| [UseParticipantsOptions](./react/useparticipantsoptions.md)
|
|
195
|
-
| [UseParticipantTileProps](./react/useparticipanttileprops.md)
|
|
196
|
-
| [UsePersistentUserChoicesOptions](./react/usepersistentuserchoicesoptions.md)
|
|
197
|
-
| [UseRemoteParticipantOptions](./react/useremoteparticipantoptions.md)
|
|
198
|
-
| [UseRemoteParticipantsOptions](./react/useremoteparticipantsoptions.md)
|
|
199
|
-
| [UserInfo](./react/userinfo.md)
|
|
200
|
-
| [UseRoomInfoOptions](./react/useroominfooptions.md)
|
|
201
|
-
| [
|
|
202
|
-
| [
|
|
203
|
-
| [
|
|
204
|
-
| [
|
|
205
|
-
| [
|
|
206
|
-
| [
|
|
207
|
-
| [
|
|
208
|
-
| [
|
|
209
|
-
| [
|
|
210
|
-
| [
|
|
211
|
-
| [
|
|
212
|
-
| [
|
|
213
|
-
| [
|
|
214
|
-
| [
|
|
140
|
+
| Other | Description |
|
|
141
|
+
| ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
142
|
+
| [AgentState](./react/agentstate.md) | **_(BETA)_** |
|
|
143
|
+
| [AllowAudioPlaybackProps](./react/allowaudioplaybackprops.md) | |
|
|
144
|
+
| [AllowMediaPlaybackProps](./react/allowmediaplaybackprops.md) | |
|
|
145
|
+
| [AudioConferenceProps](./react/audioconferenceprops.md) | |
|
|
146
|
+
| [AudioTrackProps](./react/audiotrackprops.md) | |
|
|
147
|
+
| [AudioVisualizerProps](./react/audiovisualizerprops.md) | |
|
|
148
|
+
| [AudioWaveformOptions](./react/audiowaveformoptions.md) | |
|
|
149
|
+
| [BarVisualizerOptions](./react/barvisualizeroptions.md) | **_(BETA)_** |
|
|
150
|
+
| [BarVisualizerProps](./react/barvisualizerprops.md) | **_(BETA)_** |
|
|
151
|
+
| [CarouselLayoutProps](./react/carousellayoutprops.md) | |
|
|
152
|
+
| [ChatEntryProps](./react/chatentryprops.md) | ChatEntry composes the HTML div element under the hood, so you can pass all its props. These are the props specific to the ChatEntry component: |
|
|
153
|
+
| [ChatProps](./react/chatprops.md) | |
|
|
154
|
+
| [ChatToggleProps](./react/chattoggleprops.md) | |
|
|
155
|
+
| [ClearPinButtonProps](./react/clearpinbuttonprops.md) | |
|
|
156
|
+
| [ConnectionQualityIndicatorOptions](./react/connectionqualityindicatoroptions.md) | |
|
|
157
|
+
| [ConnectionQualityIndicatorProps](./react/connectionqualityindicatorprops.md) | |
|
|
158
|
+
| [ConnectionStateToastProps](./react/connectionstatetoastprops.md) | |
|
|
159
|
+
| [ConnectionStatusProps](./react/connectionstatusprops.md) | |
|
|
160
|
+
| [ControlBarControls](./react/controlbarcontrols.md) | |
|
|
161
|
+
| [ControlBarProps](./react/controlbarprops.md) | |
|
|
162
|
+
| [DisconnectButtonProps](./react/disconnectbuttonprops.md) | |
|
|
163
|
+
| [FocusLayoutContainerProps](./react/focuslayoutcontainerprops.md) | |
|
|
164
|
+
| [FocusLayoutProps](./react/focuslayoutprops.md) | |
|
|
165
|
+
| [FocusToggleProps](./react/focustoggleprops.md) | |
|
|
166
|
+
| [formatChatMessageLinks(message)](./react/formatchatmessagelinks.md) | |
|
|
167
|
+
| [GridLayoutProps](./react/gridlayoutprops.md) | |
|
|
168
|
+
| [LayoutContextProviderProps](./react/layoutcontextproviderprops.md) | |
|
|
169
|
+
| [LayoutContextType](./react/layoutcontexttype.md) | |
|
|
170
|
+
| [LiveKitRoomProps](./react/livekitroomprops.md) | |
|
|
171
|
+
| [MediaDeviceMenuProps](./react/mediadevicemenuprops.md) | |
|
|
172
|
+
| [MediaDeviceSelectProps](./react/mediadeviceselectprops.md) | |
|
|
173
|
+
| [MessageFormatter](./react/messageformatter.md) | |
|
|
174
|
+
| [MultiBandTrackVolumeOptions](./react/multibandtrackvolumeoptions.md) | Interface for configuring options for the useMultibandTrackVolume hook. |
|
|
175
|
+
| [ParticipantLoopProps](./react/participantloopprops.md) | |
|
|
176
|
+
| [ParticipantNameProps](./react/participantnameprops.md) | |
|
|
177
|
+
| [ParticipantTileProps](./react/participanttileprops.md) | |
|
|
178
|
+
| [PreJoinProps](./react/prejoinprops.md) | Props for the PreJoin component. |
|
|
179
|
+
| [RoomAudioRendererProps](./react/roomaudiorendererprops.md) | |
|
|
180
|
+
| [RoomNameProps](./react/roomnameprops.md) | |
|
|
181
|
+
| [TrackLoopProps](./react/trackloopprops.md) | |
|
|
182
|
+
| [TrackMutedIndicatorProps](./react/trackmutedindicatorprops.md) | |
|
|
183
|
+
| [TrackToggleProps](./react/tracktoggleprops.md) | |
|
|
184
|
+
| [TrackTranscriptionOptions](./react/tracktranscriptionoptions.md) | |
|
|
185
|
+
| [UseChatToggleProps](./react/usechattoggleprops.md) | |
|
|
186
|
+
| [UseFocusToggleProps](./react/usefocustoggleprops.md) | |
|
|
187
|
+
| [UseIsEncryptedOptions](./react/useisencryptedoptions.md) | |
|
|
188
|
+
| [UseIsMutedOptions](./react/useismutedoptions.md) | |
|
|
189
|
+
| [useKrispNoiseFilterOptions](./react/usekrispnoisefilteroptions.md) | **_(BETA)_** |
|
|
190
|
+
| [UseLocalParticipantOptions](./react/uselocalparticipantoptions.md) | |
|
|
191
|
+
| [UseMediaDeviceSelectProps](./react/usemediadeviceselectprops.md) | |
|
|
192
|
+
| [UseParticipantAttributesOptions](./react/useparticipantattributesoptions.md) | The <code>useParticipantAttributes</code> hook returns the attributes of a given participant and allows to set them. It requires a <code>Participant</code> object passed as property or via the <code>ParticipantContext</code>. |
|
|
193
|
+
| [UseParticipantInfoOptions](./react/useparticipantinfooptions.md) | The <code>useParticipantInfo</code> hook returns the identity, name, and metadata of a given participant. It requires a <code>Participant</code> object passed as property or via the <code>ParticipantContext</code>. |
|
|
194
|
+
| [UseParticipantPermissionsOptions](./react/useparticipantpermissionsoptions.md) | The <code>useParticipantPermissions</code> hook returns the permissions of a given participant. |
|
|
195
|
+
| [UseParticipantsOptions](./react/useparticipantsoptions.md) | |
|
|
196
|
+
| [UseParticipantTileProps](./react/useparticipanttileprops.md) | |
|
|
197
|
+
| [UsePersistentUserChoicesOptions](./react/usepersistentuserchoicesoptions.md) | Options for the <code>usePersistentDeviceSettings</code> hook. |
|
|
198
|
+
| [UseRemoteParticipantOptions](./react/useremoteparticipantoptions.md) | |
|
|
199
|
+
| [UseRemoteParticipantsOptions](./react/useremoteparticipantsoptions.md) | |
|
|
200
|
+
| [UserInfo](./react/userinfo.md) | |
|
|
201
|
+
| [UseRoomInfoOptions](./react/useroominfooptions.md) | The <code>useRoomInfo</code> hook returns the name and metadata of the given <code>Room</code>. |
|
|
202
|
+
| [UseSequentialRoomConnectDisconnectResults](./react/usesequentialroomconnectdisconnectresults.md) | |
|
|
203
|
+
| [UseStartAudioProps](./react/usestartaudioprops.md) | |
|
|
204
|
+
| [UseStartVideoProps](./react/usestartvideoprops.md) | |
|
|
205
|
+
| [UseSwipeOptions](./react/useswipeoptions.md) | |
|
|
206
|
+
| [UseTokenOptions](./react/usetokenoptions.md) | |
|
|
207
|
+
| [UseTracksHookReturnType](./react/usetrackshookreturntype.md) | |
|
|
208
|
+
| [UseTracksOptions](./react/usetracksoptions.md) | |
|
|
209
|
+
| [UseTrackToggleProps](./react/usetracktoggleprops.md) | |
|
|
210
|
+
| [UseTranscriptionsOptions](./react/usetranscriptionsoptions.md) | **_(BETA)_** |
|
|
211
|
+
| [UseVisualStableUpdateOptions](./react/usevisualstableupdateoptions.md) | |
|
|
212
|
+
| [VideoConferenceProps](./react/videoconferenceprops.md) | |
|
|
213
|
+
| [VideoTrackProps](./react/videotrackprops.md) | |
|
|
214
|
+
| [VoiceAssistant](./react/voiceassistant.md) | **_(BETA)_** |
|
|
215
|
+
| [VoiceAssistantControlBarControls](./react/voiceassistantcontrolbarcontrols.md) | **_(BETA)_** |
|
|
216
|
+
| [VoiceAssistantControlBarProps](./react/voiceassistantcontrolbarprops.md) | **_(BETA)_** |
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"components":[{"filename":"audioconference.md","title":"AudioConference"},{"filename":"audiotrack.md","title":"AudioTrack"},{"filename":"audiovisualizer.md","title":"AudioVisualizer"},{"filename":"barvisualizer.md","title":"BarVisualizer"},{"filename":"carousellayout.md","title":"CarouselLayout"},{"filename":"chat.md","title":"Chat"},{"filename":"chatentry.md","title":"ChatEntry"},{"filename":"chattoggle.md","title":"ChatToggle"},{"filename":"clearpinbutton.md","title":"ClearPinButton"},{"filename":"connectionqualityindicator.md","title":"ConnectionQualityIndicator"},{"filename":"connectionstate.md","title":"ConnectionState"},{"filename":"connectionstatetoast.md","title":"ConnectionStateToast"},{"filename":"controlbar.md","title":"ControlBar"},{"filename":"disconnectbutton.md","title":"DisconnectButton"},{"filename":"focuslayout.md","title":"FocusLayout"},{"filename":"focuslayoutcontainer.md","title":"FocusLayoutContainer"},{"filename":"focustoggle.md","title":"FocusToggle"},{"filename":"gridlayout.md","title":"GridLayout"},{"filename":"layoutcontext.md","title":"LayoutContext"},{"filename":"layoutcontextprovider.md","title":"LayoutContextProvider"},{"filename":"livekitroom.md","title":"LiveKitRoom"},{"filename":"mediadevicemenu.md","title":"MediaDeviceMenu"},{"filename":"mediadeviceselect.md","title":"MediaDeviceSelect"},{"filename":"participantaudiotile.md","title":"ParticipantAudioTile"},{"filename":"participantcontext.md","title":"ParticipantContext"},{"filename":"participantcontextifneeded.md","title":"ParticipantContextIfNeeded"},{"filename":"participantloop.md","title":"ParticipantLoop"},{"filename":"participantname.md","title":"ParticipantName"},{"filename":"participanttile.md","title":"ParticipantTile"},{"filename":"prejoin.md","title":"PreJoin"},{"filename":"roomaudiorenderer.md","title":"RoomAudioRenderer"},{"filename":"roomcontext.md","title":"RoomContext"},{"filename":"roomname.md","title":"RoomName"},{"filename":"startaudio.md","title":"StartAudio"},{"filename":"startmediabutton.md","title":"StartMediaButton"},{"filename":"toast.md","title":"Toast"},{"filename":"trackloop.md","title":"TrackLoop"},{"filename":"trackmutedindicator.md","title":"TrackMutedIndicator"},{"filename":"trackrefcontext.md","title":"TrackRefContext"},{"filename":"tracktoggle.md","title":"TrackToggle"},{"filename":"videoconference.md","title":"VideoConference"},{"filename":"videotrack.md","title":"VideoTrack"},{"filename":"voiceassistantcontrolbar.md","title":"VoiceAssistantControlBar"}],"hooks":[{"filename":"useaudioplayback.md","title":"useAudioPlayback"},{"filename":"useaudiowaveform.md","title":"useAudioWaveform"},{"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":"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":"useisrecording.md","title":"useIsRecording"},{"filename":"useisspeaking.md","title":"useIsSpeaking"},{"filename":"usekrispnoisefilter.md","title":"useKrispNoiseFilter"},{"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":"useparticipantattribute.md","title":"useParticipantAttribute"},{"filename":"useparticipantattributes.md","title":"useParticipantAttributes"},{"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":"usetextstream.md","title":"useTextStream"},{"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":"usetranscriptions.md","title":"useTranscriptions"},{"filename":"usevisualstableupdate.md","title":"useVisualStableUpdate"},{"filename":"usevoiceassistant.md","title":"useVoiceAssistant"}]}
|
|
1
|
+
{"components":[{"filename":"audioconference.md","title":"AudioConference"},{"filename":"audiotrack.md","title":"AudioTrack"},{"filename":"audiovisualizer.md","title":"AudioVisualizer"},{"filename":"barvisualizer.md","title":"BarVisualizer"},{"filename":"carousellayout.md","title":"CarouselLayout"},{"filename":"chat.md","title":"Chat"},{"filename":"chatentry.md","title":"ChatEntry"},{"filename":"chattoggle.md","title":"ChatToggle"},{"filename":"clearpinbutton.md","title":"ClearPinButton"},{"filename":"connectionqualityindicator.md","title":"ConnectionQualityIndicator"},{"filename":"connectionstate.md","title":"ConnectionState"},{"filename":"connectionstatetoast.md","title":"ConnectionStateToast"},{"filename":"controlbar.md","title":"ControlBar"},{"filename":"disconnectbutton.md","title":"DisconnectButton"},{"filename":"focuslayout.md","title":"FocusLayout"},{"filename":"focuslayoutcontainer.md","title":"FocusLayoutContainer"},{"filename":"focustoggle.md","title":"FocusToggle"},{"filename":"gridlayout.md","title":"GridLayout"},{"filename":"layoutcontext.md","title":"LayoutContext"},{"filename":"layoutcontextprovider.md","title":"LayoutContextProvider"},{"filename":"livekitroom.md","title":"LiveKitRoom"},{"filename":"mediadevicemenu.md","title":"MediaDeviceMenu"},{"filename":"mediadeviceselect.md","title":"MediaDeviceSelect"},{"filename":"participantaudiotile.md","title":"ParticipantAudioTile"},{"filename":"participantcontext.md","title":"ParticipantContext"},{"filename":"participantcontextifneeded.md","title":"ParticipantContextIfNeeded"},{"filename":"participantloop.md","title":"ParticipantLoop"},{"filename":"participantname.md","title":"ParticipantName"},{"filename":"participanttile.md","title":"ParticipantTile"},{"filename":"prejoin.md","title":"PreJoin"},{"filename":"roomaudiorenderer.md","title":"RoomAudioRenderer"},{"filename":"roomcontext.md","title":"RoomContext"},{"filename":"roomname.md","title":"RoomName"},{"filename":"startaudio.md","title":"StartAudio"},{"filename":"startmediabutton.md","title":"StartMediaButton"},{"filename":"toast.md","title":"Toast"},{"filename":"trackloop.md","title":"TrackLoop"},{"filename":"trackmutedindicator.md","title":"TrackMutedIndicator"},{"filename":"trackrefcontext.md","title":"TrackRefContext"},{"filename":"tracktoggle.md","title":"TrackToggle"},{"filename":"videoconference.md","title":"VideoConference"},{"filename":"videotrack.md","title":"VideoTrack"},{"filename":"voiceassistantcontrolbar.md","title":"VoiceAssistantControlBar"}],"hooks":[{"filename":"useaudioplayback.md","title":"useAudioPlayback"},{"filename":"useaudiowaveform.md","title":"useAudioWaveform"},{"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":"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":"useisrecording.md","title":"useIsRecording"},{"filename":"useisspeaking.md","title":"useIsSpeaking"},{"filename":"usekrispnoisefilter.md","title":"useKrispNoiseFilter"},{"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":"useparticipantattribute.md","title":"useParticipantAttribute"},{"filename":"useparticipantattributes.md","title":"useParticipantAttributes"},{"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":"usesequentialroomconnectdisconnect.md","title":"useSequentialRoomConnectDisconnect"},{"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":"usetextstream.md","title":"useTextStream"},{"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":"usetranscriptions.md","title":"useTranscriptions"},{"filename":"usevisualstableupdate.md","title":"useVisualStableUpdate"},{"filename":"usevoiceassistant.md","title":"useVoiceAssistant"}]}
|
|
@@ -15,6 +15,12 @@ This feature is experimental and may change or be removed based on developer fee
|
|
|
15
15
|
|
|
16
16
|
{% /callout %}
|
|
17
17
|
|
|
18
|
+
{% callout type="caution" variation="normal" %}
|
|
19
|
+
|
|
20
|
+
This API is deprecated: Use useTranscription instead
|
|
21
|
+
|
|
22
|
+
{% /callout %}
|
|
23
|
+
|
|
18
24
|
**Signature:**
|
|
19
25
|
|
|
20
26
|
```typescript
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "UseSequentialRoomConnectDisconnectResults type",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useSequentialRoomConnectDisconnect.ts"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
# UseSequentialRoomConnectDisconnectResults type
|
|
11
|
+
|
|
12
|
+
**Signature:**
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
export type UseSequentialRoomConnectDisconnectResults<R extends Room | undefined> = {
|
|
16
|
+
connect: typeof Room.prototype.connect & (R extends undefined ? null : unknown);
|
|
17
|
+
disconnect: typeof Room.prototype.disconnect & (R extends undefined ? null : unknown);
|
|
18
|
+
};
|
|
19
|
+
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@livekit/components-js-docs",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.68",
|
|
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.9.
|
|
11
|
+
"@livekit/components-react": "2.9.15"
|
|
12
12
|
},
|
|
13
13
|
"author": "",
|
|
14
14
|
"license": "Apache-2.0",
|
|
@@ -19,8 +19,5 @@
|
|
|
19
19
|
"files": [
|
|
20
20
|
"generated-docs",
|
|
21
21
|
"meta-data.json"
|
|
22
|
-
]
|
|
23
|
-
"publishConfig": {
|
|
24
|
-
"access": "restricted"
|
|
25
|
-
}
|
|
22
|
+
]
|
|
26
23
|
}
|