@livekit/components-js-docs 0.0.2

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

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useMediaDeviceSelect (hook)
+
+## Import
+
+```typescript
+import { useMediaDeviceSelect } from '@livekit/components-react';
+```
+
+{% partial file="p_usage.md" /%}
+
+## Parameters
+
+| Parameter                                  | Type                                                              | Description |
+| ------------------------------------------ | ----------------------------------------------------------------- | ----------- |
+| { kind, room, track, requestPermissions, } | [UseMediaDeviceSelectProps](./react/usemediadeviceselectprops.md) |             |
+
+**Returns:**
+
+{ devices: MediaDeviceInfo\[\]; className: string; activeDeviceId: string; setActiveMediaDevice: (id: string, options?: import("@livekit/components-core").[SetMediaDeviceOptions](./core/setmediadeviceoptions.md) \| undefined) =&gt; Promise&lt;void&gt;; }

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

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useMediaTrack (hook)
+
+## Import
+
+```typescript
+import { useMediaTrack } from '@livekit/components-react';
+```
+
+{% partial file="p_usage.md" /%}
+
+## Parameters
+
+| Parameter   | Type                                                                         | Description  |
+| ----------- | ---------------------------------------------------------------------------- | ------------ |
+| source      | [VideoSource](./core/videosource.md) \| [AudioSource](./core/audiosource.md) |              |
+| participant | Participant                                                                  | _(Optional)_ |
+| options     | [UseMediaTrackOptions](./react/usemediatrackoptions.md)                      | _(Optional)_ |
+
+**Returns:**
+
+{ publication: import("livekit-client").TrackPublication \| undefined; isMuted: boolean \| undefined; isSubscribed: boolean \| undefined; track: import("livekit-client").Track \| undefined; elementProps: React.HTMLAttributes&lt;HTMLElement&gt;; }

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

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useMediaTrackByName (hook)
+
+## Import
+
+```typescript
+import { useMediaTrackByName } from '@livekit/components-react';
+```
+
+{% partial file="p_usage.md" /%}
+
+## Parameters
+
+| Parameter   | Type                                                    | Description  |
+| ----------- | ------------------------------------------------------- | ------------ |
+| name        | string                                                  |              |
+| participant | Participant                                             | _(Optional)_ |
+| options     | [UseMediaTrackOptions](./react/usemediatrackoptions.md) | _(Optional)_ |
+
+**Returns:**
+
+{ publication: import("livekit-client").TrackPublication \| undefined; isMuted: boolean \| undefined; isSubscribed: boolean \| undefined; track: import("livekit-client").Track \| undefined; elementProps: import("react").HTMLAttributes&lt;HTMLElement&gt;; }

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

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useParticipantContext (hook)
+
+Ensures that a participant is provided via context. If not inside a `ParticipantContext`<!-- -->, an error is thrown.
+
+## Import
+
+```typescript
+import { useParticipantContext } from '@livekit/components-react';
+```
+
+{% partial file="p_usage.md" /%}
+
+**Returns:**
+
+Participant

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

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useParticipantInfo (hook)
+
+## Import
+
+```typescript
+import { useParticipantInfo } from '@livekit/components-react';
+```
+
+{% partial file="p_usage.md" /%}
+
+## Parameters
+
+| Parameter | Type                                                              | Description  |
+| --------- | ----------------------------------------------------------------- | ------------ |
+| props     | [UseParticipantInfoOptions](./react/useparticipantinfooptions.md) | _(Optional)_ |
+
+**Returns:**
+
+{ identity: string; name: string \| undefined; metadata: string \| undefined; }

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

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useParticipantPermissions (hook)
+
+## Import
+
+```typescript
+import { useParticipantPermissions } from '@livekit/components-react';
+```
+
+{% partial file="p_usage.md" /%}
+
+## Parameters
+
+| Parameter | Type                                                                            | Description  |
+| --------- | ------------------------------------------------------------------------------- | ------------ |
+| options   | [UseParticipantPermissionsOptions](./react/useparticipantpermissionsoptions.md) | _(Optional)_ |
+
+**Returns:**
+
+import("livekit-client/dist/src/proto/livekit_models").ParticipantPermission \| undefined

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

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useParticipants (hook)
+
+The useParticipants hook returns all participants (local and remote) of the current room.
+
+## Import
+
+```typescript
+import { useParticipants } from '@livekit/components-react';
+```
+
+{% partial file="p_usage.md" /%}
+
+## Parameters
+
+| Parameter | Type                                                        | Description  |
+| --------- | ----------------------------------------------------------- | ------------ |
+| options   | [UseParticipantsOptions](./react/useparticipantsoptions.md) | _(Optional)_ |
+
+**Returns:**
+
+(import("livekit-client").RemoteParticipant \| import("livekit-client").LocalParticipant)\[\]

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

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useParticipantTile (hook)
+
+## Import
+
+```typescript
+import { useParticipantTile } from '@livekit/components-react';
+```
+
+{% partial file="p_usage.md" /%}
+
+## Parameters
+
+| Parameter                                                                                      | Type                                                                           | Description |
+| ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | ----------- |
+| { participant, source, publication, onParticipantClick, disableSpeakingIndicator, htmlProps, } | [UseParticipantTileProps](./react/useparticipanttileprops.md)<!-- -->&lt;T&gt; |             |
+
+**Returns:**
+
+{ elementProps: React.HTMLAttributes&lt;T&gt;; }

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

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# usePinnedTracks (hook)
+
+## Import
+
+```typescript
+import { usePinnedTracks } from '@livekit/components-react';
+```
+
+{% partial file="p_usage.md" /%}
+
+## Parameters
+
+| Parameter     | Type                                              | Description  |
+| ------------- | ------------------------------------------------- | ------------ |
+| layoutContext | [LayoutContextType](./react/layoutcontexttype.md) | _(Optional)_ |
+
+**Returns:**
+
+[TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\]

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

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# usePreviewDevice (hook)
+
+## Import
+
+```typescript
+import { usePreviewDevice } from '@livekit/components-react';
+```
+
+{% partial file="p_usage.md" /%}
+
+## Parameters
+
+| Parameter | Type                         | Description |
+| --------- | ---------------------------- | ----------- |
+| enabled   | boolean                      |             |
+| deviceId  | string                       |             |
+| kind      | 'videoinput' \| 'audioinput' |             |
+
+**Returns:**
+
+{ selectedDevice: MediaDeviceInfo \| undefined; localTrack: T \| undefined; deviceError: Error \| null; }

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

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useRemoteParticipant (hook)
+
+## Import
+
+```typescript
+import { useRemoteParticipant } from '@livekit/components-react';
+```
+
+{% partial file="p_usage.md" /%}
+
+## Parameters
+
+| Parameter | Type                                                                  | Description  |
+| --------- | --------------------------------------------------------------------- | ------------ |
+| identity  | string                                                                |              |
+| options   | [UseRemoteParticipantOptions](./react/useremoteparticipantoptions.md) | _(Optional)_ |
+
+**Returns:**
+
+RemoteParticipant \| undefined

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

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useRemoteParticipants (hook)
+
+The useRemoteParticipants
+
+## Import
+
+```typescript
+import { useRemoteParticipants } from '@livekit/components-react';
+```
+
+{% partial file="p_usage.md" /%}
+
+## Parameters
+
+| Parameter | Type                                                                    | Description  |
+| --------- | ----------------------------------------------------------------------- | ------------ |
+| options   | [UseRemoteParticipantsOptions](./react/useremoteparticipantsoptions.md) | _(Optional)_ |
+
+**Returns:**
+
+RemoteParticipant\[\]

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

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useRoomContext (hook)
+
+Ensures that a room is provided via context. If no room is provided, an error is thrown.
+
+## Import
+
+```typescript
+import { useRoomContext } from '@livekit/components-react';
+```
+
+{% partial file="p_usage.md" /%}
+
+**Returns:**
+
+Room

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

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useRoomInfo (hook)
+
+## Import
+
+```typescript
+import { useRoomInfo } from '@livekit/components-react';
+```
+
+{% partial file="p_usage.md" /%}
+
+## Parameters
+
+| Parameter | Type                                                | Description  |
+| --------- | --------------------------------------------------- | ------------ |
+| options   | [UseRoomInfoOptions](./react/useroominfooptions.md) | _(Optional)_ |
+
+**Returns:**
+
+{ name: string; metadata: string \| undefined; }

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

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useSortedParticipants (hook)
+
+The useSortedParticipants hook returns the only the active speakers of all participants.
+
+## Import
+
+```typescript
+import { useSortedParticipants } from '@livekit/components-react';
+```
+
+{% partial file="p_usage.md" /%}
+
+## Parameters
+
+| Parameter    | Type                     | Description |
+| ------------ | ------------------------ | ----------- |
+| participants | Array&lt;Participant&gt; |             |
+
+**Returns:**
+
+Participant\[\]

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

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useSpeakingParticipants (hook)
+
+The useSpeakingParticipants hook returns the only the active speakers of all participants.
+
+## Import
+
+```typescript
+import { useSpeakingParticipants } from '@livekit/components-react';
+```
+
+{% partial file="p_usage.md" /%}
+
+**Returns:**
+
+import("livekit-client").Participant\[\]

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

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useToken (hook)
+
+## Import
+
+```typescript
+import { useToken } from '@livekit/components-react';
+```
+
+{% partial file="p_usage.md" /%}
+
+## Parameters
+
+| Parameter     | Type                                          | Description  |
+| ------------- | --------------------------------------------- | ------------ |
+| tokenEndpoint | string \| undefined                           |              |
+| roomName      | string                                        |              |
+| options       | [UseTokenOptions](./react/usetokenoptions.md) | _(Optional)_ |
+
+**Returns:**
+
+string \| undefined

package/generated-docs/react/hook/usetokenoptions.userinfo.md

@@ -0,0 +1,9 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+## UseTokenOptions.userInfo property
+
+## Import
+
+```typescript
+import { userInfo } from '@livekit/components-react';
+```

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

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useTrackContext (hook)
+
+Ensures that a track reference is provided via context. If not inside a `TrackContext`<!-- -->, an error is thrown.
+
+## Import
+
+```typescript
+import { useTrackContext } from '@livekit/components-react';
+```
+
+{% partial file="p_usage.md" /%}
+
+**Returns:**
+
+[TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)

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

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useTrackMutedIndicator (hook)
+
+## Import
+
+```typescript
+import { useTrackMutedIndicator } from '@livekit/components-react';
+```
+
+{% partial file="p_usage.md" /%}
+
+## Parameters
+
+| Parameter | Type                                                                      | Description  |
+| --------- | ------------------------------------------------------------------------- | ------------ |
+| source    | Track.Source                                                              |              |
+| options   | [UseTrackMutedIndicatorOptions](./react/usetrackmutedindicatoroptions.md) | _(Optional)_ |
+
+**Returns:**
+
+{ isMuted: boolean; className: string; }

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

@@ -0,0 +1,41 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useTracks (hook)
+
+The `useTracks` hook returns an array of `TrackReference` or `TrackReferenceOrPlaceholder` depending on the provided `sources` property. If only subscribed tracks are desired, set the `onlySubscribed` property to `true`<!-- -->.
+
+## Import
+
+```typescript
+import { useTracks } from '@livekit/components-react';
+```
+
+## Usage Example 1
+
+```ts
+// Return all camera track publications.
+const trackReferences: TrackReference[] = useTracks([Track.Source.Camera]);
+```
+
+## Usage Example 2
+
+```ts
+// Return all subscribed camera tracks as well as placeholders for
+// participants without a camera subscription.
+const trackReferencesWithPlaceholders: TrackReferenceOrPlaceholder[] = useTracks([
+  { source: Track.Source.Camera, withPlaceholder: true },
+]);
+```
+
+{% partial file="p_usage.md" /%}
+
+## Parameters
+
+| Parameter | Type                                            | Description  |
+| --------- | ----------------------------------------------- | ------------ |
+| sources   | T                                               | _(Optional)_ |
+| options   | [UseTracksOptions](./react/usetracksoptions.md) | _(Optional)_ |
+
+**Returns:**
+
+[UseTracksHookReturnType](./react/usetrackshookreturntype.md)<!-- -->&lt;T&gt;

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

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useTrackToggle (hook)
+
+## Import
+
+```typescript
+import { useTrackToggle } from '@livekit/components-react';
+```
+
+{% partial file="p_usage.md" /%}
+
+## Parameters
+
+| Parameter                                                   | Type                                                                   | Description |
+| ----------------------------------------------------------- | ---------------------------------------------------------------------- | ----------- |
+| { source, onChange, initialState, captureOptions, ...rest } | [UseTrackToggleProps](./react/usetracktoggleprops.md)<!-- -->&lt;T&gt; |             |
+
+**Returns:**
+
+{ toggle: ((forceState?: boolean \| undefined) =&gt; void) \| ((forceState?: boolean \| undefined, captureOptions?: import("@livekit/components-core").[CaptureOptionsBySource](./core/captureoptionsbysource.md)<!-- -->&lt;T&gt; \| undefined) =&gt; Promise&lt;void&gt;); enabled: boolean; pending: boolean; track: import("livekit-client").LocalTrackPublication \| undefined; buttonProps: React.ButtonHTMLAttributes&lt;HTMLButtonElement&gt;; }

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

@@ -0,0 +1,29 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useVisualStableUpdate (hook)
+
+> This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+
+The useVisualStableUpdate hook tries to keep visual updates of the TackBundles array to a minimum, while still trying to display important tiles such as speaking participants or screen shares.
+
+Updating works with pagination. For example, if a participant starts speaking on the second page, they will be moved to the first page by replacing the least active/interesting participant on the first page.
+
+## Import
+
+```typescript
+import { useVisualStableUpdate } from '@livekit/components-react';
+```
+
+{% partial file="p_usage.md" /%}
+
+## Parameters
+
+| Parameter       | Type                                                                             | Description  |
+| --------------- | -------------------------------------------------------------------------------- | ------------ |
+| trackReferences | [TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\] |              |
+| maxItemsOnPage  | number                                                                           |              |
+| options         | [UseVisualStableUpdateOptions](./react/usevisualstableupdateoptions.md)          | _(Optional)_ |
+
+**Returns:**
+
+[TrackReferenceOrPlaceholder](./core/trackreferenceorplaceholder.md)<!-- -->\[\]