@livekit/components-js-docs 0.0.2

package/generated-docs/react/index.md

@@ -0,0 +1,168 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## components-react package
+
+## Components
+
+| Component                                                                                                                                                                                               | Description                                                                                                                                                                                                                                                                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| [AudioTrack({ onSubscriptionStatusChanged, volume, ...props })](./react/component/audiotrack.md)                                                                                                        | The AudioTrack component is responsible for rendering participant audio tracks. This component must have access to the participant's context, or alternatively pass it a <code>Participant</code> as a property.                                                                                                                                                                                                               |
+| [AudioVisualizer({ participant, ...props })](./react/component/audiovisualizer.md)                                                                                                                      |                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [CarouselView({ tracks, orientation, ...props })](./react/component/carouselview.md)                                                                                                                    | The <code>CarouselLayout</code> displays a list of tracks horizontally or vertically. Depending on the size of the container, the carousel will display as many tiles as possible and overflows the rest. The CarouselLayout uses the <code>useVisualStableUpdate</code> hook to ensure that tile reordering due to track updates is visually stable but still moves the important tiles (speaking participants) to the front. |
+| [ChatEntry({ entry, hideName, hideTimestamp, messageFormatter, ...props })](./react/component/chatentry.md)                                                                                             | The <code>ChatEntry</code> component holds and displays one chat message.                                                                                                                                                                                                                                                                                                                                                      |
+| [ChatToggle(props)](./react/component/chattoggle.md)                                                                                                                                                    | The ChatToggle component toggles the visibility of the chat component.                                                                                                                                                                                                                                                                                                                                                         |
+| [ClearPinButton(props)](./react/component/clearpinbutton.md)                                                                                                                                            | The ClearPinButton is a basic html button with the added ability to signal the LiveKitRoom that it should display the grid view again.                                                                                                                                                                                                                                                                                         |
+| [ConnectionQualityIndicator(props)](./react/component/connectionqualityindicator.md)                                                                                                                    | The ConnectionQualityIndicator shows the individual connection quality of a participant.                                                                                                                                                                                                                                                                                                                                       |
+| [ConnectionState({ room, ...props })](./react/component/connectionstate.md)                                                                                                                             | The ConnectionState component displays the connection status of the room in written form.                                                                                                                                                                                                                                                                                                                                      |
+| [ConnectionStateToast(props)](./react/component/connectionstatetoast.md)                                                                                                                                |                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [DisconnectButton(props)](./react/component/disconnectbutton.md)                                                                                                                                        | The DisconnectButton is a basic html button with the added ability to disconnect from a LiveKit room. Normally, it is used by end-users to leave a video or audio call.                                                                                                                                                                                                                                                        |
+| [FocusLayout({ track, ...htmlProps })](./react/component/focuslayout.md)                                                                                                                                |                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [FocusLayoutContainer(props)](./react/component/focuslayoutcontainer.md)                                                                                                                                |                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [FocusToggle({ trackSource, participant, ...props })](./react/component/focustoggle.md)                                                                                                                 | The FocusToggle puts the ParticipantTile in focus or removes it from focus.                                                                                                                                                                                                                                                                                                                                                    |
+| [formatChatMessageLinks(message)](./react/component/formatchatmessagelinks.md)                                                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [GridLayout({ tracks, ...props })](./react/component/gridlayout.md)                                                                                                                                     | The GridLayout component displays the nested participants in a grid where every participants has the same size.                                                                                                                                                                                                                                                                                                                |
+| [LiveKitRoom(props)](./react/component/livekitroom.md)                                                                                                                                                  | The LiveKitRoom component provides the room context to all its child components. It is generally the starting point of your LiveKit app and the root of the LiveKit component tree. It provides the room state as a React context to all child components, so you don't have to pass it yourself.                                                                                                                              |
+| [MediaDeviceSelect({ kind, initialSelection, onActiveDeviceChange, onDeviceListChange, onDeviceSelectError, exactMatch, track, requestPermissions, ...props })](./react/component/mediadeviceselect.md) | The MediaDeviceSelect list all media devices of one kind. Clicking on one of the listed devices make it the active media device.                                                                                                                                                                                                                                                                                               |
+| [ParticipantAudioTile({ participant, children, source, publication, disableSpeakingIndicator, onParticipantClick, ...htmlProps })](./react/component/participantaudiotile.md)                           | The ParticipantAudioTile component is the base utility wrapper for displaying a visual representation of a participant. This component can be used as a child of the <code>TileLoop</code> or independently if a participant is passed as a property.                                                                                                                                                                          |
+| [ParticipantContextIfNeeded(props)](./react/component/participantcontextifneeded.md)                                                                                                                    |                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [ParticipantLoop({ participants, ...props })](./react/component/participantloop.md)                                                                                                                     | The ParticipantLoop component loops over an array of participants to create a context for every participant. This component takes exactly one child component as a template. By providing your own template as a child you have full control over the look and feel of your participant representations.                                                                                                                       |
+| [ParticipantName({ participant, ...props })](./react/component/participantname.md)                                                                                                                      | The ParticipantName component displays the name of the participant as a string within an HTML span element. If no participant name is undefined the participant identity string is displayed.                                                                                                                                                                                                                                  |
+| [ParticipantTile({ participant, children, source, onParticipantClick, publication, disableSpeakingIndicator, ...htmlProps })](./react/component/participanttile.md)                                     | The ParticipantTile component is the base utility wrapper for displaying a visual representation of a participant. This component can be used as a child of the <code>TrackLoop</code> component or by spreading a track reference as properties.                                                                                                                                                                              |
+| [RoomAudioRenderer()](./react/component/roomaudiorenderer.md)                                                                                                                                           | The RoomAudioRenderer component is a drop-in solution for adding audio to your LiveKit app. It takes care of handling remote participants’ audio tracks and makes sure that microphones and screen share are audible.                                                                                                                                                                                                          |
+| [RoomName({ childrenPosition, children, ...htmlAttributes })](./react/component/roomname.md)                                                                                                            | The RoomName component renders the name of the connected LiveKit room inside a span tag.                                                                                                                                                                                                                                                                                                                                       |
+| [StartAudio({ label, ...props })](./react/component/startaudio.md)                                                                                                                                      | The StartAudio component is only visible when the browser blocks audio playback. This is due to some browser implemented autoplay policies. To start audio playback, the user must perform a user-initiated event such as clicking this button. As soon as audio playback starts, the button hides itself again.                                                                                                               |
+| [Toast(props)](./react/component/toast.md)                                                                                                                                                              |                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| [TrackLoop({ tracks, ...props })](./react/component/trackloop.md)                                                                                                                                       | The TrackLoop component loops over tracks. It is for example a easy way to loop over all participant camera and screen share tracks. TrackLoop creates a TrackContext for each track that you can use to e.g. render the track.                                                                                                                                                                                                |
+| [TrackMutedIndicator({ source, participant, show, ...props })](./react/component/trackmutedindicator.md)                                                                                                | The TrackMutedIndicator shows whether the participant's camera or microphone is muted or not.                                                                                                                                                                                                                                                                                                                                  |
+| [TrackToggle({ showIcon, ...props })](./react/component/tracktoggle.md)                                                                                                                                 | With the TrackToggle component it is possible to mute and unmute your camera and microphone. The component uses an html button element under the hood so you can treat it like a button.                                                                                                                                                                                                                                       |
+| [VideoTrack({ onTrackClick, onClick, onSubscriptionStatusChanged, name, publication, source, ...props })](./react/component/videotrack.md)                                                              | The VideoTrack component is responsible for rendering participant video tracks like <code>camera</code> and <code>screen_share</code>. This component must have access to the participant's context, or alternatively pass it a <code>Participant</code> as a property.                                                                                                                                                        |
+
+## Prefabs
+
+| Prefab                                                                                                                                              | Description                                                                                                                                                                                                                                                                                                                                               |
+| --------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [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.                                                                                                                                                                                   |
+| [Chat({ messageFormatter, ...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.                                                                                                                                    |
+| [ControlBar({ variation, controls, ...props })](./react/component/controlbar.md)                                                                    | The ControlBar prefab component gives the user the basic user interface to control their media devices and leave the room.                                                                                                                                                                                                                                |
+| [MediaDeviceMenu({ kind, initialSelection, onActiveDeviceChange, tracks, requestPermissions, ...props })](./react/component/mediadevicemenu.md)     | The MediaDeviceMenu prefab component is a button that opens a menu that lists all media devices and allows the user to select them.                                                                                                                                                                                                                       |
+| [PreJoin({ defaults, onValidate, onSubmit, onError, debug, joinLabel, micLabel, camLabel, userLabel, ...htmlProps })](./react/component/prejoin.md) | The PreJoin 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 LiveKitRoom so that the user enters the room with the correct media devices. |
+| [VideoConference({ chatMessageFormatter, ...props })](./react/component/videoconference.md)                                                         | This component is the default setup of a classic LiveKit video conferencing app. It provides functionality like switching between participant grid view and focus view.                                                                                                                                                                                   |
+
+## Hooks
+
+| Hook                                                                                                                                                     | Description                                                                                                                                                                                                                                                                                                                                                                                                                                |
+| -------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| [useChat()](./react/hook/usechat.md)                                                                                                                     |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useChatToggle({ props })](./react/hook/usechattoggle.md)                                                                                                |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useClearPinButton(props)](./react/hook/useclearpinbutton.md)                                                                                            |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useConnectionQualityIndicator(options)](./react/hook/useconnectionqualityindicator.md)                                                                  |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useConnectionState(room)](./react/hook/useconnectionstate.md)                                                                                           | The <code>useConnectionState</code> hook allows you to simply implement your own <code>ConnectionState</code> component.                                                                                                                                                                                                                                                                                                                   |
+| [useCreateLayoutContext()](./react/hook/usecreatelayoutcontext.md)                                                                                       |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useDataChannel(topic, onMessage)](./react/hook/usedatachannel.md)                                                                                       |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useDataChannel(onMessage)](./react/hook/usedatachannel_1.md)                                                                                            |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useDisconnectButton(props)](./react/hook/usedisconnectbutton.md)                                                                                        |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useEnsureCreateLayoutContext(layoutContext)](./react/hook/useensurecreatelayoutcontext.md)                                                              |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useEnsureLayoutContext(layoutContext)](./react/hook/useensurelayoutcontext.md)                                                                          | Ensures that a layout context is provided, either via context or explicitly as a parameter. If not inside a <code>LayoutContext</code> and no layout context is provided, an error is thrown.                                                                                                                                                                                                                                              |
+| [useEnsureParticipant(participant)](./react/hook/useensureparticipant.md)                                                                                | Ensures that a participant is provided, either via context or explicitly as a parameter. If not inside a <code>ParticipantContext</code> and no participant is provided, an error is thrown.                                                                                                                                                                                                                                               |
+| [useEnsureRoom(room)](./react/hook/useensureroom.md)                                                                                                     | Ensures that a room is provided, either via context or explicitly as a parameter. If no room is provided, an error is thrown.                                                                                                                                                                                                                                                                                                              |
+| [useEnsureTrackReference(track)](./react/hook/useensuretrackreference.md)                                                                                | Ensures that a track reference is provided, either via context or explicitly as a parameter. If not inside a <code>TrackContext</code> and no track reference is provided, an error is thrown.                                                                                                                                                                                                                                             |
+| [useFocusToggle({ trackSource, participant, props })](./react/hook/usefocustoggle.md)                                                                    |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useGridLayout(gridElement, trackCount)](./react/hook/usegridlayout.md)                                                                                  | The useGridLayout hook tries to select the best layout to fit all tiles. If the available screen space is not enough, it will reduce the number of maximum visible tiles and select a layout that still works visually within the given limitations. As the order of tiles changes over time, the hook tries to keep visual updates to a minimum while trying to display important tiles such as speaking participants or screen shares.   |
+| [useIsMuted(source, options)](./react/hook/useismuted.md)                                                                                                |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useIsSpeaking(participant)](./react/hook/useisspeaking.md)                                                                                              |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useLayoutContext()](./react/hook/uselayoutcontext.md)                                                                                                   | Ensures that a layout context is provided via context. If no layout context is provided, an error is thrown.                                                                                                                                                                                                                                                                                                                               |
+| [useLiveKitRoom(props)](./react/hook/uselivekitroom.md)                                                                                                  |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useLocalParticipant(options)](./react/hook/uselocalparticipant.md)                                                                                      | The useLocalParticipant hook the state of the local participant.                                                                                                                                                                                                                                                                                                                                                                           |
+| [useLocalParticipantPermissions()](./react/hook/uselocalparticipantpermissions.md)                                                                       |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useMaybeLayoutContext()](./react/hook/usemaybelayoutcontext.md)                                                                                         | Returns a layout context from the <code>LayoutContext</code> if it exists, otherwise <code>undefined</code>.                                                                                                                                                                                                                                                                                                                               |
+| [useMaybeParticipantContext()](./react/hook/usemaybeparticipantcontext.md)                                                                               | Returns a participant from the <code>ParticipantContext</code> if it exists, otherwise <code>undefined</code>.                                                                                                                                                                                                                                                                                                                             |
+| [useMaybeRoomContext()](./react/hook/usemayberoomcontext.md)                                                                                             | Returns the room context if it exists, otherwise undefined.                                                                                                                                                                                                                                                                                                                                                                                |
+| [useMaybeTrackContext()](./react/hook/usemaybetrackcontext.md)                                                                                           | Returns a track reference from the <code>TrackContext</code> if it exists, otherwise <code>undefined</code>.                                                                                                                                                                                                                                                                                                                               |
+| [useMediaDevices({ kind })](./react/hook/usemediadevices.md)                                                                                             |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useMediaDeviceSelect({ kind, room, track, requestPermissions, })](./react/hook/usemediadeviceselect.md)                                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useMediaTrack(source, participant, options)](./react/hook/usemediatrack.md)                                                                             |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useMediaTrackByName(name, participant, options)](./react/hook/usemediatrackbyname.md)                                                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useParticipantContext()](./react/hook/useparticipantcontext.md)                                                                                         | Ensures that a participant is provided via context. If not inside a <code>ParticipantContext</code>, an error is thrown.                                                                                                                                                                                                                                                                                                                   |
+| [useParticipantInfo(props)](./react/hook/useparticipantinfo.md)                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useParticipantPermissions(options)](./react/hook/useparticipantpermissions.md)                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useParticipants(options)](./react/hook/useparticipants.md)                                                                                              | The useParticipants hook returns all participants (local and remote) of the current room.                                                                                                                                                                                                                                                                                                                                                  |
+| [useParticipantTile({ participant, source, publication, onParticipantClick, disableSpeakingIndicator, htmlProps, })](./react/hook/useparticipanttile.md) |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [usePinnedTracks(layoutContext)](./react/hook/usepinnedtracks.md)                                                                                        |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [usePreviewDevice(enabled, deviceId, kind)](./react/hook/usepreviewdevice.md)                                                                            |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useRemoteParticipant(identity, options)](./react/hook/useremoteparticipant.md)                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useRemoteParticipants(options)](./react/hook/useremoteparticipants.md)                                                                                  | The useRemoteParticipants                                                                                                                                                                                                                                                                                                                                                                                                                  |
+| [useRoomContext()](./react/hook/useroomcontext.md)                                                                                                       | Ensures that a room is provided via context. If no room is provided, an error is thrown.                                                                                                                                                                                                                                                                                                                                                   |
+| [useRoomInfo(options)](./react/hook/useroominfo.md)                                                                                                      |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useSortedParticipants(participants)](./react/hook/usesortedparticipants.md)                                                                             | The useSortedParticipants hook returns the only the active speakers of all participants.                                                                                                                                                                                                                                                                                                                                                   |
+| [useSpeakingParticipants()](./react/hook/usespeakingparticipants.md)                                                                                     | The useSpeakingParticipants hook returns the only the active speakers of all participants.                                                                                                                                                                                                                                                                                                                                                 |
+| [useToken(tokenEndpoint, roomName, options)](./react/hook/usetoken.md)                                                                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useTrackContext()](./react/hook/usetrackcontext.md)                                                                                                     | Ensures that a track reference is provided via context. If not inside a <code>TrackContext</code>, an error is thrown.                                                                                                                                                                                                                                                                                                                     |
+| [useTrackMutedIndicator(source, options)](./react/hook/usetrackmutedindicator.md)                                                                        |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useTracks(sources, options)](./react/hook/usetracks.md)                                                                                                 | The <code>useTracks</code> hook returns an array of <code>TrackReference</code> or <code>TrackReferenceOrPlaceholder</code> depending on the provided <code>sources</code> property. If only subscribed tracks are desired, set the <code>onlySubscribed</code> property to <code>true</code>.                                                                                                                                             |
+| [useTrackToggle({ source, onChange, initialState, captureOptions, ...rest })](./react/hook/usetracktoggle.md)                                            |                                                                                                                                                                                                                                                                                                                                                                                                                                            |
+| [useVisualStableUpdate(trackReferences, maxItemsOnPage, options)](./react/hook/usevisualstableupdate.md)                                                 | <p>**_(BETA)_** The useVisualStableUpdate hook tries to keep visual updates of the TackBundles array to a minimum, while still trying to display important tiles such as speaking participants or screen shares.</p><p>Updating works with pagination. For example, if a participant starts speaking on the second page, they will be moved to the first page by replacing the least active/interesting participant on the first page.</p> |
+
+## Others
+
+| Other                                                                             | Description                                                                                                                                     |
+| --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
+| [AllowAudioPlaybackProps](./react/allowaudioplaybackprops.md)                     |                                                                                                                                                 |
+| [AudioConferenceProps](./react/audioconferenceprops.md)                           |                                                                                                                                                 |
+| [AudioTrackProps](./react/audiotrackprops.md)                                     |                                                                                                                                                 |
+| [AudioVisualizerProps](./react/audiovisualizerprops.md)                           |                                                                                                                                                 |
+| [CarouselViewProps](./react/carouselviewprops.md)                                 |                                                                                                                                                 |
+| [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: |
+| [ChatProps](./react/chatprops.md)                                                 |                                                                                                                                                 |
+| [ChatToggleProps](./react/chattoggleprops.md)                                     |                                                                                                                                                 |
+| [ClearPinButtonProps](./react/clearpinbuttonprops.md)                             |                                                                                                                                                 |
+| [ConnectionQualityIndicatorOptions](./react/connectionqualityindicatoroptions.md) |                                                                                                                                                 |
+| [ConnectionQualityIndicatorProps](./react/connectionqualityindicatorprops.md)     |                                                                                                                                                 |
+| [ConnectionStateToastProps](./react/connectionstatetoastprops.md)                 |                                                                                                                                                 |
+| [ConnectionStatusProps](./react/connectionstatusprops.md)                         |                                                                                                                                                 |
+| [ControlBarControls](./react/controlbarcontrols.md)                               |                                                                                                                                                 |
+| [ControlBarProps](./react/controlbarprops.md)                                     |                                                                                                                                                 |
+| [DisconnectButtonProps](./react/disconnectbuttonprops.md)                         |                                                                                                                                                 |
+| [FocusLayoutContainerProps](./react/focuslayoutcontainerprops.md)                 |                                                                                                                                                 |
+| [FocusLayoutProps](./react/focuslayoutprops.md)                                   |                                                                                                                                                 |
+| [FocusToggleProps](./react/focustoggleprops.md)                                   |                                                                                                                                                 |
+| [GridLayoutProps](./react/gridlayoutprops.md)                                     |                                                                                                                                                 |
+| [LayoutContext](./react/layoutcontext.md)                                         |                                                                                                                                                 |
+| [LayoutContextType](./react/layoutcontexttype.md)                                 |                                                                                                                                                 |
+| [LiveKitRoomProps](./react/livekitroomprops.md)                                   |                                                                                                                                                 |
+| [LocalUserChoices](./react/localuserchoices.md)                                   |                                                                                                                                                 |
+| [MediaDeviceMenuProps](./react/mediadevicemenuprops.md)                           |                                                                                                                                                 |
+| [MediaDeviceSelectProps](./react/mediadeviceselectprops.md)                       |                                                                                                                                                 |
+| [MessageFormatter](./react/messageformatter.md)                                   |                                                                                                                                                 |
+| [ParticipantContext](./react/participantcontext.md)                               |                                                                                                                                                 |
+| [ParticipantLoopProps](./react/participantloopprops.md)                           |                                                                                                                                                 |
+| [ParticipantNameProps](./react/participantnameprops.md)                           |                                                                                                                                                 |
+| [ParticipantTileProps](./react/participanttileprops.md)                           |                                                                                                                                                 |
+| [PreJoinProps](./react/prejoinprops.md)                                           |                                                                                                                                                 |
+| [RoomContext](./react/roomcontext.md)                                             |                                                                                                                                                 |
+| [RoomNameProps](./react/roomnameprops.md)                                         |                                                                                                                                                 |
+| [TrackContext](./react/trackcontext.md)                                           |                                                                                                                                                 |
+| [TrackLoopProps](./react/trackloopprops.md)                                       |                                                                                                                                                 |
+| [TrackMutedIndicatorProps](./react/trackmutedindicatorprops.md)                   |                                                                                                                                                 |
+| [TrackToggleProps](./react/tracktoggleprops.md)                                   |                                                                                                                                                 |
+| [UseChatToggleProps](./react/usechattoggleprops.md)                               |                                                                                                                                                 |
+| [UseFocusToggleProps](./react/usefocustoggleprops.md)                             |                                                                                                                                                 |
+| [UseIsMutedOptions](./react/useismutedoptions.md)                                 |                                                                                                                                                 |
+| [UseLocalParticipantOptions](./react/uselocalparticipantoptions.md)               |                                                                                                                                                 |
+| [UseMediaDeviceSelectProps](./react/usemediadeviceselectprops.md)                 |                                                                                                                                                 |
+| [UseMediaTrackOptions](./react/usemediatrackoptions.md)                           |                                                                                                                                                 |
+| [UseParticipantInfoOptions](./react/useparticipantinfooptions.md)                 |                                                                                                                                                 |
+| [UseParticipantPermissionsOptions](./react/useparticipantpermissionsoptions.md)   |                                                                                                                                                 |
+| [UseParticipantsOptions](./react/useparticipantsoptions.md)                       |                                                                                                                                                 |
+| [UseParticipantTileProps](./react/useparticipanttileprops.md)                     |                                                                                                                                                 |
+| [UseRemoteParticipantOptions](./react/useremoteparticipantoptions.md)             |                                                                                                                                                 |
+| [UseRemoteParticipantsOptions](./react/useremoteparticipantsoptions.md)           |                                                                                                                                                 |
+| [UserInfo](./react/userinfo.md)                                                   |                                                                                                                                                 |
+| [UseRoomInfoOptions](./react/useroominfooptions.md)                               |                                                                                                                                                 |
+| [UseTokenOptions](./react/usetokenoptions.md)                                     |                                                                                                                                                 |
+| [UseTrackMutedIndicatorOptions](./react/usetrackmutedindicatoroptions.md)         |                                                                                                                                                 |
+| [UseTracksHookReturnType](./react/usetrackshookreturntype.md)                     |                                                                                                                                                 |
+| [UseTracksOptions](./react/usetracksoptions.md)                                   |                                                                                                                                                 |
+| [UseTrackToggleProps](./react/usetracktoggleprops.md)                             |                                                                                                                                                 |
+| [UseVisualStableUpdateOptions](./react/usevisualstableupdateoptions.md)           |                                                                                                                                                 |
+| [VideoConferenceProps](./react/videoconferenceprops.md)                           |                                                                                                                                                 |
+| [VideoTrackProps](./react/videotrackprops.md)                                     |                                                                                                                                                 |

package/generated-docs/react/layoutcontext.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## LayoutContext variable
+
+**Signature:**
+
+```typescript
+LayoutContext: React.Context<LayoutContextType | undefined>;
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/react/layoutcontexttype.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## LayoutContextType type
+
+**Signature:**
+
+```typescript
+export type LayoutContextType = {
+  pin: PinContextType;
+  widget: ChatContextType;
+};
+```
+
+{% partial file="p_usage.md" /%}

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## LiveKitRoomProps.audio property
+
+Publish audio immediately after connecting to your LiveKit room.
+
+**Signature:**
+
+```typescript
+audio?: AudioCaptureOptions | boolean;
+```
+
+{% partial file="p_usage.md" /%}

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## LiveKitRoomProps.connect property
+
+If set to true a connection to LiveKit room is initiated.
+
+**Signature:**
+
+```typescript
+connect?: boolean;
+```
+
+{% partial file="p_usage.md" /%}

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## LiveKitRoomProps.connectOptions property
+
+Define options how to connect to the LiveKit server.
+
+**Signature:**
+
+```typescript
+connectOptions?: RoomConnectOptions;
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/react/livekitroomprops.md

@@ -0,0 +1,32 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## LiveKitRoomProps interface
+
+**Signature:**
+
+```typescript
+export interface LiveKitRoomProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'onError'>
+```
+
+**Extends:** Omit&lt;React.HTMLAttributes&lt;HTMLDivElement&gt;, 'onError'&gt;
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                                                  | Type                                      | Description                                                                                                                                                                                                                                                                                                   |
+| ------------------------------------------------------------------------- | ----------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [audio?](./react/livekitroomprops.audio.md)                               | AudioCaptureOptions \| boolean            | _(Optional)_ Publish audio immediately after connecting to your LiveKit room.                                                                                                                                                                                                                                 |
+| [connect?](./react/livekitroomprops.connect.md)                           | boolean                                   | _(Optional)_ If set to true a connection to LiveKit room is initiated.                                                                                                                                                                                                                                        |
+| [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)_                                                                                                                                                                                                                                                                                                  |
+| [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.                                                                                                              |
+| [room?](./react/livekitroomprops.room.md)                                 | Room                                      | _(Optional)_ Optional room instance. By passing your own room instance you overwrite the <code>options</code> parameter, make sure to set the options directly on the room instance itself.                                                                                                                   |
+| [screen?](./react/livekitroomprops.screen.md)                             | ScreenShareCaptureOptions \| boolean      | _(Optional)_ Publish screen share immediately after connecting to your LiveKit room.                                                                                                                                                                                                                          |
+| [serverUrl](./react/livekitroomprops.serverurl.md)                        | string \| undefined                       | URL to the LiveKit server. For example: <code>wss://&lt;domain&gt;.livekit.cloud</code> To simplify the implementation, <code>undefined</code> is also accepted as an intermediate value, but only with a valid string url can the connection be established.                                                 |
+| [simulateParticipants?](./react/livekitroomprops.simulateparticipants.md) | number \| undefined                       | _(Optional)_                                                                                                                                                                                                                                                                                                  |
+| [token](./react/livekitroomprops.token.md)                                | string \| undefined                       | 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, <code>undefined</code> is also accepted as an intermediate value, but only with a valid string token can the connection be established. |
+| [video?](./react/livekitroomprops.video.md)                               | VideoCaptureOptions \| boolean            | _(Optional)_ Publish video immediately after connecting to your LiveKit room.                                                                                                                                                                                                                                 |

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

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## LiveKitRoomProps.onConnected property
+
+**Signature:**
+
+```typescript
+onConnected?: () => void;
+```

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

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## LiveKitRoomProps.onDisconnected property
+
+**Signature:**
+
+```typescript
+onDisconnected?: () => void;
+```

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

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

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

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## LiveKitRoomProps.onMediaDeviceFailure property
+
+**Signature:**
+
+```typescript
+onMediaDeviceFailure?: (failure?: MediaDeviceFailure) => void;
+```

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## 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.
+
+**Signature:**
+
+```typescript
+options?: RoomOptions;
+```
+
+{% partial file="p_usage.md" /%}

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## 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.
+
+**Signature:**
+
+```typescript
+room?: Room;
+```
+
+{% partial file="p_usage.md" /%}

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## LiveKitRoomProps.screen property
+
+Publish screen share immediately after connecting to your LiveKit room.
+
+**Signature:**
+
+```typescript
+screen?: ScreenShareCaptureOptions | boolean;
+```
+
+{% partial file="p_usage.md" /%}

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## 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.
+
+**Signature:**
+
+```typescript
+serverUrl: string | undefined;
+```
+
+{% partial file="p_usage.md" /%}

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

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## LiveKitRoomProps.simulateParticipants property
+
+**Signature:**
+
+```typescript
+simulateParticipants?: number | undefined;
+```

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## 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.
+
+**Signature:**
+
+```typescript
+token: string | undefined;
+```
+
+{% partial file="p_usage.md" /%}

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## LiveKitRoomProps.video property
+
+Publish video immediately after connecting to your LiveKit room.
+
+**Signature:**
+
+```typescript
+video?: VideoCaptureOptions | boolean;
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/react/localuserchoices.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## LocalUserChoices type
+
+**Signature:**
+
+```typescript
+export type LocalUserChoices = {
+  username: string;
+  videoEnabled: boolean;
+  audioEnabled: boolean;
+  videoDeviceId: string;
+  audioDeviceId: string;
+};
+```
+
+{% partial file="p_usage.md" /%}

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

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## MediaDeviceMenuProps.initialSelection property
+
+**Signature:**
+
+```typescript
+initialSelection?: string;
+```

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

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## MediaDeviceMenuProps.kind property
+
+**Signature:**
+
+```typescript
+kind?: MediaDeviceKind;
+```

package/generated-docs/react/mediadevicemenuprops.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## MediaDeviceMenuProps interface
+
+**Signature:**
+
+```typescript
+export interface MediaDeviceMenuProps extends React.ButtonHTMLAttributes<HTMLButtonElement>
+```
+
+**Extends:** React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt;
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                                                      | Type                                                                                          | Description                                                                                                                                                                                                                                                                                                                                              |
+| ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [initialSelection?](./react/mediadevicemenuprops.initialselection.md)         | string                                                                                        | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
+| [kind?](./react/mediadevicemenuprops.kind.md)                                 | MediaDeviceKind                                                                               | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
+| [onActiveDeviceChange?](./react/mediadevicemenuprops.onactivedevicechange.md) | (kind: MediaDeviceKind, deviceId: string) =&gt; void                                          | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
+| [requestPermissions?](./react/mediadevicemenuprops.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. |
+| [tracks?](./react/mediadevicemenuprops.tracks.md)                             | Partial&lt;Record&lt;MediaDeviceKind, LocalAudioTrack \| LocalVideoTrack \| undefined&gt;&gt; | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |