@livekit/components-js-docs 0.1.1 → 0.1.3

package/generated-docs/react/layoutcontextproviderprops.md

@@ -0,0 +1,26 @@
+---
+{
+  "title": "LayoutContextProviderProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/layout/LayoutContextProvider.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# LayoutContextProviderProps interface
+
+**Signature:**
+
+```typescript
+export interface LayoutContextProviderProps
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+| Property                                                                | Type                                                              | Description  |
+| ----------------------------------------------------------------------- | ----------------------------------------------------------------- | ------------ |
+| [onPinChange?](./react/layoutcontextproviderprops.onpinchange.md)       | (state: [PinState](./react/pinstate.md)<!-- -->) =&gt; void       | _(Optional)_ |
+| [onWidgetChange?](./react/layoutcontextproviderprops.onwidgetchange.md) | (state: [WidgetState](./react/widgetstate.md)<!-- -->) =&gt; void | _(Optional)_ |
+| [value?](./react/layoutcontextproviderprops.value.md)                   | [LayoutContextType](./react/layoutcontexttype.md)                 | _(Optional)_ |

package/generated-docs/react/layoutcontextproviderprops.onpinchange.md

@@ -0,0 +1,13 @@
+---
+{ "title": "LayoutContextProviderProps.onPinChange property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# LayoutContextProviderProps.onPinChange property
+
+**Signature:**
+
+```typescript
+onPinChange?: (state: PinState) => void;
+```

package/generated-docs/react/layoutcontextproviderprops.onwidgetchange.md

@@ -0,0 +1,13 @@
+---
+{ "title": "LayoutContextProviderProps.onWidgetChange property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# LayoutContextProviderProps.onWidgetChange property
+
+**Signature:**
+
+```typescript
+onWidgetChange?: (state: WidgetState) => void;
+```

package/generated-docs/react/layoutcontextproviderprops.value.md

@@ -0,0 +1,13 @@
+---
+{ "title": "LayoutContextProviderProps.value property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# LayoutContextProviderProps.value property
+
+**Signature:**
+
+```typescript
+value?: LayoutContextType;
+```

package/generated-docs/react/livekitroomprops.md

@@ -28,6 +28,7 @@ export interface LiveKitRoomProps extends Omit<React.HTMLAttributes<HTMLDivEleme
 | [connectOptions?](./react/livekitroomprops.connectoptions.md)             | RoomConnectOptions                        | _(Optional)_ Define options how to connect to the LiveKit server.                                                                                                                                                                                                                                             |
 | [onConnected?](./react/livekitroomprops.onconnected.md)                   | () =&gt; void                             | _(Optional)_                                                                                                                                                                                                                                                                                                  |
 | [onDisconnected?](./react/livekitroomprops.ondisconnected.md)             | () =&gt; void                             | _(Optional)_                                                                                                                                                                                                                                                                                                  |
+| [onEncryptionError?](./react/livekitroomprops.onencryptionerror.md)       | (error: Error) =&gt; void                 | _(Optional)_                                                                                                                                                                                                                                                                                                  |
 | [onError?](./react/livekitroomprops.onerror.md)                           | (error: Error) =&gt; void                 | _(Optional)_                                                                                                                                                                                                                                                                                                  |
 | [onMediaDeviceFailure?](./react/livekitroomprops.onmediadevicefailure.md) | (failure?: MediaDeviceFailure) =&gt; void | _(Optional)_                                                                                                                                                                                                                                                                                                  |
 | [options?](./react/livekitroomprops.options.md)                           | RoomOptions                               | _(Optional)_ Options for when creating a new room. When you pass your own room instance to this component, these options have no effect. Instead, set the options directly in the room instance.                                                                                                              |

package/generated-docs/react/livekitroomprops.onencryptionerror.md

@@ -0,0 +1,13 @@
+---
+{ "title": "LiveKitRoomProps.onEncryptionError property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# LiveKitRoomProps.onEncryptionError property
+
+**Signature:**
+
+```typescript
+onEncryptionError?: (error: Error) => void;
+```

package/generated-docs/react/localuserchoices.md

@@ -1,7 +1,7 @@
 ---
 {
   "title": "LocalUserChoices type",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/prefabs/PreJoin.tsx"
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/../core/src/persistent-storage/user-choices.ts"
 }
 ---
 
@@ -9,15 +9,17 @@
 
 # LocalUserChoices type
 
+Represents the user's choices for video and audio input devices, as well as their username.
+
 **Signature:**
 
 ```typescript
 export type LocalUserChoices = {
-  username: string;
   videoEnabled: boolean;
   audioEnabled: boolean;
   videoDeviceId: string;
   audioDeviceId: string;
+  username: string;
   e2ee: boolean;
   sharedPassphrase: string;
 };

package/generated-docs/react/mediadeviceselectprops.md

@@ -12,10 +12,10 @@
 **Signature:**
 
 ```typescript
-export interface MediaDeviceSelectProps extends React.HTMLAttributes<HTMLUListElement>
+export interface MediaDeviceSelectProps extends Omit<React.HTMLAttributes<HTMLUListElement>, 'onError'>
 ```
 
-**Extends:** React.HTMLAttributes&lt;HTMLUListElement&gt;
+**Extends:** Omit&lt;React.HTMLAttributes&lt;HTMLUListElement&gt;, 'onError'&gt;
 
 {% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
@@ -29,5 +29,6 @@ export interface MediaDeviceSelectProps extends React.HTMLAttributes<HTMLUListEl
 | [onActiveDeviceChange?](./react/mediadeviceselectprops.onactivedevicechange.md) | (deviceId: string) =&gt; void             | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
 | [onDeviceListChange?](./react/mediadeviceselectprops.ondevicelistchange.md)     | (devices: MediaDeviceInfo\[\]) =&gt; void | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
 | [onDeviceSelectError?](./react/mediadeviceselectprops.ondeviceselecterror.md)   | (e: Error) =&gt; void                     | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
+| [onError?](./react/mediadeviceselectprops.onerror.md)                           | (e: Error) =&gt; void                     | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
 | [requestPermissions?](./react/mediadeviceselectprops.requestpermissions.md)     | boolean                                   | _(Optional)_ this will call getUserMedia if the permissions are not yet given to enumerate the devices with device labels. in some browsers multiple calls to getUserMedia result in multiple permission prompts. It's generally advised only flip this to true, once a (preview) track has been acquired successfully with the appropriate permissions. |
 | [track?](./react/mediadeviceselectprops.track.md)                               | LocalAudioTrack \| LocalVideoTrack        | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |

package/generated-docs/react/mediadeviceselectprops.onerror.md

@@ -0,0 +1,13 @@
+---
+{ "title": "MediaDeviceSelectProps.onError property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# MediaDeviceSelectProps.onError property
+
+**Signature:**
+
+```typescript
+onError?: (e: Error) => void;
+```

package/generated-docs/react/messagedecoder.md

@@ -0,0 +1,20 @@
+---
+{
+  "title": "MessageDecoder type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/../core/src/components/chat.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# MessageDecoder type
+
+**Signature:**
+
+```typescript
+export type MessageDecoder = (message: Uint8Array) => ReceivedChatMessage;
+```
+
+**References:** [ReceivedChatMessage](./react/receivedchatmessage.md)
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/messageencoder.md

@@ -0,0 +1,20 @@
+---
+{
+  "title": "MessageEncoder type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/../core/src/components/chat.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# MessageEncoder type
+
+**Signature:**
+
+```typescript
+export type MessageEncoder = (message: ChatMessage) => Uint8Array;
+```
+
+**References:** [ChatMessage](./react/chatmessage.md)
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/meta-data.json

@@ -1 +1 @@
-{"components":[{"filename":"audioconference.md","title":"AudioConference"},{"filename":"audiotrack.md","title":"AudioTrack"},{"filename":"audiovisualizer.md","title":"AudioVisualizer"},{"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":"livekitroom.md","title":"LiveKitRoom"},{"filename":"mediadevicemenu.md","title":"MediaDeviceMenu"},{"filename":"mediadeviceselect.md","title":"MediaDeviceSelect"},{"filename":"participantaudiotile.md","title":"ParticipantAudioTile"},{"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":"roomname.md","title":"RoomName"},{"filename":"startaudio.md","title":"StartAudio"},{"filename":"toast.md","title":"Toast"},{"filename":"trackloop.md","title":"TrackLoop"},{"filename":"trackmutedindicator.md","title":"TrackMutedIndicator"},{"filename":"tracktoggle.md","title":"TrackToggle"},{"filename":"videoconference.md","title":"VideoConference"},{"filename":"videotrack.md","title":"VideoTrack"}],"hooks":[{"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":"useensuretrackreference.md","title":"useEnsureTrackReference"},{"filename":"usefocustoggle.md","title":"useFocusToggle"},{"filename":"usegridlayout.md","title":"useGridLayout"},{"filename":"useismuted.md","title":"useIsMuted"},{"filename":"useismuted_1.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":"usemaybetrackcontext.md","title":"useMaybeTrackContext"},{"filename":"usemaybetrackrefcontext.md","title":"useMaybeTrackRefContext"},{"filename":"usemediadevices.md","title":"useMediaDevices"},{"filename":"usemediadeviceselect.md","title":"useMediaDeviceSelect"},{"filename":"usemediatrack.md","title":"useMediaTrack"},{"filename":"usemediatrackbyname.md","title":"useMediaTrackByName"},{"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":"usepinnedtracks.md","title":"usePinnedTracks"},{"filename":"usepreviewdevice.md","title":"usePreviewDevice"},{"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":"usetoken.md","title":"useToken"},{"filename":"usetrack.md","title":"useTrack"},{"filename":"usetrackbyname.md","title":"useTrackByName"},{"filename":"usetrackcontext.md","title":"useTrackContext"},{"filename":"usetrackmutedindicator.md","title":"useTrackMutedIndicator"},{"filename":"usetrackmutedindicator_1.md","title":"useTrackMutedIndicator"},{"filename":"usetrackrefcontext.md","title":"useTrackRefContext"},{"filename":"usetracks.md","title":"useTracks"},{"filename":"usetracktoggle.md","title":"useTrackToggle"},{"filename":"usevisualstableupdate.md","title":"useVisualStableUpdate"}]}
+{"components":[{"filename":"audioconference.md","title":"AudioConference"},{"filename":"audiotrack.md","title":"AudioTrack"},{"filename":"audiovisualizer.md","title":"AudioVisualizer"},{"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":"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":"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":"roomname.md","title":"RoomName"},{"filename":"startaudio.md","title":"StartAudio"},{"filename":"toast.md","title":"Toast"},{"filename":"trackloop.md","title":"TrackLoop"},{"filename":"trackmutedindicator.md","title":"TrackMutedIndicator"},{"filename":"tracktoggle.md","title":"TrackToggle"},{"filename":"videoconference.md","title":"VideoConference"},{"filename":"videotrack.md","title":"VideoTrack"}],"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":"useensuretrackreference.md","title":"useEnsureTrackReference"},{"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":"useismuted_1.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":"usemaybetrackcontext.md","title":"useMaybeTrackContext"},{"filename":"usemaybetrackrefcontext.md","title":"useMaybeTrackRefContext"},{"filename":"usemediadevices.md","title":"useMediaDevices"},{"filename":"usemediadeviceselect.md","title":"useMediaDeviceSelect"},{"filename":"usemediatrack.md","title":"useMediaTrack"},{"filename":"usemediatrackbyname.md","title":"useMediaTrackByName"},{"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":"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":"usetrack.md","title":"useTrack"},{"filename":"usetrackbyname.md","title":"useTrackByName"},{"filename":"usetrackcontext.md","title":"useTrackContext"},{"filename":"usetrackmutedindicator.md","title":"useTrackMutedIndicator"},{"filename":"usetrackmutedindicator_1.md","title":"useTrackMutedIndicator"},{"filename":"usetrackrefcontext.md","title":"useTrackRefContext"},{"filename":"usetracks.md","title":"useTracks"},{"filename":"usetracktoggle.md","title":"useTrackToggle"},{"filename":"usevisualstableupdate.md","title":"useVisualStableUpdate"}]}

package/generated-docs/react/participanttileprops.md

@@ -21,11 +21,11 @@ export interface ParticipantTileProps extends React.HTMLAttributes<HTMLDivElemen
 
 ## Properties
 
-| Property                                                                              | Type                                                                                 | Description                                  |
-| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | -------------------------------------------- |
-| [disableSpeakingIndicator?](./react/participanttileprops.disablespeakingindicator.md) | boolean                                                                              | _(Optional)_                                 |
-| [onParticipantClick?](./react/participanttileprops.onparticipantclick.md)             | (event: [ParticipantClickEvent](./core/participantclickevent.md)<!-- -->) =&gt; void | _(Optional)_                                 |
-| [participant?](./react/participanttileprops.participant.md)                           | Participant                                                                          | _(Optional)_                                 |
-| [publication?](./react/participanttileprops.publication.md)                           | TrackPublication                                                                     | _(Optional)_                                 |
-| [source?](./react/participanttileprops.source.md)                                     | Track.Source                                                                         | _(Optional)_                                 |
-| [trackRef?](./react/participanttileprops.trackref.md)                                 | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)                 | _(Optional)_ The track reference to display. |
+| Property                                                                              | Type                                                                  | Description                                  |
+| ------------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -------------------------------------------- |
+| [disableSpeakingIndicator?](./react/participanttileprops.disablespeakingindicator.md) | boolean                                                               | _(Optional)_                                 |
+| [onParticipantClick?](./react/participanttileprops.onparticipantclick.md)             | (event: ParticipantClickEvent) =&gt; void                             | _(Optional)_                                 |
+| [participant?](./react/participanttileprops.participant.md)                           | Participant                                                           | _(Optional)_                                 |
+| [publication?](./react/participanttileprops.publication.md)                           | TrackPublication                                                      | _(Optional)_                                 |
+| [source?](./react/participanttileprops.source.md)                                     | Track.Source                                                          | _(Optional)_                                 |
+| [trackRef?](./react/participanttileprops.trackref.md)                                 | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | _(Optional)_ The track reference to display. |

package/generated-docs/react/pinstate.md

@@ -0,0 +1,20 @@
+---
+{
+  "title": "PinState type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/../core/src/types.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# PinState type
+
+**Signature:**
+
+```typescript
+export type PinState = TrackReferenceOrPlaceholder[];
+```
+
+**References:** [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md)
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/prejoinprops.md

@@ -9,6 +9,8 @@
 
 # PreJoinProps interface
 
+Props for the PreJoin component.
+
 **Signature:**
 
 ```typescript
@@ -21,15 +23,16 @@ export interface PreJoinProps extends Omit<React.HTMLAttributes<HTMLDivElement>,
 
 ## Properties
 
-| Property                                                    | Type                                                                            | Description                                                                                                                                |
-| ----------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
-| [camLabel?](./react/prejoinprops.camlabel.md)               | string                                                                          | _(Optional)_                                                                                                                               |
-| [debug?](./react/prejoinprops.debug.md)                     | boolean                                                                         | _(Optional)_ Display a debug window for your convenience.                                                                                  |
-| [defaults?](./react/prejoinprops.defaults.md)               | Partial&lt;[LocalUserChoices](./react/localuserchoices.md)<!-- -->&gt;          | _(Optional)_ Prefill the input form with initial values.                                                                                   |
-| [joinLabel?](./react/prejoinprops.joinlabel.md)             | string                                                                          | _(Optional)_                                                                                                                               |
-| [micLabel?](./react/prejoinprops.miclabel.md)               | string                                                                          | _(Optional)_                                                                                                                               |
-| [onError?](./react/prejoinprops.onerror.md)                 | (error: Error) =&gt; void                                                       | _(Optional)_                                                                                                                               |
-| [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.                                       |
-| [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. |
-| [showE2EEOptions?](./react/prejoinprops.showe2eeoptions.md) | boolean                                                                         | _(Optional)_                                                                                                                               |
-| [userLabel?](./react/prejoinprops.userlabel.md)             | string                                                                          | _(Optional)_                                                                                                                               |
+| Property                                                          | Type                                                                            | Description                                                                                                                                |
+| ----------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
+| [camLabel?](./react/prejoinprops.camlabel.md)                     | string                                                                          | _(Optional)_                                                                                                                               |
+| [debug?](./react/prejoinprops.debug.md)                           | boolean                                                                         | _(Optional)_ Display a debug window for your convenience.                                                                                  |
+| [defaults?](./react/prejoinprops.defaults.md)                     | Partial&lt;[LocalUserChoices](./react/localuserchoices.md)<!-- -->&gt;          | _(Optional)_ Prefill the input form with initial values.                                                                                   |
+| [joinLabel?](./react/prejoinprops.joinlabel.md)                   | string                                                                          | _(Optional)_                                                                                                                               |
+| [micLabel?](./react/prejoinprops.miclabel.md)                     | string                                                                          | _(Optional)_                                                                                                                               |
+| [onError?](./react/prejoinprops.onerror.md)                       | (error: Error) =&gt; void                                                       | _(Optional)_                                                                                                                               |
+| [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.                                       |
+| [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. |
+| [persistUserChoices?](./react/prejoinprops.persistuserchoices.md) | boolean                                                                         | _(Optional)_ If true, user choices are persisted across sessions.                                                                          |
+| [showE2EEOptions?](./react/prejoinprops.showe2eeoptions.md)       | boolean                                                                         | _(Optional)_                                                                                                                               |
+| [userLabel?](./react/prejoinprops.userlabel.md)                   | string                                                                          | _(Optional)_                                                                                                                               |

package/generated-docs/react/prejoinprops.persistuserchoices.md

@@ -0,0 +1,17 @@
+---
+{ "title": "PreJoinProps.persistUserChoices property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# PreJoinProps.persistUserChoices property
+
+If true, user choices are persisted across sessions.
+
+**Signature:**
+
+```typescript
+persistUserChoices?: boolean;
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/prejoinprops.showe2eeoptions.md

@@ -6,8 +6,18 @@
 
 # PreJoinProps.showE2EEOptions property
 
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+E2EE options will be removed from PreJoin in a future version \*
+
+{% /callout %}
+
 **Signature:**
 
 ```typescript
 showE2EEOptions?: boolean;
 ```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/{chatprops.messagedecoder.md → receivedchatmessage.from.md}

@@ -1,13 +1,13 @@
 ---
-{ "title": "ChatProps.messageDecoder property" }
+{ "title": "ReceivedChatMessage.from property" }
 ---
 
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# ChatProps.messageDecoder property
+# ReceivedChatMessage.from property
 
 **Signature:**
 
 ```typescript
-messageDecoder?: MessageDecoder;
+from?: Participant;
 ```

package/generated-docs/react/receivedchatmessage.md

@@ -0,0 +1,26 @@
+---
+{
+  "title": "ReceivedChatMessage interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/../core/src/components/chat.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# ReceivedChatMessage interface
+
+**Signature:**
+
+```typescript
+export interface ReceivedChatMessage extends ChatMessage
+```
+
+**Extends:** [ChatMessage](./react/chatmessage.md)
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+| Property                                     | Type        | Description  |
+| -------------------------------------------- | ----------- | ------------ |
+| [from?](./react/receivedchatmessage.from.md) | Participant | _(Optional)_ |

package/generated-docs/react/roomaudiorendererprops.md

@@ -0,0 +1,25 @@
+---
+{
+  "title": "RoomAudioRendererProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/RoomAudioRenderer.tsx"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# RoomAudioRendererProps interface
+
+**Signature:**
+
+```typescript
+export interface RoomAudioRendererProps
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+| Property                                            | Type    | Description                                                                                                                                           |
+| --------------------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [muted?](./react/roomaudiorendererprops.muted.md)   | boolean | _(Optional)_ If set to <code>true</code>, mutes all audio tracks rendered by the component.                                                           |
+| [volume?](./react/roomaudiorendererprops.volume.md) | number  | _(Optional)_ Sets the volume for all audio tracks rendered by this component. By default, the range is between <code>0.0</code> and <code>1.0</code>. |

package/generated-docs/react/roomaudiorendererprops.muted.md

@@ -0,0 +1,21 @@
+---
+{ "title": "RoomAudioRendererProps.muted property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# RoomAudioRendererProps.muted property
+
+If set to `true`<!-- -->, mutes all audio tracks rendered by the component.
+
+**Signature:**
+
+```typescript
+muted?: boolean;
+```
+
+## Remarks
+
+If set to `true`<!-- -->, the server will stop sending audio track data to the client.
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/roomaudiorendererprops.volume.md

@@ -0,0 +1,17 @@
+---
+{ "title": "RoomAudioRendererProps.volume property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# RoomAudioRendererProps.volume property
+
+Sets the volume for all audio tracks rendered by this component. By default, the range is between `0.0` and `1.0`<!-- -->.
+
+**Signature:**
+
+```typescript
+volume?: number;
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/setloglevel.md

@@ -0,0 +1,20 @@
+---
+{
+  "title": "setLogLevel",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/../core/src/logger.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# setLogLevel
+
+Set the log level for both the `@livekit/components-react` package and the `@livekit-client` package. To set the `@livekit-client` log independently, use the `liveKitClientLogLevel` prop on the `options` object.
+
+**Signature:**
+
+```typescript
+export declare function setLogLevel(level: LogLevel, options?: SetLogLevelOptions): void;
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/trackloopprops.md

@@ -19,7 +19,7 @@ export interface TrackLoopProps
 
 ## Properties
 
-| Property                                       | Type                                                                                                                                       | Description                                                                                          |
-| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------- |
-| [children](./react/trackloopprops.children.md) | React.ReactNode                                                                                                                            | The template component to be used in the loop.                                                       |
-| [tracks](./react/trackloopprops.tracks.md)     | [TrackReference](./core/trackreference.md)<!-- -->\[\] \| [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\] | Track references to loop over. You can the use <code>useTracks()</code> hook to get TrackReferences. |
+| Property                                       | Type                                                                                                                                         | Description                                                                                          |
+| ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
+| [children](./react/trackloopprops.children.md) | React.ReactNode                                                                                                                              | The template component to be used in the loop.                                                       |
+| [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. |

package/generated-docs/react/trackmutedindicatorprops.md

@@ -21,9 +21,9 @@ export interface TrackMutedIndicatorProps extends React.HTMLAttributes<HTMLDivEl
 
 ## Properties
 
-| Property                                                        | Type                                                                 | Description  |
-| --------------------------------------------------------------- | -------------------------------------------------------------------- | ------------ |
-| [participant?](./react/trackmutedindicatorprops.participant.md) | Participant                                                          | _(Optional)_ |
-| [show?](./react/trackmutedindicatorprops.show.md)               | 'always' \| 'muted' \| 'unmuted'                                     | _(Optional)_ |
-| [source?](./react/trackmutedindicatorprops.source.md)           | Track.Source                                                         | _(Optional)_ |
-| [trackRef?](./react/trackmutedindicatorprops.trackref.md)       | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md) | _(Optional)_ |
+| Property                                                        | Type                                                                  | Description  |
+| --------------------------------------------------------------- | --------------------------------------------------------------------- | ------------ |
+| [participant?](./react/trackmutedindicatorprops.participant.md) | Participant                                                           | _(Optional)_ |
+| [show?](./react/trackmutedindicatorprops.show.md)               | 'always' \| 'muted' \| 'unmuted'                                      | _(Optional)_ |
+| [source?](./react/trackmutedindicatorprops.source.md)           | Track.Source                                                          | _(Optional)_ |
+| [trackRef?](./react/trackmutedindicatorprops.trackref.md)       | [TrackReferenceOrPlaceholder](./react/trackreferenceorplaceholder.md) | _(Optional)_ |

package/generated-docs/react/trackreference.md

@@ -0,0 +1,22 @@
+---
+{
+  "title": "TrackReference type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/../core/src/track-reference/track-reference.types.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# TrackReference type
+
+**Signature:**
+
+```typescript
+export type TrackReference = {
+  participant: Participant;
+  publication: TrackPublication;
+  source: Track.Source;
+};
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/trackreferenceorplaceholder.md

@@ -0,0 +1,20 @@
+---
+{
+  "title": "TrackReferenceOrPlaceholder type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/../core/src/track-reference/track-reference.types.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# TrackReferenceOrPlaceholder type
+
+**Signature:**
+
+```typescript
+export type TrackReferenceOrPlaceholder = TrackReference | TrackReferencePlaceholder;
+```
+
+**References:** [TrackReference](./react/trackreference.md)
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/tracktoggleprops.md

@@ -21,10 +21,10 @@ export interface TrackToggleProps<T extends ToggleSource> extends Omit<React.But
 
 ## Properties
 
-| Property                                                      | Type                                                                        | Description  |
-| ------------------------------------------------------------- | --------------------------------------------------------------------------- | ------------ |
-| [captureOptions?](./react/tracktoggleprops.captureoptions.md) | [CaptureOptionsBySource](./core/captureoptionsbysource.md)<!-- -->&lt;T&gt; | _(Optional)_ |
-| [initialState?](./react/tracktoggleprops.initialstate.md)     | boolean                                                                     | _(Optional)_ |
-| [onChange?](./react/tracktoggleprops.onchange.md)             | (enabled: boolean) =&gt; void                                               | _(Optional)_ |
-| [showIcon?](./react/tracktoggleprops.showicon.md)             | boolean                                                                     | _(Optional)_ |
-| [source](./react/tracktoggleprops.source.md)                  | T                                                                           |              |
+| Property                                                      | Type                            | Description  |
+| ------------------------------------------------------------- | ------------------------------- | ------------ |
+| [captureOptions?](./react/tracktoggleprops.captureoptions.md) | CaptureOptionsBySource&lt;T&gt; | _(Optional)_ |
+| [initialState?](./react/tracktoggleprops.initialstate.md)     | boolean                         | _(Optional)_ |
+| [onChange?](./react/tracktoggleprops.onchange.md)             | (enabled: boolean) =&gt; void   | _(Optional)_ |
+| [showIcon?](./react/tracktoggleprops.showicon.md)             | boolean                         | _(Optional)_ |
+| [source](./react/tracktoggleprops.source.md)                  | T                               |              |