@livekit/components-js-docs 0.0.2

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

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

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## MediaDeviceMenuProps.requestPermissions property
+
+this will call getUserMedia if the permissions are not yet given to enumerate the devices with device labels. in some browsers multiple calls to getUserMedia result in multiple permission prompts. It's generally advised only flip this to true, once a (preview) track has been acquired successfully with the appropriate permissions.
+
+**Signature:**
+
+```typescript
+requestPermissions?: boolean;
+```
+
+{% partial file="p_usage.md" /%}

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

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

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## MediaDeviceSelectProps.exactMatch property
+
+will force the browser to only return the specified device will call `onDeviceSelectError` with the error in case this fails
+
+**Signature:**
+
+```typescript
+exactMatch?: boolean;
+```
+
+{% partial file="p_usage.md" /%}

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

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

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

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

package/generated-docs/react/mediadeviceselectprops.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## MediaDeviceSelectProps interface
+
+**Signature:**
+
+```typescript
+export interface MediaDeviceSelectProps extends React.HTMLAttributes<HTMLUListElement>
+```
+
+**Extends:** React.HTMLAttributes&lt;HTMLUListElement&gt;
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                                                        | Type                                      | Description                                                                                                                                                                                                                                                                                                                                              |
+| ------------------------------------------------------------------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [exactMatch?](./react/mediadeviceselectprops.exactmatch.md)                     | boolean                                   | _(Optional)_ will force the browser to only return the specified device will call <code>onDeviceSelectError</code> with the error in case this fails                                                                                                                                                                                                     |
+| [initialSelection?](./react/mediadeviceselectprops.initialselection.md)         | string                                    | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
+| [kind](./react/mediadeviceselectprops.kind.md)                                  | MediaDeviceKind                           |                                                                                                                                                                                                                                                                                                                                                          |
+| [onActiveDeviceChange?](./react/mediadeviceselectprops.onactivedevicechange.md) | (deviceId: string) =&gt; void             | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
+| [onDeviceListChange?](./react/mediadeviceselectprops.ondevicelistchange.md)     | (devices: MediaDeviceInfo\[\]) =&gt; void | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
+| [onDeviceSelectError?](./react/mediadeviceselectprops.ondeviceselecterror.md)   | (e: Error) =&gt; void                     | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
+| [requestPermissions?](./react/mediadeviceselectprops.requestpermissions.md)     | boolean                                   | _(Optional)_ this will call getUserMedia if the permissions are not yet given to enumerate the devices with device labels. in some browsers multiple calls to getUserMedia result in multiple permission prompts. It's generally advised only flip this to true, once a (preview) track has been acquired successfully with the appropriate permissions. |
+| [track?](./react/mediadeviceselectprops.track.md)                               | LocalAudioTrack \| LocalVideoTrack        | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |

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

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

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

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

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

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

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## MediaDeviceSelectProps.requestPermissions property
+
+this will call getUserMedia if the permissions are not yet given to enumerate the devices with device labels. in some browsers multiple calls to getUserMedia result in multiple permission prompts. It's generally advised only flip this to true, once a (preview) track has been acquired successfully with the appropriate permissions.
+
+**Signature:**
+
+```typescript
+requestPermissions?: boolean;
+```
+
+{% partial file="p_usage.md" /%}

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

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

package/generated-docs/react/messageformatter.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## MessageFormatter type
+
+**Signature:**
+
+```typescript
+export type MessageFormatter = (message: string) => React.ReactNode;
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/react/participantcontext.md

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

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## ParticipantLoopProps.children property
+
+The template component to be used in the loop.
+
+**Signature:**
+
+```typescript
+children: React.ReactNode;
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/react/participantloopprops.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## ParticipantLoopProps interface
+
+**Signature:**
+
+```typescript
+export interface ParticipantLoopProps
+```
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                                     | Type            | Description                                                                                              |
+| ------------------------------------------------------------ | --------------- | -------------------------------------------------------------------------------------------------------- |
+| [children](./react/participantloopprops.children.md)         | React.ReactNode | The template component to be used in the loop.                                                           |
+| [participants](./react/participantloopprops.participants.md) | Participant\[\] | The participants to loop over. If not provided, the participants from the current room context are used. |

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## ParticipantLoopProps.participants property
+
+The participants to loop over. If not provided, the participants from the current room context are used.
+
+**Signature:**
+
+```typescript
+participants: Participant[];
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/react/participantnameprops.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## ParticipantNameProps interface
+
+**Signature:**
+
+```typescript
+export interface ParticipantNameProps extends React.HTMLAttributes<HTMLSpanElement>, UseParticipantInfoOptions
+```
+
+**Extends:** React.HTMLAttributes&lt;HTMLSpanElement&gt;, [UseParticipantInfoOptions](./react/useparticipantinfooptions.md)
+
+{% partial file="p_usage.md" /%}

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

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

package/generated-docs/react/participanttileprops.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## ParticipantTileProps interface
+
+**Signature:**
+
+```typescript
+export interface ParticipantTileProps extends React.HTMLAttributes<HTMLDivElement>
+```
+
+**Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                                                              | Type                                                                                 | Description  |
+| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | ------------ |
+| [disableSpeakingIndicator?](./react/participanttileprops.disablespeakingindicator.md) | boolean                                                                              | _(Optional)_ |
+| [onParticipantClick?](./react/participanttileprops.onparticipantclick.md)             | (event: [ParticipantClickEvent](./core/participantclickevent.md)<!-- -->) =&gt; void | _(Optional)_ |
+| [participant?](./react/participanttileprops.participant.md)                           | Participant                                                                          | _(Optional)_ |
+| [publication?](./react/participanttileprops.publication.md)                           | TrackPublication                                                                     | _(Optional)_ |
+| [source?](./react/participanttileprops.source.md)                                     | Track.Source                                                                         | _(Optional)_ |

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## PreJoinProps.debug property
+
+Display a debug window for your convenience.
+
+**Signature:**
+
+```typescript
+debug?: boolean;
+```
+
+{% partial file="p_usage.md" /%}

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## PreJoinProps.defaults property
+
+Prefill the input form with initial values.
+
+**Signature:**
+
+```typescript
+defaults?: Partial<LocalUserChoices>;
+```
+
+{% partial file="p_usage.md" /%}

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

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

package/generated-docs/react/prejoinprops.md

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## PreJoinProps interface
+
+**Signature:**
+
+```typescript
+export interface PreJoinProps extends Omit<React.HTMLAttributes<HTMLDivElement>, 'onSubmit' | 'onError'>
+```
+
+**Extends:** Omit&lt;React.HTMLAttributes&lt;HTMLDivElement&gt;, 'onSubmit' \| 'onError'&gt;
+
+{% partial file="p_usage.md" /%}
+
+## 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. |
+| [userLabel?](./react/hook/prejoinprops.userlabel.md) | string                                                                          | _(Optional)_                                                                                                                               |

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

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

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

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

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## PreJoinProps.onSubmit property
+
+This function is called with the `LocalUserChoices` if validation is passed.
+
+**Signature:**
+
+```typescript
+onSubmit?: (values: LocalUserChoices) => void;
+```
+
+{% partial file="p_usage.md" /%}

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## PreJoinProps.onValidate property
+
+Provide your custom validation function. Only if validation is successful the user choices are past to the onSubmit callback.
+
+**Signature:**
+
+```typescript
+onValidate?: (values: LocalUserChoices) => boolean;
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/react/roomcontext.md

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

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

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## RoomNameProps.childrenPosition property
+
+**Signature:**
+
+```typescript
+childrenPosition?: 'before' | 'after';
+```

package/generated-docs/react/roomnameprops.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## RoomNameProps interface
+
+**Signature:**
+
+```typescript
+export interface RoomNameProps extends React.HTMLAttributes<HTMLSpanElement>
+```
+
+**Extends:** React.HTMLAttributes&lt;HTMLSpanElement&gt;
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                                       | Type                | Description  |
+| -------------------------------------------------------------- | ------------------- | ------------ |
+| [childrenPosition?](./react/roomnameprops.childrenposition.md) | 'before' \| 'after' | _(Optional)_ |

package/generated-docs/react/trackcontext.md

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

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## TrackLoopProps.children property
+
+The template component to be used in the loop.
+
+**Signature:**
+
+```typescript
+children: React.ReactNode;
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/react/trackloopprops.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## TrackLoopProps interface
+
+**Signature:**
+
+```typescript
+export interface TrackLoopProps
+```
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                       | Type                                                                                                                                       | Description                                    |
+| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------- |
+| [children](./react/trackloopprops.children.md) | React.ReactNode                                                                                                                            | The template component to be used in the loop. |
+| [tracks](./react/trackloopprops.tracks.md)     | [TrackReference](./core/trackreference.md)<!-- -->\[\] \| [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\] | Track references to loop over.                 |

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## TrackLoopProps.tracks property
+
+Track references to loop over.
+
+**Signature:**
+
+```typescript
+tracks: TrackReference[] | TrackReferenceOrPlaceholder[];
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/react/trackmutedindicatorprops.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## TrackMutedIndicatorProps interface
+
+**Signature:**
+
+```typescript
+export interface TrackMutedIndicatorProps extends React.HTMLAttributes<HTMLDivElement>
+```
+
+**Extends:** React.HTMLAttributes&lt;HTMLDivElement&gt;
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                                        | Type                             | Description  |
+| --------------------------------------------------------------- | -------------------------------- | ------------ |
+| [participant?](./react/trackmutedindicatorprops.participant.md) | Participant                      | _(Optional)_ |
+| [show?](./react/trackmutedindicatorprops.show.md)               | 'always' \| 'muted' \| 'unmuted' | _(Optional)_ |
+| [source](./react/trackmutedindicatorprops.source.md)            | Track.Source                     |              |

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

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

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

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## TrackMutedIndicatorProps.show property
+
+**Signature:**
+
+```typescript
+show?: 'always' | 'muted' | 'unmuted';
+```

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

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## TrackMutedIndicatorProps.source property
+
+**Signature:**
+
+```typescript
+source: Track.Source;
+```

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

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

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

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