@livekit/components-js-docs 0.1.1 → 0.1.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/generated-docs/core/createurlregexp.md

@@ -1,16 +1,16 @@
 ---
 {
-  "title": "createUrlRegExp variable",
-  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/urlRegex.ts"
+  "title": "createUrlRegExp",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/helper/url-regex.ts"
 }
 ---
 
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# createUrlRegExp variable
+# createUrlRegExp
 
 **Signature:**
 
 ```typescript
-createUrlRegExp: (options: RegExOptions) => RegExp;
+export declare function createUrlRegExp(options: RegExOptions): RegExp;
 ```

package/generated-docs/core/index.md

@@ -32,7 +32,7 @@
 | [createIsSpeakingObserver(participant)](./core/createisspeakingobserver.md)                          |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [createMediaDeviceObserver(kind, requestPermissions)](./core/createmediadeviceobserver.md)           |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [createTrackObserver(participant, options)](./core/createtrackobserver.md)                           |                                                                                                                                                                                                                                                                                                                                                                                                             |
-| [createUrlRegExp](./core/createurlregexp.md)                                                         |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [createUrlRegExp(options)](./core/createurlregexp.md)                                                |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [cssPrefix](./core/cssprefix.md)                                                                     |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [DataSendOptions](./core/datasendoptions.md)                                                         |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [DataTopic](./core/datatopic.md)                                                                     |                                                                                                                                                                                                                                                                                                                                                                                                             |
@@ -53,6 +53,8 @@
 | [isTrackReference(trackReference)](./core/istrackreference.md)                                       |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [isTrackReferencePinned(trackReference, pinState)](./core/istrackreferencepinned.md)                 | Check if the <code>TrackReference</code> is pinned.                                                                                                                                                                                                                                                                                                                                                         |
 | [isTrackReferencePlaceholder(trackReference)](./core/istrackreferenceplaceholder.md)                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [loadUserChoices(defaults, preventLoad)](./core/loaduserchoices.md)                                  | Reads the user choices from local storage, or returns the default settings if none are found.                                                                                                                                                                                                                                                                                                               |
+| [LocalUserChoices](./core/localuserchoices.md)                                                       | Represents the user's choices for video and audio input devices, as well as their username.                                                                                                                                                                                                                                                                                                                 |
 | [log](./core/log.md)                                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [MediaToggleType](./core/mediatoggletype.md)                                                         |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [MessageDecoder](./core/messagedecoder.md)                                                           |                                                                                                                                                                                                                                                                                                                                                                                                             |
@@ -77,6 +79,7 @@
 | [roomEventSelector(room, event)](./core/roomeventselector.md)                                        |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [roomInfoObserver(room)](./core/roominfoobserver.md)                                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [roomObserver(room)](./core/roomobserver.md)                                                         |                                                                                                                                                                                                                                                                                                                                                                                                             |
+| [saveUserChoices(userChoices, preventSave)](./core/saveuserchoices.md)                               | Saves user choices to local storage.                                                                                                                                                                                                                                                                                                                                                                        |
 | [screenShareObserver(room)](./core/screenshareobserver.md)                                           |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [ScreenShareTrackMap](./core/screensharetrackmap.md)                                                 |                                                                                                                                                                                                                                                                                                                                                                                                             |
 | [selectGridLayout(layouts, participantCount, width, height)](./core/selectgridlayout.md)             |                                                                                                                                                                                                                                                                                                                                                                                                             |

package/generated-docs/core/loaduserchoices.md

@@ -0,0 +1,27 @@
+---
+{
+  "title": "loadUserChoices",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/persistent-storage/user-choices.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# loadUserChoices
+
+Reads the user choices from local storage, or returns the default settings if none are found.
+
+**Signature:**
+
+```typescript
+export declare function loadUserChoices(
+  defaults?: Partial<LocalUserChoices>,
+  preventLoad?: boolean
+): LocalUserChoices;
+```
+
+## Remarks
+
+The deprecated parameters `e2ee` and `sharedPassphrase` are not read from local storage and always return the value from the passed `defaults` or internal defaults.
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/{react → core}/localuserchoices.md

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

package/generated-docs/core/saveuserchoices.md

@@ -0,0 +1,20 @@
+---
+{
+  "title": "saveUserChoices",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/core/src/persistent-storage/user-choices.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# saveUserChoices
+
+Saves user choices to local storage.
+
+**Signature:**
+
+```typescript
+export declare function saveUserChoices(userChoices: LocalUserChoices, preventSave?: boolean): void;
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/audiotrackprops.md

@@ -12,21 +12,22 @@
 **Signature:**
 
 ```typescript
-export interface AudioTrackProps<T extends HTMLMediaElement = HTMLMediaElement> extends React.HTMLAttributes<T>
+export interface AudioTrackProps extends React.AudioHTMLAttributes<HTMLAudioElement>
 ```
 
-**Extends:** React.HTMLAttributes&lt;T&gt;
+**Extends:** React.AudioHTMLAttributes&lt;HTMLAudioElement&gt;
 
 {% partial file="p_usage.md" variables={exampleCount: 0} /%}
 
 ## Properties
 
-| Property                                                                               | Type                                       | Description                                                                           |
-| -------------------------------------------------------------------------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------- |
-| [name?](./react/audiotrackprops.name.md)                                               | string                                     | _(Optional)_                                                                          |
-| [onSubscriptionStatusChanged?](./react/audiotrackprops.onsubscriptionstatuschanged.md) | (subscribed: boolean) =&gt; void           | _(Optional)_                                                                          |
-| [participant?](./react/audiotrackprops.participant.md)                                 | Participant                                | _(Optional)_                                                                          |
-| [publication?](./react/audiotrackprops.publication.md)                                 | TrackPublication                           | _(Optional)_                                                                          |
-| [source?](./react/audiotrackprops.source.md)                                           | Track.Source                               | _(Optional)_                                                                          |
-| [trackRef?](./react/audiotrackprops.trackref.md)                                       | [TrackReference](./core/trackreference.md) | _(Optional)_ The track reference of the track from which the audio is to be rendered. |
-| [volume?](./react/audiotrackprops.volume.md)                                           | number                                     | _(Optional)_ by the default the range is between 0 and 1                              |
+| Property                                                                               | Type                                       | Description                                                                                                              |
+| -------------------------------------------------------------------------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
+| [muted?](./react/audiotrackprops.muted.md)                                             | boolean                                    | _(Optional)_ Mutes the audio track if set to <code>true</code>.                                                          |
+| [name?](./react/audiotrackprops.name.md)                                               | string                                     | _(Optional)_                                                                                                             |
+| [onSubscriptionStatusChanged?](./react/audiotrackprops.onsubscriptionstatuschanged.md) | (subscribed: boolean) =&gt; void           | _(Optional)_                                                                                                             |
+| [participant?](./react/audiotrackprops.participant.md)                                 | Participant                                | _(Optional)_                                                                                                             |
+| [publication?](./react/audiotrackprops.publication.md)                                 | TrackPublication                           | _(Optional)_                                                                                                             |
+| [source?](./react/audiotrackprops.source.md)                                           | Track.Source                               | _(Optional)_                                                                                                             |
+| [trackRef?](./react/audiotrackprops.trackref.md)                                       | [TrackReference](./core/trackreference.md) | _(Optional)_ The track reference of the track from which the audio is to be rendered.                                    |
+| [volume?](./react/audiotrackprops.volume.md)                                           | number                                     | _(Optional)_ Sets the volume of the audio track. By default, the range is between <code>0.0</code> and <code>1.0</code>. |

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

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

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

@@ -6,7 +6,7 @@
 
 # AudioTrackProps.volume property
 
-by the default the range is between 0 and 1
+Sets the volume of the audio track. By default, the range is between `0.0` and `1.0`<!-- -->.
 
 **Signature:**
 

package/generated-docs/react/component/audiotrack.md

@@ -29,6 +29,11 @@ import { AudioTrack } from "@livekit/components-react";
 
 ## Properties
 
+{% parameter name="muted" type="boolean" optional=true %}
+_(Optional)_ Mutes the audio track if set to `true`<!-- -->.
+
+{% /parameter %}
+
 {% parameter name="onSubscriptionStatusChanged" type="(subscribed: boolean) => void" optional=true %}
 _(Optional)_
 
@@ -40,7 +45,7 @@ _(Optional)_ The track reference of the track from which the audio is to be rend
 {% /parameter %}
 
 {% parameter name="volume" type="number" optional=true %}
-_(Optional)_ by the default the range is between 0 and 1
+_(Optional)_ Sets the volume of the audio track. By default, the range is between `0.0` and `1.0`<!-- -->.
 
 {% /parameter %}
 

package/generated-docs/react/component/controlbar.md

@@ -38,6 +38,11 @@ _(Optional)_
 
 {% /parameter %}
 
+{% parameter name="saveUserChoices" type="boolean" optional=true %}
+_(Optional)_ If `true`<!-- -->, the user's device choices will be persisted. This will enables the user to have the same device choices when they rejoin the room.
+
+{% /parameter %}
+
 {% parameter name="variation" type="'minimal' | 'verbose' | 'textOnly'" optional=true %}
 _(Optional)_
 

package/generated-docs/react/component/layoutcontextprovider.md

@@ -0,0 +1,35 @@
+---
+{
+  "title": "LayoutContextProvider",
+  "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. -->
+
+# LayoutContextProvider
+
+## Import
+
+```typescript
+import { LayoutContextProvider } from "@livekit/components-react";
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+{% parameter name="onPinChange" type="(state: PinState) => void" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="onWidgetChange" type="(state: WidgetState) => void" optional=true %}
+_(Optional)_
+
+{% /parameter %}
+
+{% parameter name="value" type="LayoutContextType" optional=true %}
+_(Optional)_
+
+{% /parameter %}

package/generated-docs/react/component/prejoin.md

@@ -19,7 +19,7 @@ import { PreJoin } from "@livekit/components-react";
 
 ## Remarks
 
-This component is independent from the `LiveKitRoom` component and don't has to be nested inside it. Because it only access the local media tracks this component is self contained and works without connection to the LiveKit server.
+This component is independent of the `LiveKitRoom` component and should not be nested within it. Because it only access the local media tracks this component is self contained and works without connection to the LiveKit server.
 
 ## Usage
 
@@ -71,8 +71,8 @@ _(Optional)_ Provide your custom validation function. Only if validation is succ
 
 {% /parameter %}
 
-{% parameter name="showE2EEOptions" type="boolean" optional=true %}
-_(Optional)_
+{% parameter name="persistUserChoices" type="boolean" optional=true %}
+_(Optional)_ If true, user choices are persisted across sessions.
 
 {% /parameter %}
 
@@ -80,3 +80,12 @@ _(Optional)_
 _(Optional)_
 
 {% /parameter %}
+
+{% parameter name="showE2EEOptions" type="boolean" optional=true deprecated=true %}
+_(Optional)_
+
+{% callout type="caution" variation="compact" %}
+E2EE options will be removed from PreJoin in a future version \*
+
+{% /callout %}
+{% /parameter %}

package/generated-docs/react/component/roomaudiorenderer.md

@@ -26,3 +26,15 @@ import { RoomAudioRenderer } from "@livekit/components-react";
 ```
 
 {% partial file="p_usage.md" variables={exampleCount: 1} /%}
+
+## Properties
+
+{% parameter name="muted" type="boolean" optional=true %}
+_(Optional)_ If set to `true`<!-- -->, mutes all audio tracks rendered by the component.
+
+{% /parameter %}
+
+{% parameter name="volume" type="number" optional=true %}
+_(Optional)_ Sets the volume for all audio tracks rendered by this component. By default, the range is between `0.0` and `1.0`<!-- -->.
+
+{% /parameter %}

package/generated-docs/react/controlbarprops.md

@@ -21,7 +21,8 @@ export interface ControlBarProps extends React.HTMLAttributes<HTMLDivElement>
 
 ## Properties
 
-| Property                                           | Type                                                | Description  |
-| -------------------------------------------------- | --------------------------------------------------- | ------------ |
-| [controls?](./react/controlbarprops.controls.md)   | [ControlBarControls](./react/controlbarcontrols.md) | _(Optional)_ |
-| [variation?](./react/controlbarprops.variation.md) | 'minimal' \| 'verbose' \| 'textOnly'                | _(Optional)_ |
+| Property                                                       | Type                                                | Description                                                                                                                                                           |
+| -------------------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [controls?](./react/controlbarprops.controls.md)               | [ControlBarControls](./react/controlbarcontrols.md) | _(Optional)_                                                                                                                                                          |
+| [saveUserChoices?](./react/controlbarprops.saveuserchoices.md) | boolean                                             | _(Optional)_ If <code>true</code>, the user's device choices will be persisted. This will enables the user to have the same device choices when they rejoin the room. |
+| [variation?](./react/controlbarprops.variation.md)             | 'minimal' \| 'verbose' \| 'textOnly'                | _(Optional)_                                                                                                                                                          |

package/generated-docs/react/controlbarprops.saveuserchoices.md

@@ -0,0 +1,17 @@
+---
+{ "title": "ControlBarProps.saveUserChoices property" }
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# ControlBarProps.saveUserChoices property
+
+If `true`<!-- -->, the user's device choices will be persisted. This will enables the user to have the same device choices when they rejoin the room.
+
+**Signature:**
+
+```typescript
+saveUserChoices?: boolean;
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

package/generated-docs/react/hook/useaudioplayback.md

@@ -0,0 +1,34 @@
+---
+{
+  "title": "useAudioPlayback",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useAudioPlayback.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useAudioPlayback
+
+In many browsers to start audio playback, the user must perform a user-initiated event such as clicking a button. The `useAudioPlayback` hook returns an object with a boolean `canPlayAudio` flag that indicates whether audio playback is allowed in the current context, as well as a `startAudio` function that can be called in a button `onClick` callback to start audio playback in the current context.
+
+## Import
+
+```typescript
+import { useAudioPlayback } from "@livekit/components-react";
+```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}
+
+## Properties
+
+{% parameter name="room" type="Room" optional=true %}
+{% /parameter %}
+
+## Returns
+
+```typescript
+{
+  canPlayAudio: boolean;
+  startAudio: () => Promise<void>;
+}
+```

package/generated-docs/react/hook/usechat.md

@@ -36,7 +36,7 @@ It is possible to pass configurations for custom message encoding and decoding.
 ```typescript
 {
     send: ((message: string) => Promise<void>) | undefined;
-    chatMessages: import("@livekit/components-core").ReceivedChatMessage[];
+    chatMessages: ReceivedChatMessage[];
     isSending: boolean;
 }
 ```