@livekit/components-js-docs 0.1.0 → 0.1.2

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](./core/pinstate.md)<!-- -->) =&gt; void       | _(Optional)_ |
+| [onWidgetChange?](./react/layoutcontextproviderprops.onwidgetchange.md) | (state: [WidgetState](./core/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/layoutcontexttype.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "LayoutContextType type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/context/layout-context.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## LayoutContextType type
+# LayoutContextType type
 
 **Signature:**
 

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

@@ -1,6 +1,10 @@
+---
+{ "title": "LiveKitRoomProps.audio property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## LiveKitRoomProps.audio property
+# LiveKitRoomProps.audio property
 
 Publish audio immediately after connecting to your LiveKit room.
 

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

@@ -1,6 +1,10 @@
+---
+{ "title": "LiveKitRoomProps.connect property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## LiveKitRoomProps.connect property
+# LiveKitRoomProps.connect property
 
 If set to true a connection to LiveKit room is initiated.
 

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

@@ -1,6 +1,10 @@
+---
+{ "title": "LiveKitRoomProps.connectOptions property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## LiveKitRoomProps.connectOptions property
+# LiveKitRoomProps.connectOptions property
 
 Define options how to connect to the LiveKit server.
 

package/generated-docs/react/livekitroomprops.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "LiveKitRoomProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/LiveKitRoom.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## LiveKitRoomProps interface
+# LiveKitRoomProps interface
 
 **Signature:**
 

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

@@ -1,6 +1,10 @@
+---
+{ "title": "LiveKitRoomProps.onConnected property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## LiveKitRoomProps.onConnected property
+# LiveKitRoomProps.onConnected property
 
 **Signature:**
 

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

@@ -1,6 +1,10 @@
+---
+{ "title": "LiveKitRoomProps.onDisconnected property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## LiveKitRoomProps.onDisconnected property
+# LiveKitRoomProps.onDisconnected property
 
 **Signature:**
 

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

@@ -1,6 +1,10 @@
+---
+{ "title": "LiveKitRoomProps.onError property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## LiveKitRoomProps.onError property
+# LiveKitRoomProps.onError property
 
 **Signature:**
 

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

@@ -1,6 +1,10 @@
+---
+{ "title": "LiveKitRoomProps.onMediaDeviceFailure property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## LiveKitRoomProps.onMediaDeviceFailure property
+# LiveKitRoomProps.onMediaDeviceFailure property
 
 **Signature:**
 

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

@@ -1,6 +1,10 @@
+---
+{ "title": "LiveKitRoomProps.options property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## LiveKitRoomProps.options property
+# LiveKitRoomProps.options property
 
 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.room.md

@@ -1,6 +1,10 @@
+---
+{ "title": "LiveKitRoomProps.room property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## LiveKitRoomProps.room property
+# LiveKitRoomProps.room property
 
 Optional room instance. By passing your own room instance you overwrite the `options` parameter, make sure to set the options directly on the room instance itself.
 

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

@@ -1,6 +1,10 @@
+---
+{ "title": "LiveKitRoomProps.screen property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## LiveKitRoomProps.screen property
+# LiveKitRoomProps.screen property
 
 Publish screen share immediately after connecting to your LiveKit room.
 

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

@@ -1,6 +1,10 @@
+---
+{ "title": "LiveKitRoomProps.serverUrl property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## LiveKitRoomProps.serverUrl property
+# LiveKitRoomProps.serverUrl property
 
 URL to the LiveKit server. For example: `wss://<domain>.livekit.cloud` To simplify the implementation, `undefined` is also accepted as an intermediate value, but only with a valid string url can the connection be established.
 

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

@@ -1,6 +1,10 @@
+---
+{ "title": "LiveKitRoomProps.simulateParticipants property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## LiveKitRoomProps.simulateParticipants property
+# LiveKitRoomProps.simulateParticipants property
 
 **Signature:**
 

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

@@ -1,6 +1,10 @@
+---
+{ "title": "LiveKitRoomProps.token property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## LiveKitRoomProps.token property
+# LiveKitRoomProps.token property
 
 A user specific access token for a client to authenticate to the room. This token is necessary to establish a connection to the room. To simplify the implementation, `undefined` is also accepted as an intermediate value, but only with a valid string token can the connection be established.
 

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

@@ -1,6 +1,10 @@
+---
+{ "title": "LiveKitRoomProps.video property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## LiveKitRoomProps.video property
+# LiveKitRoomProps.video property
 
 Publish video immediately after connecting to your LiveKit room.
 

package/generated-docs/react/mediadevicemenuprops.initialselection.md

@@ -1,6 +1,10 @@
+---
+{ "title": "MediaDeviceMenuProps.initialSelection property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MediaDeviceMenuProps.initialSelection property
+# MediaDeviceMenuProps.initialSelection property
 
 **Signature:**
 

package/generated-docs/react/mediadevicemenuprops.kind.md

@@ -1,6 +1,10 @@
+---
+{ "title": "MediaDeviceMenuProps.kind property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MediaDeviceMenuProps.kind property
+# MediaDeviceMenuProps.kind property
 
 **Signature:**
 

package/generated-docs/react/mediadevicemenuprops.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "MediaDeviceMenuProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/prefabs/MediaDeviceMenu.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MediaDeviceMenuProps interface
+# MediaDeviceMenuProps interface
 
 **Signature:**
 

package/generated-docs/react/mediadevicemenuprops.onactivedevicechange.md

@@ -1,6 +1,10 @@
+---
+{ "title": "MediaDeviceMenuProps.onActiveDeviceChange property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MediaDeviceMenuProps.onActiveDeviceChange property
+# MediaDeviceMenuProps.onActiveDeviceChange property
 
 **Signature:**
 

package/generated-docs/react/mediadevicemenuprops.requestpermissions.md

@@ -1,6 +1,10 @@
+---
+{ "title": "MediaDeviceMenuProps.requestPermissions property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MediaDeviceMenuProps.requestPermissions property
+# MediaDeviceMenuProps.requestPermissions property
 
 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.
 

package/generated-docs/react/mediadevicemenuprops.tracks.md

@@ -1,6 +1,10 @@
+---
+{ "title": "MediaDeviceMenuProps.tracks property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MediaDeviceMenuProps.tracks property
+# MediaDeviceMenuProps.tracks property
 
 **Signature:**
 

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

@@ -1,6 +1,10 @@
+---
+{ "title": "MediaDeviceSelectProps.exactMatch property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MediaDeviceSelectProps.exactMatch property
+# MediaDeviceSelectProps.exactMatch property
 
 will force the browser to only return the specified device will call `onDeviceSelectError` with the error in case this fails
 

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

@@ -1,6 +1,10 @@
+---
+{ "title": "MediaDeviceSelectProps.initialSelection property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MediaDeviceSelectProps.initialSelection property
+# MediaDeviceSelectProps.initialSelection property
 
 **Signature:**
 

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

@@ -1,6 +1,10 @@
+---
+{ "title": "MediaDeviceSelectProps.kind property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MediaDeviceSelectProps.kind property
+# MediaDeviceSelectProps.kind property
 
 **Signature:**
 

package/generated-docs/react/mediadeviceselectprops.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "MediaDeviceSelectProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/controls/MediaDeviceSelect.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MediaDeviceSelectProps interface
+# MediaDeviceSelectProps interface
 
 **Signature:**
 

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

@@ -1,6 +1,10 @@
+---
+{ "title": "MediaDeviceSelectProps.onActiveDeviceChange property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MediaDeviceSelectProps.onActiveDeviceChange property
+# MediaDeviceSelectProps.onActiveDeviceChange property
 
 **Signature:**
 

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

@@ -1,6 +1,10 @@
+---
+{ "title": "MediaDeviceSelectProps.onDeviceListChange property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MediaDeviceSelectProps.onDeviceListChange property
+# MediaDeviceSelectProps.onDeviceListChange property
 
 **Signature:**
 

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

@@ -1,6 +1,10 @@
+---
+{ "title": "MediaDeviceSelectProps.onDeviceSelectError property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MediaDeviceSelectProps.onDeviceSelectError property
+# MediaDeviceSelectProps.onDeviceSelectError property
 
 **Signature:**
 

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

@@ -1,6 +1,10 @@
+---
+{ "title": "MediaDeviceSelectProps.requestPermissions property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MediaDeviceSelectProps.requestPermissions property
+# MediaDeviceSelectProps.requestPermissions property
 
 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.
 

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

@@ -1,6 +1,10 @@
+---
+{ "title": "MediaDeviceSelectProps.track property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MediaDeviceSelectProps.track property
+# MediaDeviceSelectProps.track property
 
 **Signature:**
 

package/generated-docs/react/messageformatter.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "MessageFormatter type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/ChatEntry.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## MessageFormatter type
+# MessageFormatter type
 
 **Signature:**
 

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":"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":"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/participantcontext.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "ParticipantContext variable",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/context/participant-context.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ParticipantContext variable
+# ParticipantContext variable
 
 **Signature:**
 

package/generated-docs/react/participantloopprops.children.md

@@ -1,6 +1,10 @@
+---
+{ "title": "ParticipantLoopProps.children property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ParticipantLoopProps.children property
+# ParticipantLoopProps.children property
 
 The template component to be used in the loop.
 

package/generated-docs/react/participantloopprops.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "ParticipantLoopProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/ParticipantLoop.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ParticipantLoopProps interface
+# ParticipantLoopProps interface
 
 **Signature:**
 

package/generated-docs/react/participantloopprops.participants.md

@@ -1,6 +1,10 @@
+---
+{ "title": "ParticipantLoopProps.participants property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ParticipantLoopProps.participants property
+# ParticipantLoopProps.participants property
 
 The participants to loop over. Use `useParticipants()` hook to get participants.
 

package/generated-docs/react/participantnameprops.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "ParticipantNameProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/components/participant/ParticipantName.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ParticipantNameProps interface
+# ParticipantNameProps interface
 
 **Signature:**
 

package/generated-docs/react/participanttileprops.disablespeakingindicator.md

@@ -1,6 +1,10 @@
+---
+{ "title": "ParticipantTileProps.disableSpeakingIndicator property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ParticipantTileProps.disableSpeakingIndicator property
+# ParticipantTileProps.disableSpeakingIndicator property
 
 **Signature:**