@livekit/components-js-docs 0.1.0 → 0.1.2

package/generated-docs/react/participanttileprops.md

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

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

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

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

@@ -1,10 +1,18 @@
+---
+{ "title": "ParticipantTileProps.participant property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ParticipantTileProps.participant property
+# ParticipantTileProps.participant property
+
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+This parameter will be removed in a future version use `trackRef` instead.
 
-> Warning: This API is now obsolete.
->
-> This parameter will be removed in a future version use `trackRef` instead.
+{% /callout %}
 
 **Signature:**
 

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

@@ -1,10 +1,18 @@
+---
+{ "title": "ParticipantTileProps.publication property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ParticipantTileProps.publication property
+# ParticipantTileProps.publication property
+
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+This parameter will be removed in a future version use `trackRef` instead.
 
-> Warning: This API is now obsolete.
->
-> This parameter will be removed in a future version use `trackRef` instead.
+{% /callout %}
 
 **Signature:**
 

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

@@ -1,10 +1,18 @@
+---
+{ "title": "ParticipantTileProps.source property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ParticipantTileProps.source property
+# ParticipantTileProps.source property
+
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+This parameter will be removed in a future version use `trackRef` instead.
 
-> Warning: This API is now obsolete.
->
-> This parameter will be removed in a future version use `trackRef` instead.
+{% /callout %}
 
 **Signature:**
 

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

@@ -1,6 +1,10 @@
+---
+{ "title": "ParticipantTileProps.trackRef property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## ParticipantTileProps.trackRef property
+# ParticipantTileProps.trackRef property
 
 The track reference to display.
 

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

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

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

@@ -1,6 +1,10 @@
+---
+{ "title": "PreJoinProps.debug property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## PreJoinProps.debug property
+# PreJoinProps.debug property
 
 Display a debug window for your convenience.
 

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

@@ -1,6 +1,10 @@
+---
+{ "title": "PreJoinProps.defaults property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## PreJoinProps.defaults property
+# PreJoinProps.defaults property
 
 Prefill the input form with initial values.
 

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

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

package/generated-docs/react/prejoinprops.md

@@ -1,6 +1,15 @@
+---
+{
+  "title": "PreJoinProps interface",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/prefabs/PreJoin.tsx"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## PreJoinProps interface
+# PreJoinProps interface
+
+Props for the PreJoin component.
 
 **Signature:**
 
@@ -14,15 +23,16 @@ export interface PreJoinProps extends Omit<React.HTMLAttributes<HTMLDivElement>,
 
 ## Properties
 
-| Property                                                    | Type                                                                            | Description                                                                                                                                |
-| ----------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
-| [camLabel?](./react/prejoinprops.camlabel.md)               | string                                                                          | _(Optional)_                                                                                                                               |
-| [debug?](./react/prejoinprops.debug.md)                     | boolean                                                                         | _(Optional)_ Display a debug window for your convenience.                                                                                  |
-| [defaults?](./react/prejoinprops.defaults.md)               | Partial&lt;[LocalUserChoices](./react/localuserchoices.md)<!-- -->&gt;          | _(Optional)_ Prefill the input form with initial values.                                                                                   |
-| [joinLabel?](./react/prejoinprops.joinlabel.md)             | string                                                                          | _(Optional)_                                                                                                                               |
-| [micLabel?](./react/prejoinprops.miclabel.md)               | string                                                                          | _(Optional)_                                                                                                                               |
-| [onError?](./react/prejoinprops.onerror.md)                 | (error: Error) =&gt; void                                                       | _(Optional)_                                                                                                                               |
-| [onSubmit?](./react/prejoinprops.onsubmit.md)               | (values: [LocalUserChoices](./react/localuserchoices.md)<!-- -->) =&gt; void    | _(Optional)_ This function is called with the <code>LocalUserChoices</code> if validation is passed.                                       |
-| [onValidate?](./react/prejoinprops.onvalidate.md)           | (values: [LocalUserChoices](./react/localuserchoices.md)<!-- -->) =&gt; boolean | _(Optional)_ Provide your custom validation function. Only if validation is successful the user choices are past to the onSubmit callback. |
-| [showE2EEOptions?](./react/prejoinprops.showe2eeoptions.md) | boolean                                                                         | _(Optional)_                                                                                                                               |
-| [userLabel?](./react/prejoinprops.userlabel.md)             | string                                                                          | _(Optional)_                                                                                                                               |
+| Property                                                          | Type                                                                           | Description                                                                                                                                |
+| ----------------------------------------------------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------ |
+| [camLabel?](./react/prejoinprops.camlabel.md)                     | string                                                                         | _(Optional)_                                                                                                                               |
+| [debug?](./react/prejoinprops.debug.md)                           | boolean                                                                        | _(Optional)_ Display a debug window for your convenience.                                                                                  |
+| [defaults?](./react/prejoinprops.defaults.md)                     | Partial&lt;[LocalUserChoices](./core/localuserchoices.md)<!-- -->&gt;          | _(Optional)_ Prefill the input form with initial values.                                                                                   |
+| [joinLabel?](./react/prejoinprops.joinlabel.md)                   | string                                                                         | _(Optional)_                                                                                                                               |
+| [micLabel?](./react/prejoinprops.miclabel.md)                     | string                                                                         | _(Optional)_                                                                                                                               |
+| [onError?](./react/prejoinprops.onerror.md)                       | (error: Error) =&gt; void                                                      | _(Optional)_                                                                                                                               |
+| [onSubmit?](./react/prejoinprops.onsubmit.md)                     | (values: [LocalUserChoices](./core/localuserchoices.md)<!-- -->) =&gt; void    | _(Optional)_ This function is called with the <code>LocalUserChoices</code> if validation is passed.                                       |
+| [onValidate?](./react/prejoinprops.onvalidate.md)                 | (values: [LocalUserChoices](./core/localuserchoices.md)<!-- -->) =&gt; boolean | _(Optional)_ Provide your custom validation function. Only if validation is successful the user choices are past to the onSubmit callback. |
+| [persistUserChoices?](./react/prejoinprops.persistuserchoices.md) | boolean                                                                        | _(Optional)_ If true, user choices are persisted across sessions.                                                                          |
+| [showE2EEOptions?](./react/prejoinprops.showe2eeoptions.md)       | boolean                                                                        | _(Optional)_                                                                                                                               |
+| [userLabel?](./react/prejoinprops.userlabel.md)                   | string                                                                         | _(Optional)_                                                                                                                               |

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

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

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

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

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

@@ -1,6 +1,10 @@
+---
+{ "title": "PreJoinProps.onSubmit property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## PreJoinProps.onSubmit property
+# PreJoinProps.onSubmit property
 
 This function is called with the `LocalUserChoices` if validation is passed.
 

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

@@ -1,6 +1,10 @@
+---
+{ "title": "PreJoinProps.onValidate property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## PreJoinProps.onValidate property
+# PreJoinProps.onValidate property
 
 Provide your custom validation function. Only if validation is successful the user choices are past to the onSubmit callback.
 

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

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

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

@@ -1,9 +1,23 @@
+---
+{ "title": "PreJoinProps.showE2EEOptions property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## PreJoinProps.showE2EEOptions property
+# PreJoinProps.showE2EEOptions property
+
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+E2EE options will be removed from PreJoin in a future version \*
+
+{% /callout %}
 
 **Signature:**
 
 ```typescript
 showE2EEOptions?: boolean;
 ```
+
+{% partial file="p_usage.md" variables={exampleCount: 0} /%}

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

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

package/generated-docs/react/roomaudiorendererprops.md

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

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

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

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

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

package/generated-docs/react/roomcontext.md

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

package/generated-docs/react/roomnameprops.childrenposition.md

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

package/generated-docs/react/roomnameprops.md

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

package/generated-docs/react/trackcontext.md

@@ -1,10 +1,21 @@
+---
+{
+  "title": "TrackContext variable",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/context/track-reference-context.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## TrackContext variable
+# TrackContext variable
+
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+`TrackContext` has been renamed to `TrackRefContext`<!-- -->, use this as a drop in replacement.
 
-> Warning: This API is now obsolete.
->
-> `TrackContext` has been to `TrackRefContext`<!-- -->, use this as a drop in replacement.
+{% /callout %}
 
 **Signature:**
 

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

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

package/generated-docs/react/trackloopprops.md

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

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

@@ -1,6 +1,10 @@
+---
+{ "title": "TrackLoopProps.tracks property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## TrackLoopProps.tracks property
+# TrackLoopProps.tracks property
 
 Track references to loop over. You can the use `useTracks()` hook to get TrackReferences.
 

package/generated-docs/react/trackmutedindicatorprops.md

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

package/generated-docs/react/trackmutedindicatorprops.participant.md

@@ -1,10 +1,18 @@
+---
+{ "title": "TrackMutedIndicatorProps.participant property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## TrackMutedIndicatorProps.participant property
+# TrackMutedIndicatorProps.participant property
+
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+This parameter will be removed in a future version use `trackRef` instead.
 
-> Warning: This API is now obsolete.
->
-> This parameter will be removed in a future version use `trackRef` instead.
+{% /callout %}
 
 **Signature:**
 

package/generated-docs/react/trackmutedindicatorprops.show.md

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

package/generated-docs/react/trackmutedindicatorprops.source.md

@@ -1,10 +1,18 @@
+---
+{ "title": "TrackMutedIndicatorProps.source property" }
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## TrackMutedIndicatorProps.source property
+# TrackMutedIndicatorProps.source property
+
+{% callout type="caution" variation="normal" %}
+
+This API is deprecated:
+
+This parameter will be removed in a future version use `trackRef` instead.
 
-> Warning: This API is now obsolete.
->
-> This parameter will be removed in a future version use `trackRef` instead.
+{% /callout %}
 
 **Signature:**
 

package/generated-docs/react/trackmutedindicatorprops.trackref.md

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

package/generated-docs/react/trackrefcontext.md

@@ -1,6 +1,13 @@
+---
+{
+  "title": "TrackRefContext variable",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/context/track-reference-context.ts"
+}
+---
+
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-## TrackRefContext variable
+# TrackRefContext variable
 
 This context provides a `TrackReferenceOrPlaceholder` to all child components.
 

package/generated-docs/react/tracktoggleprops.captureoptions.md

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

package/generated-docs/react/tracktoggleprops.initialstate.md

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

package/generated-docs/react/tracktoggleprops.md

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