@livekit/components-js-docs 0.0.2

package/generated-docs/core/trackidentifier.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## TrackIdentifier type
+
+The TrackIdentifier type is used to select Tracks either based on - Track.Source and/or name of the track, e.g. `{source: Track.Source.Camera}` or `{name: "my-track"}` - TrackReference (participant and publication)
+
+**Signature:**
+
+```typescript
+export type TrackIdentifier<T extends Track.Source = Track.Source> =
+  | TrackSource<T>
+  | TrackReference;
+```
+
+**References:** [TrackSource](./core/tracksource.md)<!-- -->, [TrackReference](./core/trackreference.md)
+
+{% partial file="p_usage.md" /%}

package/generated-docs/core/trackobservable.md

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# trackObservable (undefined)
+
+**Signature:**
+
+```typescript
+export declare function trackObservable(track: TrackPublication): Observable<TrackPublication>;
+```

package/generated-docs/core/trackreference.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## TrackReference type
+
+**Signature:**
+
+```typescript
+export type TrackReference = {
+  participant: Participant;
+  publication: TrackPublication;
+  source: Track.Source;
+};
+```

package/generated-docs/core/trackreferencefilter.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## TrackReferenceFilter type
+
+**Signature:**
+
+```typescript
+export type TrackReferenceFilter = Parameters<TrackReferenceOrPlaceholder[]['filter']>['0'];
+```
+
+**References:** [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)

package/generated-docs/core/trackreferenceorplaceholder.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## TrackReferenceOrPlaceholder type
+
+**Signature:**
+
+```typescript
+export type TrackReferenceOrPlaceholder = TrackReference | TrackReferencePlaceholder;
+```
+
+**References:** [TrackReference](./core/trackreference.md)<!-- -->, [TrackReferencePlaceholder](./core/trackreferenceplaceholder.md)

package/generated-docs/core/trackreferenceplaceholder.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## TrackReferencePlaceholder type
+
+**Signature:**
+
+```typescript
+export type TrackReferencePlaceholder = {
+  participant: Participant;
+  publication?: never;
+  source: Track.Source;
+};
+```

package/generated-docs/core/trackreferencesobservable.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# trackReferencesObservable (undefined)
+
+**Signature:**
+
+```typescript
+export declare function trackReferencesObservable(
+  room: Room,
+  sources: Track.Source[],
+  options: TrackReferencesObservableOptions,
+): Observable<{
+  trackReferences: TrackReference[];
+  participants: Participant[];
+}>;
+```

package/generated-docs/core/tracksource.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## TrackSource type
+
+**Signature:**
+
+```typescript
+export type TrackSource<T extends Track.Source> = RequireAtLeastOne<
+  {
+    source: T;
+    name: string;
+    participant: Participant;
+  },
+  'name' | 'source'
+>;
+```

package/generated-docs/core/tracksourcewithoptions.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## TrackSourceWithOptions type
+
+**Signature:**
+
+```typescript
+export type TrackSourceWithOptions = {
+  source: Track.Source;
+  withPlaceholder: boolean;
+};
+```

package/generated-docs/core/updatepages.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# updatePages (undefined)
+
+Divide the list of elements into pages and and check if pages need updating.
+
+**Signature:**
+
+```typescript
+export declare function updatePages<T extends UpdatableItem>(
+  currentList: T[],
+  nextList: T[],
+  maxItemsOnPage: number,
+): T[];
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/core/videosource.md

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## VideoSource type
+
+**Signature:**
+
+```typescript
+export type VideoSource = Track.Source.Camera | Track.Source.ScreenShare;
+```

package/generated-docs/core/wasclickoutside.md

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# wasClickOutside (undefined)
+
+**Signature:**
+
+```typescript
+export declare function wasClickOutside(insideElement: HTMLElement, event: MouseEvent): boolean;
+```

package/generated-docs/core/widget_default_state.md

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

package/generated-docs/core/widgetstate.md

@@ -0,0 +1,12 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## WidgetState type
+
+**Signature:**
+
+```typescript
+export type WidgetState = {
+  showChat: boolean;
+  unreadMessages: number;
+};
+```

package/generated-docs/index.md

@@ -0,0 +1,10 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## API Reference
+
+## Packages
+
+| Package                                       | Description |
+| --------------------------------------------- | ----------- |
+| [@livekit/components-core](./core/index.md)   |             |
+| [@livekit/components-react](./react/index.md) |             |

package/generated-docs/react/allowaudioplaybackprops.label.md

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

package/generated-docs/react/allowaudioplaybackprops.md

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

package/generated-docs/react/audioconferenceprops.md

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

package/generated-docs/react/audiotrackprops.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## AudioTrackProps interface
+
+**Signature:**
+
+```typescript
+export interface AudioTrackProps<T extends HTMLMediaElement = HTMLMediaElement> extends React.HTMLAttributes<T>
+```
+
+**Extends:** React.HTMLAttributes&lt;T&gt;
+
+{% partial file="p_usage.md" /%}
+
+## 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                     |                                                          |
+| [volume?](./react/audiotrackprops.volume.md)                                           | number                           | _(Optional)_ by the default the range is between 0 and 1 |

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

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

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

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

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

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

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

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

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

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

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

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## AudioTrackProps.volume property
+
+by the default the range is between 0 and 1
+
+**Signature:**
+
+```typescript
+volume?: number;
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/react/audiovisualizerprops.md

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

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

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

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

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

package/generated-docs/react/carouselviewprops.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## CarouselViewProps interface
+
+**Signature:**
+
+```typescript
+export interface CarouselLayoutProps extends React.HTMLAttributes<HTMLMediaElement>
+```
+
+**Extends:** React.HTMLAttributes&lt;HTMLMediaElement&gt;
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                                 | Type                                                                             | Description                                                                                                                                         |
+| -------------------------------------------------------- | -------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [children](./react/carouselviewprops.children.md)        | React.ReactNode                                                                  |                                                                                                                                                     |
+| [orientation?](./react/carouselviewprops.orientation.md) | 'vertical' \| 'horizontal'                                                       | _(Optional)_ Place the tiles vertically or horizontally next to each other. If undefined orientation is guessed by the dimensions of the container. |
+| [tracks](./react/carouselviewprops.tracks.md)            | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\] |                                                                                                                                                     |

package/generated-docs/react/carouselviewprops.orientation.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## CarouselViewProps.orientation property
+
+Place the tiles vertically or horizontally next to each other. If undefined orientation is guessed by the dimensions of the container.
+
+**Signature:**
+
+```typescript
+orientation?: 'vertical' | 'horizontal';
+```
+
+{% partial file="p_usage.md" /%}

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

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

package/generated-docs/react/chatentryprops.entry.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## ChatEntryProps.entry property
+
+The chat massage object to display.
+
+**Signature:**
+
+```typescript
+entry: ReceivedChatMessage;
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/react/chatentryprops.hidename.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## ChatEntryProps.hideName property
+
+Hide sender name. Useful when displaying multiple consecutive chat messages from the same person.
+
+**Signature:**
+
+```typescript
+hideName?: boolean;
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/react/chatentryprops.hidetimestamp.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## ChatEntryProps.hideTimestamp property
+
+Hide message timestamp.
+
+**Signature:**
+
+```typescript
+hideTimestamp?: boolean;
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/react/chatentryprops.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## ChatEntryProps interface
+
+ChatEntry composes the HTML div element under the hood, so you can pass all its props. These are the props specific to the ChatEntry component:
+
+**Signature:**
+
+```typescript
+export interface ChatEntryProps extends React.HTMLAttributes<HTMLLIElement>
+```
+
+**Extends:** React.HTMLAttributes&lt;HTMLLIElement&gt;
+
+{% partial file="p_usage.md" /%}
+
+## Properties
+
+| Property                                                        | Type                                                 | Description                                                                                                    |
+| --------------------------------------------------------------- | ---------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
+| [entry](./react/chatentryprops.entry.md)                        | [ReceivedChatMessage](./core/receivedchatmessage.md) | The chat massage object to display.                                                                            |
+| [hideName?](./react/chatentryprops.hidename.md)                 | boolean                                              | _(Optional)_ Hide sender name. Useful when displaying multiple consecutive chat messages from the same person. |
+| [hideTimestamp?](./react/chatentryprops.hidetimestamp.md)       | boolean                                              | _(Optional)_ Hide message timestamp.                                                                           |
+| [messageFormatter?](./react/chatentryprops.messageformatter.md) | [MessageFormatter](./react/messageformatter.md)      | _(Optional)_ An optional formatter for the message body.                                                       |

package/generated-docs/react/chatentryprops.messageformatter.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## ChatEntryProps.messageFormatter property
+
+An optional formatter for the message body.
+
+**Signature:**
+
+```typescript
+messageFormatter?: MessageFormatter;
+```
+
+{% partial file="p_usage.md" /%}

package/generated-docs/react/chatprops.md

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

package/generated-docs/react/chatprops.messageformatter.md

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

package/generated-docs/react/chattoggleprops.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## ChatToggleProps interface
+
+**Signature:**
+
+```typescript
+export interface ChatToggleProps extends React.ButtonHTMLAttributes<HTMLButtonElement>
+```
+
+**Extends:** React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt;
+
+{% partial file="p_usage.md" /%}

package/generated-docs/react/clearpinbuttonprops.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## ClearPinButtonProps interface
+
+**Signature:**
+
+```typescript
+export interface ClearPinButtonProps extends React.ButtonHTMLAttributes<HTMLButtonElement>
+```
+
+**Extends:** React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt;
+
+{% partial file="p_usage.md" /%}

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

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# AudioConference (prefab)
+
+This component is the default setup of a classic LiveKit audio conferencing app. It provides functionality like switching between participant grid view and focus view.
+
+## Import
+
+```typescript
+import { AudioConference } from '@livekit/components-react';
+```
+
+## Remarks
+
+The component is implemented with other LiveKit components like `FocusContextProvider`<!-- -->, `GridLayout`<!-- -->, `ControlBar`<!-- -->, `FocusLayoutContainer` and `FocusLayout`<!-- -->.
+
+## Usage
+
+```tsx
+<LiveKitRoom>
+  <AudioConference />
+<LiveKitRoom>
+```
+
+{% partial file="p_usage.md" /%}

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

@@ -0,0 +1,32 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# AudioTrack (component)
+
+The AudioTrack component is responsible for rendering participant audio tracks. This component must have access to the participant's context, or alternatively pass it a `Participant` as a property.
+
+## Import
+
+```typescript
+import { AudioTrack } from '@livekit/components-react';
+```
+
+## Usage
+
+```tsx
+<ParticipantTile>
+  <AudioTrack source={Track.Source.Microphone} />
+</ParticipantTile>
+```
+
+{% partial file="p_usage.md" /%}
+
+## 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                     |                                                          |
+| [volume?](./react/audiotrackprops.volume.md)                                           | number                           | _(Optional)_ by the default the range is between 0 and 1 |