@livekit/components-js-docs 0.0.2

package/generated-docs/react/tracktoggleprops.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## TrackToggleProps interface
+
+**Signature:**
+
+```typescript
+export interface TrackToggleProps<T extends ToggleSource> extends Omit<React.ButtonHTMLAttributes<HTMLButtonElement>, 'onChange'>
+```
+
+**Extends:** Omit&lt;React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt;, 'onChange'&gt;
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                                      | Type                                                                        | Description  |
+| ------------------------------------------------------------- | --------------------------------------------------------------------------- | ------------ |
+| [captureOptions?](./react/tracktoggleprops.captureoptions.md) | [CaptureOptionsBySource](./core/captureoptionsbysource.md)<!-- -->&lt;T&gt; | _(Optional)_ |
+| [initialState?](./react/tracktoggleprops.initialstate.md)     | boolean                                                                     | _(Optional)_ |
+| [onChange?](./react/tracktoggleprops.onchange.md)             | (enabled: boolean) =&gt; void                                               | _(Optional)_ |
+| [showIcon?](./react/tracktoggleprops.showicon.md)             | boolean                                                                     | _(Optional)_ |
+| [source](./react/tracktoggleprops.source.md)                  | T                                                                           |              |

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

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

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

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

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

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

package/generated-docs/react/usechattoggleprops.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseChatToggleProps interface
+
+**Signature:**
+
+```typescript
+export interface UseChatToggleProps
+```
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                     | Type                                                | Description |
+| -------------------------------------------- | --------------------------------------------------- | ----------- |
+| [props](./react/usechattoggleprops.props.md) | React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt; |             |

package/generated-docs/react/usechattoggleprops.props.md

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseChatToggleProps.props property
+
+**Signature:**
+
+```typescript
+props: React.ButtonHTMLAttributes<HTMLButtonElement>;
+```

package/generated-docs/react/usefocustoggleprops.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseFocusToggleProps interface
+
+**Signature:**
+
+```typescript
+export interface UseFocusToggleProps
+```
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                                   | Type                                                | Description  |
+| ---------------------------------------------------------- | --------------------------------------------------- | ------------ |
+| [participant?](./react/usefocustoggleprops.participant.md) | Participant                                         | _(Optional)_ |
+| [props](./react/usefocustoggleprops.props.md)              | React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt; |              |
+| [trackSource](./react/usefocustoggleprops.tracksource.md)  | Track.Source                                        |              |

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

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

package/generated-docs/react/usefocustoggleprops.props.md

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseFocusToggleProps.props property
+
+**Signature:**
+
+```typescript
+props: React.ButtonHTMLAttributes<HTMLButtonElement>;
+```

package/generated-docs/react/usefocustoggleprops.tracksource.md

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

package/generated-docs/react/useismutedoptions.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseIsMutedOptions interface
+
+**Signature:**
+
+```typescript
+export interface UseIsMutedOptions
+```
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                                 | Type        | Description  |
+| -------------------------------------------------------- | ----------- | ------------ |
+| [participant?](./react/useismutedoptions.participant.md) | Participant | _(Optional)_ |

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

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

package/generated-docs/react/uselocalparticipantoptions.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseLocalParticipantOptions interface
+
+**Signature:**
+
+```typescript
+export interface UseLocalParticipantOptions
+```
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                            | Type | Description                                                                                 |
+| --------------------------------------------------- | ---- | ------------------------------------------------------------------------------------------- |
+| [room?](./react/uselocalparticipantoptions.room.md) | Room | _(Optional)_ The room to use. If not provided, the hook will use the room from the context. |

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseLocalParticipantOptions.room property
+
+The room to use. If not provided, the hook will use the room from the context.
+
+**Signature:**
+
+```typescript
+room?: Room;
+```
+
+{% partial file="p_usage.md" /%}

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

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

package/generated-docs/react/usemediadeviceselectprops.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseMediaDeviceSelectProps interface
+
+**Signature:**
+
+```typescript
+export interface UseMediaDeviceSelectProps
+```
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                                                       | Type                               | Description                                                                                                                                                                                                                                                                                                                                              |
+| ------------------------------------------------------------------------------ | ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [kind](./react/usemediadeviceselectprops.kind.md)                              | MediaDeviceKind                    |                                                                                                                                                                                                                                                                                                                                                          |
+| [requestPermissions?](./react/usemediadeviceselectprops.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. |
+| [room?](./react/usemediadeviceselectprops.room.md)                             | Room                               | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |
+| [track?](./react/usemediadeviceselectprops.track.md)                           | LocalAudioTrack \| LocalVideoTrack | _(Optional)_                                                                                                                                                                                                                                                                                                                                             |

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseMediaDeviceSelectProps.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/usemediadeviceselectprops.room.md

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

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

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

package/generated-docs/react/usemediatrackoptions.element.md

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

package/generated-docs/react/usemediatrackoptions.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseMediaTrackOptions interface
+
+**Signature:**
+
+```typescript
+export interface UseMediaTrackOptions
+```
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                            | Type                                                             | Description  |
+| --------------------------------------------------- | ---------------------------------------------------------------- | ------------ |
+| [element?](./react/usemediatrackoptions.element.md) | React.RefObject&lt;HTMLMediaElement&gt;                          | _(Optional)_ |
+| [props?](./react/usemediatrackoptions.props.md)     | React.HTMLAttributes&lt;HTMLVideoElement \| HTMLAudioElement&gt; | _(Optional)_ |

package/generated-docs/react/usemediatrackoptions.props.md

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseMediaTrackOptions.props property
+
+**Signature:**
+
+```typescript
+props?: React.HTMLAttributes<HTMLVideoElement | HTMLAudioElement>;
+```

package/generated-docs/react/useparticipantinfooptions.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseParticipantInfoOptions interface
+
+**Signature:**
+
+```typescript
+export interface UseParticipantInfoOptions
+```
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                                         | Type        | Description  |
+| ---------------------------------------------------------------- | ----------- | ------------ |
+| [participant?](./react/useparticipantinfooptions.participant.md) | Participant | _(Optional)_ |

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

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

package/generated-docs/react/useparticipantpermissionsoptions.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseParticipantPermissionsOptions interface
+
+**Signature:**
+
+```typescript
+export interface UseParticipantPermissionsOptions
+```
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                                                | Type        | Description  |
+| ----------------------------------------------------------------------- | ----------- | ------------ |
+| [participant?](./react/useparticipantpermissionsoptions.participant.md) | Participant | _(Optional)_ |

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

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

package/generated-docs/react/useparticipantsoptions.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseParticipantsOptions interface
+
+**Signature:**
+
+```typescript
+export interface UseParticipantsOptions
+```
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                                        | Type          | Description                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| --------------------------------------------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [room?](./react/useparticipantsoptions.room.md)                 | Room          | _(Optional)_ The room to use. If not provided, the hook will use the room from the context.                                                                                                                                                                                                                                                                                                                                      |
+| [updateOnlyOn?](./react/useparticipantsoptions.updateonlyon.md) | RoomEvent\[\] | _(Optional)_ To optimize performance, you can use the <code>updateOnlyOn</code> property to decide on what RoomEvents the hook updates. By default it updates on all relevant RoomEvents to keep the returned participants array up to date. The minimal set of non-overwriteable <code>RoomEvents</code> is: <code>[RoomEvent.ParticipantConnected, RoomEvent.ParticipantDisconnected, RoomEvent.ConnectionStateChanged]</code> |

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseParticipantsOptions.room property
+
+The room to use. If not provided, the hook will use the room from the context.
+
+**Signature:**
+
+```typescript
+room?: Room;
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/react/useparticipantsoptions.updateonlyon.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseParticipantsOptions.updateOnlyOn property
+
+To optimize performance, you can use the `updateOnlyOn` property to decide on what RoomEvents the hook updates. By default it updates on all relevant RoomEvents to keep the returned participants array up to date. The minimal set of non-overwriteable `RoomEvents` is: `[RoomEvent.ParticipantConnected, RoomEvent.ParticipantDisconnected, RoomEvent.ConnectionStateChanged]`
+
+**Signature:**
+
+```typescript
+updateOnlyOn?: RoomEvent[];
+```
+
+{% partial file="p_usage.md" /%}

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

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

package/generated-docs/react/useparticipanttileprops.htmlprops.md

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

package/generated-docs/react/useparticipanttileprops.md

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

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

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

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

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

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

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

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

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

package/generated-docs/react/useremoteparticipantoptions.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseRemoteParticipantOptions interface
+
+**Signature:**
+
+```typescript
+export interface UseRemoteParticipantOptions
+```
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                                             | Type                 | Description  |
+| -------------------------------------------------------------------- | -------------------- | ------------ |
+| [updateOnlyOn?](./react/useremoteparticipantoptions.updateonlyon.md) | ParticipantEvent\[\] | _(Optional)_ |

package/generated-docs/react/useremoteparticipantoptions.updateonlyon.md

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

package/generated-docs/react/useremoteparticipantsoptions.md

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseRemoteParticipantsOptions interface
+
+**Signature:**
+
+```typescript
+export interface UseRemoteParticipantsOptions
+```
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                                              | Type          | Description                                                                                                                                                                                                                                                                                                                                                                                                                      |
+| --------------------------------------------------------------------- | ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [room?](./react/useremoteparticipantsoptions.room.md)                 | Room          | _(Optional)_ The room to use. If not provided, the hook will use the room from the context.                                                                                                                                                                                                                                                                                                                                      |
+| [updateOnlyOn?](./react/useremoteparticipantsoptions.updateonlyon.md) | RoomEvent\[\] | _(Optional)_ To optimize performance, you can use the <code>updateOnlyOn</code> property to decide on what RoomEvents the hook updates. By default it updates on all relevant RoomEvents to keep the returned participants array up to date. The minimal set of non-overwriteable <code>RoomEvents</code> is: <code>[RoomEvent.ParticipantConnected, RoomEvent.ParticipantDisconnected, RoomEvent.ConnectionStateChanged]</code> |

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseRemoteParticipantsOptions.room property
+
+The room to use. If not provided, the hook will use the room from the context.
+
+**Signature:**
+
+```typescript
+room?: Room;
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/react/useremoteparticipantsoptions.updateonlyon.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseRemoteParticipantsOptions.updateOnlyOn property
+
+To optimize performance, you can use the `updateOnlyOn` property to decide on what RoomEvents the hook updates. By default it updates on all relevant RoomEvents to keep the returned participants array up to date. The minimal set of non-overwriteable `RoomEvents` is: `[RoomEvent.ParticipantConnected, RoomEvent.ParticipantDisconnected, RoomEvent.ConnectionStateChanged]`
+
+**Signature:**
+
+```typescript
+updateOnlyOn?: RoomEvent[];
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/react/userinfo.identity.md

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

package/generated-docs/react/userinfo.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UserInfo interface
+
+**Signature:**
+
+```typescript
+export interface UserInfo
+```
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                  | Type   | Description  |
+| ----------------------------------------- | ------ | ------------ |
+| [identity?](./react/userinfo.identity.md) | string | _(Optional)_ |
+| [metadata?](./react/userinfo.metadata.md) | string | _(Optional)_ |
+| [name?](./react/userinfo.name.md)         | string | _(Optional)_ |

package/generated-docs/react/userinfo.metadata.md

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