@livekit/components-js-docs 0.1.52 → 0.1.53

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 (59) hide show
  1. package/generated-docs/core/createdataobserver.md +1 -1
  2. package/generated-docs/core/datatopic.md +1 -2
  3. package/generated-docs/core/index.md +3 -0
  4. package/generated-docs/core/{legacyreceivedchatmessage.ignore.md → legacychatmessage.ignorelegacy.md} +3 -3
  5. package/generated-docs/core/legacychatmessage.md +3 -3
  6. package/generated-docs/core/legacydatatopic.md +22 -0
  7. package/generated-docs/core/legacyreceivedchatmessage.ignorelegacy.md +13 -0
  8. package/generated-docs/core/legacyreceivedchatmessage.md +3 -3
  9. package/generated-docs/core/setupchat.md +1 -10
  10. package/generated-docs/core/setupchatmessagehandler.md +2 -1
  11. package/generated-docs/core/setupdatamessagehandler.md +1 -1
  12. package/generated-docs/core/setuptextstream.md +16 -0
  13. package/generated-docs/core/textstreamdata.md +24 -0
  14. package/generated-docs/core/textstreamdata.participantinfo.md +15 -0
  15. package/generated-docs/{react/receivedchatmessage.from.md → core/textstreamdata.streaminfo.md} +3 -3
  16. package/generated-docs/core/{legacychatmessage.ignore.md → textstreamdata.text.md} +3 -3
  17. package/generated-docs/react/audiotrackprops.md +6 -6
  18. package/generated-docs/react/audiovisualizerprops.md +3 -3
  19. package/generated-docs/react/barvisualizerprops.md +7 -7
  20. package/generated-docs/react/carousellayoutprops.md +5 -5
  21. package/generated-docs/react/chatentryprops.md +6 -6
  22. package/generated-docs/react/component/chat.md +16 -4
  23. package/generated-docs/react/focuslayoutprops.md +4 -4
  24. package/generated-docs/react/focustoggleprops.md +3 -3
  25. package/generated-docs/react/gridlayoutprops.md +4 -4
  26. package/generated-docs/react/hook/usechat.md +29 -8
  27. package/generated-docs/react/hook/usemediadeviceselect.md +1 -1
  28. package/generated-docs/react/hook/usetextstream.md +46 -0
  29. package/generated-docs/react/hook/usetrackbyname.md +1 -1
  30. package/generated-docs/react/hook/usetracktoggle.md +3 -1
  31. package/generated-docs/react/index.md +78 -89
  32. package/generated-docs/react/layoutcontextproviderprops.md +5 -5
  33. package/generated-docs/react/meta-data.json +1 -1
  34. package/generated-docs/react/participanttileprops.md +5 -5
  35. package/generated-docs/react/prejoinprops.md +13 -13
  36. package/generated-docs/react/trackloopprops.md +4 -4
  37. package/generated-docs/react/trackmutedindicatorprops.md +4 -4
  38. package/generated-docs/react/usefocustoggleprops.md +4 -4
  39. package/generated-docs/react/usekrispnoisefilteroptions.md +3 -3
  40. package/generated-docs/react/useparticipanttileprops.md +6 -6
  41. package/generated-docs/react/usepersistentuserchoicesoptions.md +5 -5
  42. package/generated-docs/react/usetrackshookreturntype.md +0 -2
  43. package/generated-docs/react/usevisualstableupdateoptions.md +3 -3
  44. package/generated-docs/react/videoconferenceprops.md +2 -2
  45. package/generated-docs/react/videotrackprops.md +6 -6
  46. package/generated-docs/react/voiceassistant.md +7 -7
  47. package/package.json +2 -2
  48. package/generated-docs/react/gridlayoutdefinition.md +0 -22
  49. package/generated-docs/react/localuserchoices.md +0 -24
  50. package/generated-docs/react/messagedecoder.md +0 -22
  51. package/generated-docs/react/messageencoder.md +0 -22
  52. package/generated-docs/react/participantidentifier.md +0 -28
  53. package/generated-docs/react/pinstate.md +0 -18
  54. package/generated-docs/react/receivedchatmessage.md +0 -24
  55. package/generated-docs/react/setlogextension.md +0 -21
  56. package/generated-docs/react/setloglevel.md +0 -18
  57. package/generated-docs/react/trackreference.md +0 -20
  58. package/generated-docs/react/trackreferenceorplaceholder.md +0 -18
  59. package/generated-docs/react/widgetstate.md +0 -20
package/generated-docs/react/index.md CHANGED
@@ -52,7 +52,7 @@
52
52
  | Prefab | Description |
53
53
  | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
54
54
  | [AudioConference({ ...props })](./react/component/audioconference.md) | This component is the default setup of a classic LiveKit audio conferencing app. It provides functionality like switching between participant grid view and focus view. |
55
- | [Chat({ messageFormatter, messageDecoder, messageEncoder, channelTopic, ...props })](./react/component/chat.md) | The Chat component adds a basis chat functionality to the LiveKit room. The messages are distributed to all participants in the room. Only users who are in the room at the time of dispatch will receive the message. |
55
+ | [Chat({ messageFormatter, messageDecoder, messageEncoder, channelTopic, ...props })](./react/component/chat.md) | The Chat component provides ready-to-use chat functionality in a LiveKit room. Messages are distributed to all participants in the room in real-time. |
56
56
  | [ControlBar({ variation, controls, saveUserChoices, onDeviceError, ...props })](./react/component/controlbar.md) | The <code>ControlBar</code> prefab gives the user the basic user interface to control their media devices (camera, microphone and screen share), open the <code>Chat</code> and leave the room. |
57
57
  | [MediaDeviceMenu({ kind, initialSelection, onActiveDeviceChange, tracks, requestPermissions, ...props })](./react/component/mediadevicemenu.md) | The <code>MediaDeviceMenu</code> component is a button that opens a menu that lists all media devices and allows the user to select them. |
58
58
  | [PreJoin({ defaults, onValidate, onSubmit, onError, debug, joinLabel, micLabel, camLabel, userLabel, persistUserChoices, videoProcessor, ...htmlProps })](./react/component/prejoin.md) | The <code>PreJoin</code> prefab component is normally presented to the user before he enters a room. This component allows the user to check and select the preferred media device (camera und microphone). On submit the user decisions are returned, which can then be passed on to the <code>LiveKitRoom</code> so that the user enters the room with the correct media devices. |
@@ -65,7 +65,7 @@
65
65
  | -------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
66
66
  | [useAudioPlayback(room)](./react/hook/useaudioplayback.md) | In many browsers to start audio playback, the user must perform a user-initiated event such as clicking a button. The <code>useAudioPlayback</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. |
67
67
  | [useAudioWaveform(trackOrTrackReference, options)](./react/hook/useaudiowaveform.md) | |
68
- | [useChat(options)](./react/hook/usechat.md) | The <code>useChat</code> hook provides chat functionality for a LiveKit room. It returns a simple <code>send</code> function to send chat messages and an array of <code>chatMessages</code> to hold received messages. It also returns a <code>update</code> function that allows you to implement message-edit functionality. |
68
+ | [useChat(options)](./react/hook/usechat.md) | The <code>useChat</code> hook provides chat functionality for a LiveKit room. |
69
69
  | [useChatToggle({ props })](./react/hook/usechattoggle.md) | The <code>useChatToggle</code> hook provides state and functions for toggling the chat window. |
70
70
  | [useClearPinButton(props)](./react/hook/useclearpinbutton.md) | The <code>useClearPinButton</code> hook provides props for the [ClearPinButton()](./react/component/clearpinbutton.md) or your custom implementation of it component. It adds the <code>onClick</code> handler to signal the <code>LayoutContext</code> that the tile in focus should be cleared. |
71
71
  | [useConnectionQualityIndicator(options)](./react/hook/useconnectionqualityindicator.md) | The <code>useConnectionQualityIndicator</code> hook provides props for the <code>ConnectionQualityIndicator</code> or your custom implementation of it component. |
@@ -121,6 +121,7 @@
121
121
  | [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. |
122
122
  | [useStartVideo({ room, props })](./react/hook/usestartvideo.md) | In some browsers to start video playback in low power mode, the user must perform a user-initiated event such as clicking a button. The <code>useStartVideo</code> hook returns an object with a boolean <code>canPlayVideo</code> flag that indicates whether video playback is allowed in the current context, as well as a <code>startVideo</code> function that can be called in a button <code>onClick</code> callback to start video playback in the current context. |
123
123
  | [useSwipe(element, options)](./react/hook/useswipe.md) | Simple implementation to detect horizontal swipe actions. Accepts callbacks for on right and left swipes. |
124
+ | [useTextStream(topic)](./react/hook/usetextstream.md) | **_(BETA)_** |
124
125
  | [useToken(tokenEndpoint, roomName, options)](./react/hook/usetoken.md) | The <code>useToken</code> hook fetches a token from the given token endpoint with the given user info. |
125
126
  | [useTrackByName(name, participant)](./react/hook/usetrackbyname.md) | This function <code>useTrackByName</code> allows you to access a track by referencing its track name. Inside the function, it ensures that the a valid <code>participant</code> reference is available by checking for both a passed participant argument and, if not available, a valid participant context. |
126
127
  | [useTrackMutedIndicator(trackRef)](./react/hook/usetrackmutedindicator.md) | The <code>useTrackMutedIndicator</code> hook is used to implement the <code>TrackMutedIndicator</code> component and returns the muted state of the given track. |
@@ -134,90 +135,78 @@
134
135
 
135
136
  ## Others
136
137
 
137
- | Other | Description |
138
- | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
139
- | [AgentState](./react/agentstate.md) | **_(BETA)_** |
140
- | [AllowAudioPlaybackProps](./react/allowaudioplaybackprops.md) | |
141
- | [AllowMediaPlaybackProps](./react/allowmediaplaybackprops.md) | |
142
- | [AudioConferenceProps](./react/audioconferenceprops.md) | |
143
- | [AudioTrackProps](./react/audiotrackprops.md) | |
144
- | [AudioVisualizerProps](./react/audiovisualizerprops.md) | |
145
- | [AudioWaveformOptions](./react/audiowaveformoptions.md) | |
146
- | [BarVisualizerOptions](./react/barvisualizeroptions.md) | **_(BETA)_** |
147
- | [BarVisualizerProps](./react/barvisualizerprops.md) | **_(BETA)_** |
148
- | [CarouselLayoutProps](./react/carousellayoutprops.md) | |
149
- | [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: |
150
- | [ChatProps](./react/chatprops.md) | |
151
- | [ChatToggleProps](./react/chattoggleprops.md) | |
152
- | [ClearPinButtonProps](./react/clearpinbuttonprops.md) | |
153
- | [ConnectionQualityIndicatorOptions](./react/connectionqualityindicatoroptions.md) | |
154
- | [ConnectionQualityIndicatorProps](./react/connectionqualityindicatorprops.md) | |
155
- | [ConnectionStateToastProps](./react/connectionstatetoastprops.md) | |
156
- | [ConnectionStatusProps](./react/connectionstatusprops.md) | |
157
- | [ControlBarControls](./react/controlbarcontrols.md) | |
158
- | [ControlBarProps](./react/controlbarprops.md) | |
159
- | [DisconnectButtonProps](./react/disconnectbuttonprops.md) | |
160
- | [FocusLayoutContainerProps](./react/focuslayoutcontainerprops.md) | |
161
- | [FocusLayoutProps](./react/focuslayoutprops.md) | |
162
- | [FocusToggleProps](./react/focustoggleprops.md) | |
163
- | [formatChatMessageLinks(message)](./react/formatchatmessagelinks.md) | |
164
- | [GridLayoutDefinition](./react/gridlayoutdefinition.md) | |
165
- | [GridLayoutProps](./react/gridlayoutprops.md) | |
166
- | [LayoutContextProviderProps](./react/layoutcontextproviderprops.md) | |
167
- | [LayoutContextType](./react/layoutcontexttype.md) | |
168
- | [LiveKitRoomProps](./react/livekitroomprops.md) | |
169
- | [LocalUserChoices](./react/localuserchoices.md) | Represents the user's choices for video and audio input devices, as well as their username. |
170
- | [MediaDeviceMenuProps](./react/mediadevicemenuprops.md) | |
171
- | [MediaDeviceSelectProps](./react/mediadeviceselectprops.md) | |
172
- | [MessageDecoder](./react/messagedecoder.md) | |
173
- | [MessageEncoder](./react/messageencoder.md) | |
174
- | [MessageFormatter](./react/messageformatter.md) | |
175
- | [MultiBandTrackVolumeOptions](./react/multibandtrackvolumeoptions.md) | Interface for configuring options for the useMultibandTrackVolume hook. |
176
- | [ParticipantIdentifier](./react/participantidentifier.md) | **_(BETA)_** |
177
- | [ParticipantLoopProps](./react/participantloopprops.md) | |
178
- | [ParticipantNameProps](./react/participantnameprops.md) | |
179
- | [ParticipantTileProps](./react/participanttileprops.md) | |
180
- | [PinState](./react/pinstate.md) | |
181
- | [PreJoinProps](./react/prejoinprops.md) | Props for the PreJoin component. |
182
- | [ReceivedChatMessage](./react/receivedchatmessage.md) | |
183
- | [RoomAudioRendererProps](./react/roomaudiorendererprops.md) | |
184
- | [RoomNameProps](./react/roomnameprops.md) | |
185
- | [setLogExtension(extension, options)](./react/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. |
186
- | [setLogLevel(level, options)](./react/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. |
187
- | [TrackLoopProps](./react/trackloopprops.md) | |
188
- | [TrackMutedIndicatorProps](./react/trackmutedindicatorprops.md) | |
189
- | [TrackReference](./react/trackreference.md) | |
190
- | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | |
191
- | [TrackToggleProps](./react/tracktoggleprops.md) | |
192
- | [TrackTranscriptionOptions](./react/tracktranscriptionoptions.md) | |
193
- | [UseChatToggleProps](./react/usechattoggleprops.md) | |
194
- | [UseFocusToggleProps](./react/usefocustoggleprops.md) | |
195
- | [UseIsEncryptedOptions](./react/useisencryptedoptions.md) | |
196
- | [UseIsMutedOptions](./react/useismutedoptions.md) | |
197
- | [useKrispNoiseFilterOptions](./react/usekrispnoisefilteroptions.md) | **_(BETA)_** |
198
- | [UseLocalParticipantOptions](./react/uselocalparticipantoptions.md) | |
199
- | [UseMediaDeviceSelectProps](./react/usemediadeviceselectprops.md) | |
200
- | [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>. |
201
- | [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>. |
202
- | [UseParticipantPermissionsOptions](./react/useparticipantpermissionsoptions.md) | The <code>useParticipantPermissions</code> hook returns the permissions of a given participant. |
203
- | [UseParticipantsOptions](./react/useparticipantsoptions.md) | |
204
- | [UseParticipantTileProps](./react/useparticipanttileprops.md) | |
205
- | [UsePersistentUserChoicesOptions](./react/usepersistentuserchoicesoptions.md) | Options for the <code>usePersistentDeviceSettings</code> hook. |
206
- | [UseRemoteParticipantOptions](./react/useremoteparticipantoptions.md) | |
207
- | [UseRemoteParticipantsOptions](./react/useremoteparticipantsoptions.md) | |
208
- | [UserInfo](./react/userinfo.md) | |
209
- | [UseRoomInfoOptions](./react/useroominfooptions.md) | The <code>useRoomInfo</code> hook returns the name and metadata of the given <code>Room</code>. |
210
- | [UseStartAudioProps](./react/usestartaudioprops.md) | |
211
- | [UseStartVideoProps](./react/usestartvideoprops.md) | |
212
- | [UseSwipeOptions](./react/useswipeoptions.md) | |
213
- | [UseTokenOptions](./react/usetokenoptions.md) | |
214
- | [UseTracksHookReturnType](./react/usetrackshookreturntype.md) | |
215
- | [UseTracksOptions](./react/usetracksoptions.md) | |
216
- | [UseTrackToggleProps](./react/usetracktoggleprops.md) | |
217
- | [UseVisualStableUpdateOptions](./react/usevisualstableupdateoptions.md) | |
218
- | [VideoConferenceProps](./react/videoconferenceprops.md) | |
219
- | [VideoTrackProps](./react/videotrackprops.md) | |
220
- | [VoiceAssistant](./react/voiceassistant.md) | **_(BETA)_** |
221
- | [VoiceAssistantControlBarControls](./react/voiceassistantcontrolbarcontrols.md) | **_(BETA)_** |
222
- | [VoiceAssistantControlBarProps](./react/voiceassistantcontrolbarprops.md) | **_(BETA)_** |
223
- | [WidgetState](./react/widgetstate.md) | |
138
+ | Other | Description |
139
+ | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
140
+ | [AgentState](./react/agentstate.md) | **_(BETA)_** |
141
+ | [AllowAudioPlaybackProps](./react/allowaudioplaybackprops.md) | |
142
+ | [AllowMediaPlaybackProps](./react/allowmediaplaybackprops.md) | |
143
+ | [AudioConferenceProps](./react/audioconferenceprops.md) | |
144
+ | [AudioTrackProps](./react/audiotrackprops.md) | |
145
+ | [AudioVisualizerProps](./react/audiovisualizerprops.md) | |
146
+ | [AudioWaveformOptions](./react/audiowaveformoptions.md) | |
147
+ | [BarVisualizerOptions](./react/barvisualizeroptions.md) | **_(BETA)_** |
148
+ | [BarVisualizerProps](./react/barvisualizerprops.md) | **_(BETA)_** |
149
+ | [CarouselLayoutProps](./react/carousellayoutprops.md) | |
150
+ | [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: |
151
+ | [ChatProps](./react/chatprops.md) | |
152
+ | [ChatToggleProps](./react/chattoggleprops.md) | |
153
+ | [ClearPinButtonProps](./react/clearpinbuttonprops.md) | |
154
+ | [ConnectionQualityIndicatorOptions](./react/connectionqualityindicatoroptions.md) | |
155
+ | [ConnectionQualityIndicatorProps](./react/connectionqualityindicatorprops.md) | |
156
+ | [ConnectionStateToastProps](./react/connectionstatetoastprops.md) | |
157
+ | [ConnectionStatusProps](./react/connectionstatusprops.md) | |
158
+ | [ControlBarControls](./react/controlbarcontrols.md) | |
159
+ | [ControlBarProps](./react/controlbarprops.md) | |
160
+ | [DisconnectButtonProps](./react/disconnectbuttonprops.md) | |
161
+ | [FocusLayoutContainerProps](./react/focuslayoutcontainerprops.md) | |
162
+ | [FocusLayoutProps](./react/focuslayoutprops.md) | |
163
+ | [FocusToggleProps](./react/focustoggleprops.md) | |
164
+ | [formatChatMessageLinks(message)](./react/formatchatmessagelinks.md) | |
165
+ | [GridLayoutProps](./react/gridlayoutprops.md) | |
166
+ | [LayoutContextProviderProps](./react/layoutcontextproviderprops.md) | |
167
+ | [LayoutContextType](./react/layoutcontexttype.md) | |
168
+ | [LiveKitRoomProps](./react/livekitroomprops.md) | |
169
+ | [MediaDeviceMenuProps](./react/mediadevicemenuprops.md) | |
170
+ | [MediaDeviceSelectProps](./react/mediadeviceselectprops.md) | |
171
+ | [MessageFormatter](./react/messageformatter.md) | |
172
+ | [MultiBandTrackVolumeOptions](./react/multibandtrackvolumeoptions.md) | Interface for configuring options for the useMultibandTrackVolume hook. |
173
+ | [ParticipantLoopProps](./react/participantloopprops.md) | |
174
+ | [ParticipantNameProps](./react/participantnameprops.md) | |
175
+ | [ParticipantTileProps](./react/participanttileprops.md) | |
176
+ | [PreJoinProps](./react/prejoinprops.md) | Props for the PreJoin component. |
177
+ | [RoomAudioRendererProps](./react/roomaudiorendererprops.md) | |
178
+ | [RoomNameProps](./react/roomnameprops.md) | |
179
+ | [TrackLoopProps](./react/trackloopprops.md) | |
180
+ | [TrackMutedIndicatorProps](./react/trackmutedindicatorprops.md) | |
181
+ | [TrackToggleProps](./react/tracktoggleprops.md) | |
182
+ | [TrackTranscriptionOptions](./react/tracktranscriptionoptions.md) | |
183
+ | [UseChatToggleProps](./react/usechattoggleprops.md) | |
184
+ | [UseFocusToggleProps](./react/usefocustoggleprops.md) | |
185
+ | [UseIsEncryptedOptions](./react/useisencryptedoptions.md) | |
186
+ | [UseIsMutedOptions](./react/useismutedoptions.md) | |
187
+ | [useKrispNoiseFilterOptions](./react/usekrispnoisefilteroptions.md) | **_(BETA)_** |
188
+ | [UseLocalParticipantOptions](./react/uselocalparticipantoptions.md) | |
189
+ | [UseMediaDeviceSelectProps](./react/usemediadeviceselectprops.md) | |
190
+ | [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>. |
191
+ | [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>. |
192
+ | [UseParticipantPermissionsOptions](./react/useparticipantpermissionsoptions.md) | The <code>useParticipantPermissions</code> hook returns the permissions of a given participant. |
193
+ | [UseParticipantsOptions](./react/useparticipantsoptions.md) | |
194
+ | [UseParticipantTileProps](./react/useparticipanttileprops.md) | |
195
+ | [UsePersistentUserChoicesOptions](./react/usepersistentuserchoicesoptions.md) | Options for the <code>usePersistentDeviceSettings</code> hook. |
196
+ | [UseRemoteParticipantOptions](./react/useremoteparticipantoptions.md) | |
197
+ | [UseRemoteParticipantsOptions](./react/useremoteparticipantsoptions.md) | |
198
+ | [UserInfo](./react/userinfo.md) | |
199
+ | [UseRoomInfoOptions](./react/useroominfooptions.md) | The <code>useRoomInfo</code> hook returns the name and metadata of the given <code>Room</code>. |
200
+ | [UseStartAudioProps](./react/usestartaudioprops.md) | |
201
+ | [UseStartVideoProps](./react/usestartvideoprops.md) | |
202
+ | [UseSwipeOptions](./react/useswipeoptions.md) | |
203
+ | [UseTokenOptions](./react/usetokenoptions.md) | |
204
+ | [UseTracksHookReturnType](./react/usetrackshookreturntype.md) | |
205
+ | [UseTracksOptions](./react/usetracksoptions.md) | |
206
+ | [UseTrackToggleProps](./react/usetracktoggleprops.md) | |
207
+ | [UseVisualStableUpdateOptions](./react/usevisualstableupdateoptions.md) | |
208
+ | [VideoConferenceProps](./react/videoconferenceprops.md) | |
209
+ | [VideoTrackProps](./react/videotrackprops.md) | |
210
+ | [VoiceAssistant](./react/voiceassistant.md) | **_(BETA)_** |
211
+ | [VoiceAssistantControlBarControls](./react/voiceassistantcontrolbarcontrols.md) | **_(BETA)_** |
212
+ | [VoiceAssistantControlBarProps](./react/voiceassistantcontrolbarprops.md) | **_(BETA)_** |
package/generated-docs/react/layoutcontextproviderprops.md CHANGED
@@ -23,8 +23,8 @@ export interface LayoutContextProviderProps
23
23
 
24
24
  ## Properties
25
25
 
26
- | Property | Type | Description |
27
- | ----------------------------------------------------------------------- | ----------------------------------------------------------------- | ------------ |
28
- | [onPinChange?](./react/layoutcontextproviderprops.onpinchange.md) | (state: [PinState](./react/pinstate.md)<!-- -->) =&gt; void | _(Optional)_ |
29
- | [onWidgetChange?](./react/layoutcontextproviderprops.onwidgetchange.md) | (state: [WidgetState](./react/widgetstate.md)<!-- -->) =&gt; void | _(Optional)_ |
30
- | [value?](./react/layoutcontextproviderprops.value.md) | [LayoutContextType](./react/layoutcontexttype.md) | _(Optional)_ |
26
+ | Property | Type | Description |
27
+ | ----------------------------------------------------------------------- | ------------------------------------------------- | ------------ |
28
+ | [onPinChange?](./react/layoutcontextproviderprops.onpinchange.md) | (state: PinState) =&gt; void | _(Optional)_ |
29
+ | [onWidgetChange?](./react/layoutcontextproviderprops.onwidgetchange.md) | (state: WidgetState) =&gt; void | _(Optional)_ |
30
+ | [value?](./react/layoutcontextproviderprops.value.md) | [LayoutContextType](./react/layoutcontexttype.md) | _(Optional)_ |
package/generated-docs/react/meta-data.json CHANGED
@@ -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":"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":"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":"useremoteparticipant_1.md","title":"useRemoteParticipant"},{"filename":"useremoteparticipants.md","title":"useRemoteParticipants"},{"filename":"useroomcontext.md","title":"useRoomContext"},{"filename":"useroominfo.md","title":"useRoomInfo"},{"filename":"usesortedparticipants.md","title":"useSortedParticipants"},{"filename":"usespeakingparticipants.md","title":"useSpeakingParticipants"},{"filename":"usestartaudio.md","title":"useStartAudio"},{"filename":"usestartvideo.md","title":"useStartVideo"},{"filename":"useswipe.md","title":"useSwipe"},{"filename":"usetoken.md","title":"useToken"},{"filename":"usetrackbyname.md","title":"useTrackByName"},{"filename":"usetrackmutedindicator.md","title":"useTrackMutedIndicator"},{"filename":"usetrackrefcontext.md","title":"useTrackRefContext"},{"filename":"usetracks.md","title":"useTracks"},{"filename":"usetracktoggle.md","title":"useTrackToggle"},{"filename":"usetracktranscription.md","title":"useTrackTranscription"},{"filename":"usetrackvolume.md","title":"useTrackVolume"},{"filename":"usevisualstableupdate.md","title":"useVisualStableUpdate"},{"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":"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":"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":"useremoteparticipant_1.md","title":"useRemoteParticipant"},{"filename":"useremoteparticipants.md","title":"useRemoteParticipants"},{"filename":"useroomcontext.md","title":"useRoomContext"},{"filename":"useroominfo.md","title":"useRoomInfo"},{"filename":"usesortedparticipants.md","title":"useSortedParticipants"},{"filename":"usespeakingparticipants.md","title":"useSpeakingParticipants"},{"filename":"usestartaudio.md","title":"useStartAudio"},{"filename":"usestartvideo.md","title":"useStartVideo"},{"filename":"useswipe.md","title":"useSwipe"},{"filename":"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":"usevisualstableupdate.md","title":"useVisualStableUpdate"},{"filename":"usevoiceassistant.md","title":"useVoiceAssistant"}]}
package/generated-docs/react/participanttileprops.md CHANGED
@@ -19,8 +19,8 @@ export interface ParticipantTileProps extends React.HTMLAttributes<HTMLDivElemen
19
19
 
20
20
  ## Properties
21
21
 
22
- | Property | Type | Description |
23
- | ------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -------------------------------------------- |
24
- | [disableSpeakingIndicator?](./react/participanttileprops.disablespeakingindicator.md) | boolean | _(Optional)_ |
25
- | [onParticipantClick?](./react/participanttileprops.onparticipantclick.md) | (event: ParticipantClickEvent) =&gt; void | _(Optional)_ |
26
- | [trackRef?](./react/participanttileprops.trackref.md) | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | _(Optional)_ The track reference to display. |
22
+ | Property | Type | Description |
23
+ | ------------------------------------------------------------------------------------- | ----------------------------------------- | -------------------------------------------- |
24
+ | [disableSpeakingIndicator?](./react/participanttileprops.disablespeakingindicator.md) | boolean | _(Optional)_ |
25
+ | [onParticipantClick?](./react/participanttileprops.onparticipantclick.md) | (event: ParticipantClickEvent) =&gt; void | _(Optional)_ |
26
+ | [trackRef?](./react/participanttileprops.trackref.md) | TrackReferenceOrPlaceholder | _(Optional)_ The track reference to display. |
package/generated-docs/react/prejoinprops.md CHANGED
@@ -21,16 +21,16 @@ export interface PreJoinProps extends Omit<React.HTMLAttributes<HTMLDivElement>,
21
21
 
22
22
  ## Properties
23
23
 
24
- | Property | Type | Description |
25
- | ----------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
26
- | [camLabel?](./react/prejoinprops.camlabel.md) | string | _(Optional)_ |
27
- | [debug?](./react/prejoinprops.debug.md) | boolean | _(Optional)_ Display a debug window for your convenience. |
28
- | [defaults?](./react/prejoinprops.defaults.md) | Partial&lt;[LocalUserChoices](./react/localuserchoices.md)<!-- -->&gt; | _(Optional)_ Prefill the input form with initial values. |
29
- | [joinLabel?](./react/prejoinprops.joinlabel.md) | string | _(Optional)_ |
30
- | [micLabel?](./react/prejoinprops.miclabel.md) | string | _(Optional)_ |
31
- | [onError?](./react/prejoinprops.onerror.md) | (error: Error) =&gt; void | _(Optional)_ |
32
- | [onSubmit?](./react/prejoinprops.onsubmit.md) | (values: [LocalUserChoices](./react/localuserchoices.md)<!-- -->) =&gt; void | _(Optional)_ This function is called with the <code>LocalUserChoices</code> if validation is passed. |
33
- | [onValidate?](./react/prejoinprops.onvalidate.md) | (values: [LocalUserChoices](./react/localuserchoices.md)<!-- -->) =&gt; boolean | _(Optional)_ Provide your custom validation function. Only if validation is successful the user choices are past to the onSubmit callback. |
34
- | [persistUserChoices?](./react/prejoinprops.persistuserchoices.md) | boolean | _(Optional)_ If true, user choices are persisted across sessions. |
35
- | [userLabel?](./react/prejoinprops.userlabel.md) | string | _(Optional)_ |
36
- | [videoProcessor?](./react/prejoinprops.videoprocessor.md) | TrackProcessor&lt;Track.Kind.Video&gt; | _(Optional)_ |
24
+ | Property | Type | Description |
25
+ | ----------------------------------------------------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
26
+ | [camLabel?](./react/prejoinprops.camlabel.md) | string | _(Optional)_ |
27
+ | [debug?](./react/prejoinprops.debug.md) | boolean | _(Optional)_ Display a debug window for your convenience. |
28
+ | [defaults?](./react/prejoinprops.defaults.md) | Partial&lt;LocalUserChoices&gt; | _(Optional)_ Prefill the input form with initial values. |
29
+ | [joinLabel?](./react/prejoinprops.joinlabel.md) | string | _(Optional)_ |
30
+ | [micLabel?](./react/prejoinprops.miclabel.md) | string | _(Optional)_ |
31
+ | [onError?](./react/prejoinprops.onerror.md) | (error: Error) =&gt; void | _(Optional)_ |
32
+ | [onSubmit?](./react/prejoinprops.onsubmit.md) | (values: LocalUserChoices) =&gt; void | _(Optional)_ This function is called with the <code>LocalUserChoices</code> if validation is passed. |
33
+ | [onValidate?](./react/prejoinprops.onvalidate.md) | (values: LocalUserChoices) =&gt; boolean | _(Optional)_ Provide your custom validation function. Only if validation is successful the user choices are past to the onSubmit callback. |
34
+ | [persistUserChoices?](./react/prejoinprops.persistuserchoices.md) | boolean | _(Optional)_ If true, user choices are persisted across sessions. |
35
+ | [userLabel?](./react/prejoinprops.userlabel.md) | string | _(Optional)_ |
36
+ | [videoProcessor?](./react/prejoinprops.videoprocessor.md) | TrackProcessor&lt;Track.Kind.Video&gt; | _(Optional)_ |
package/generated-docs/react/trackloopprops.md CHANGED
@@ -17,7 +17,7 @@ export interface TrackLoopProps
17
17
 
18
18
  ## Properties
19
19
 
20
- | Property | Type | Description |
21
- | ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
22
- | [children](./react/trackloopprops.children.md) | React.ReactNode | The template component to be used in the loop. |
23
- | [tracks](./react/trackloopprops.tracks.md) | [TrackReference](./react/trackreference.md)<!-- -->\[\] \| [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md)<!-- -->\[\] | Track references to loop over. You can the use <code>useTracks()</code> hook to get TrackReferences. |
20
+ | Property | Type | Description |
21
+ | ---------------------------------------------- | ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
22
+ | [children](./react/trackloopprops.children.md) | React.ReactNode | The template component to be used in the loop. |
23
+ | [tracks](./react/trackloopprops.tracks.md) | TrackReference\[\] \| TrackReferenceOrPlaceholder\[\] | Track references to loop over. You can the use <code>useTracks()</code> hook to get TrackReferences. |
package/generated-docs/react/trackmutedindicatorprops.md CHANGED
@@ -19,7 +19,7 @@ export interface TrackMutedIndicatorProps extends React.HTMLAttributes<HTMLDivEl
19
19
 
20
20
  ## Properties
21
21
 
22
- | Property | Type | Description |
23
- | -------------------------------------------------------- | --------------------------------------------------------------------- | ------------ |
24
- | [show?](./react/trackmutedindicatorprops.show.md) | 'always' \| 'muted' \| 'unmuted' | _(Optional)_ |
25
- | [trackRef](./react/trackmutedindicatorprops.trackref.md) | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | |
22
+ | Property | Type | Description |
23
+ | -------------------------------------------------------- | -------------------------------- | ------------ |
24
+ | [show?](./react/trackmutedindicatorprops.show.md) | 'always' \| 'muted' \| 'unmuted' | _(Optional)_ |
25
+ | [trackRef](./react/trackmutedindicatorprops.trackref.md) | TrackReferenceOrPlaceholder | |
package/generated-docs/react/usefocustoggleprops.md CHANGED
@@ -17,7 +17,7 @@ export interface UseFocusToggleProps
17
17
 
18
18
  ## Properties
19
19
 
20
- | Property | Type | Description |
21
- | ---------------------------------------------------- | --------------------------------------------------------------------- | ------------ |
22
- | [props](./react/usefocustoggleprops.props.md) | React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt; | |
23
- | [trackRef?](./react/usefocustoggleprops.trackref.md) | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | _(Optional)_ |
20
+ | Property | Type | Description |
21
+ | ---------------------------------------------------- | --------------------------------------------------- | ------------ |
22
+ | [props](./react/usefocustoggleprops.props.md) | React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt; | |
23
+ | [trackRef?](./react/usefocustoggleprops.trackref.md) | TrackReferenceOrPlaceholder | _(Optional)_ |
package/generated-docs/react/usekrispnoisefilteroptions.md CHANGED
@@ -23,6 +23,6 @@ export interface useKrispNoiseFilterOptions
23
23
 
24
24
  ## Properties
25
25
 
26
- | Property | Type | Description |
27
- | ----------------------------------------------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
28
- | [trackRef?](./react/usekrispnoisefilteroptions.trackref.md) | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | **_(BETA)_** _(Optional)_ The track reference to use for the noise filter (defaults: local microphone track) |
26
+ | Property | Type | Description |
27
+ | ----------------------------------------------------------- | --------------------------- | ------------------------------------------------------------------------------------------------------------ |
28
+ | [trackRef?](./react/usekrispnoisefilteroptions.trackref.md) | TrackReferenceOrPlaceholder | **_(BETA)_** _(Optional)_ The track reference to use for the noise filter (defaults: local microphone track) |
package/generated-docs/react/useparticipanttileprops.md CHANGED
@@ -19,9 +19,9 @@ export interface UseParticipantTileProps<T extends HTMLElement> extends React.HT
19
19
 
20
20
  ## Properties
21
21
 
22
- | Property | Type | Description |
23
- | ---------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -------------------------------------------- |
24
- | [disableSpeakingIndicator?](./react/useparticipanttileprops.disablespeakingindicator.md) | boolean | _(Optional)_ |
25
- | [htmlProps](./react/useparticipanttileprops.htmlprops.md) | React.HTMLAttributes&lt;T&gt; | |
26
- | [onParticipantClick?](./react/useparticipanttileprops.onparticipantclick.md) | (event: ParticipantClickEvent) =&gt; void | _(Optional)_ |
27
- | [trackRef?](./react/useparticipanttileprops.trackref.md) | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | _(Optional)_ The track reference to display. |
22
+ | Property | Type | Description |
23
+ | ---------------------------------------------------------------------------------------- | ----------------------------------------- | -------------------------------------------- |
24
+ | [disableSpeakingIndicator?](./react/useparticipanttileprops.disablespeakingindicator.md) | boolean | _(Optional)_ |
25
+ | [htmlProps](./react/useparticipanttileprops.htmlprops.md) | React.HTMLAttributes&lt;T&gt; | |
26
+ | [onParticipantClick?](./react/useparticipanttileprops.onparticipantclick.md) | (event: ParticipantClickEvent) =&gt; void | _(Optional)_ |
27
+ | [trackRef?](./react/useparticipanttileprops.trackref.md) | TrackReferenceOrPlaceholder | _(Optional)_ The track reference to display. |
package/generated-docs/react/usepersistentuserchoicesoptions.md CHANGED
@@ -25,8 +25,8 @@ export interface UsePersistentUserChoicesOptions
25
25
 
26
26
  ## Properties
27
27
 
28
- | Property | Type | Description |
29
- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
30
- | [defaults?](./react/usepersistentuserchoicesoptions.defaults.md) | Partial&lt;[LocalUserChoices](./react/localuserchoices.md)<!-- -->&gt; | _(Optional)_ The default value to use if reading from local storage returns no results or fails. |
31
- | [preventLoad?](./react/usepersistentuserchoicesoptions.preventload.md) | boolean | _(Optional)_ Whether to prevent loading user choices from persistent storage and use <code>defaults</code> instead. |
32
- | [preventSave?](./react/usepersistentuserchoicesoptions.preventsave.md) | boolean | _(Optional)_ Whether to prevent saving to persistent storage. |
28
+ | Property | Type | Description |
29
+ | ---------------------------------------------------------------------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
30
+ | [defaults?](./react/usepersistentuserchoicesoptions.defaults.md) | Partial&lt;LocalUserChoices&gt; | _(Optional)_ The default value to use if reading from local storage returns no results or fails. |
31
+ | [preventLoad?](./react/usepersistentuserchoicesoptions.preventload.md) | boolean | _(Optional)_ Whether to prevent loading user choices from persistent storage and use <code>defaults</code> instead. |
32
+ | [preventSave?](./react/usepersistentuserchoicesoptions.preventsave.md) | boolean | _(Optional)_ Whether to prevent saving to persistent storage. |
package/generated-docs/react/usetrackshookreturntype.md CHANGED
@@ -18,5 +18,3 @@ export type UseTracksHookReturnType<T> = T extends Track.Source[]
18
18
  ? TrackReferenceOrPlaceholder[]
19
19
  : never;
20
20
  ```
21
-
22
- **References:** [TrackReference](./react/trackreference.md)<!-- -->, [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md)
package/generated-docs/react/usevisualstableupdateoptions.md CHANGED
@@ -17,6 +17,6 @@ export interface UseVisualStableUpdateOptions
17
17
 
18
18
  ## Properties
19
19
 
20
- | Property | Type | Description |
21
- | --------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
22
- | [customSortFunction?](./react/usevisualstableupdateoptions.customsortfunction.md) | (trackReferences: [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md)<!-- -->\[\]) =&gt; [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md)<!-- -->\[\] | _(Optional)_ Overwrites the default sort function. |
20
+ | Property | Type | Description |
21
+ | --------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | -------------------------------------------------- |
22
+ | [customSortFunction?](./react/usevisualstableupdateoptions.customsortfunction.md) | (trackReferences: TrackReferenceOrPlaceholder\[\]) =&gt; TrackReferenceOrPlaceholder\[\] | _(Optional)_ Overwrites the default sort function. |
package/generated-docs/react/videoconferenceprops.md CHANGED
@@ -21,7 +21,7 @@ export interface VideoConferenceProps extends React.HTMLAttributes<HTMLDivElemen
21
21
 
22
22
  | Property | Type | Description |
23
23
  | ----------------------------------------------------------------------------- | ----------------------------------------------- | ------------ |
24
- | [chatMessageDecoder?](./react/videoconferenceprops.chatmessagedecoder.md) | [MessageDecoder](./react/messagedecoder.md) | _(Optional)_ |
25
- | [chatMessageEncoder?](./react/videoconferenceprops.chatmessageencoder.md) | [MessageEncoder](./react/messageencoder.md) | _(Optional)_ |
24
+ | [chatMessageDecoder?](./react/videoconferenceprops.chatmessagedecoder.md) | MessageDecoder | _(Optional)_ |
25
+ | [chatMessageEncoder?](./react/videoconferenceprops.chatmessageencoder.md) | MessageEncoder | _(Optional)_ |
26
26
  | [chatMessageFormatter?](./react/videoconferenceprops.chatmessageformatter.md) | [MessageFormatter](./react/messageformatter.md) | _(Optional)_ |
27
27
  | [SettingsComponent?](./react/videoconferenceprops.settingscomponent.md) | React.ComponentType | _(Optional)_ |