@livekit/components-js-docs 0.0.0-20251021151641

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

@@ -0,0 +1,46 @@
+---
+{
+  "title": "useTextStream",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTextStream.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useTextStream
+
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
+
+## Import
+
+```typescript
+import { useTextStream } from "@livekit/components-react";
+```
+
+## Usage
+
+```tsx
+const { textStreams } = useTextStream("my-topic");
+return <div>{textStreams.map((textStream) => textStream.text)}</div>;
+```
+
+## Properties
+
+{% parameter name="topic" type="string" optional=false %}
+the topic to listen to
+
+{% /parameter %}
+
+## Returns
+
+an array of TextStreamData that holds the text, participantInfo, and streamInfo
+
+```typescript
+{
+    textStreams: TextStreamData[];
+}
+```

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

@@ -0,0 +1,41 @@
+---
+{
+  "title": "useToken",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useToken.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useToken
+
+The `useToken` hook fetches a token from the given token endpoint with the given user info.
+
+## Import
+
+```typescript
+import { useToken } from "@livekit/components-react";
+```
+
+## Usage
+
+```tsx
+const token = useToken(<token-endpoint>, roomName, { userInfo: { identity, name }});
+```
+
+## Properties
+
+{% parameter name="roomName" type="string" optional=false %}
+{% /parameter %}
+
+{% parameter name="tokenEndpoint" type="string | undefined" optional=false %}
+{% /parameter %}
+
+{% parameter name="options.userInfo" type="UserInfo" optional=true %}
+{% /parameter %}
+
+## Returns
+
+```typescript
+string | undefined;
+```

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

@@ -0,0 +1,32 @@
+---
+{
+  "title": "useTrackByName",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTrackByName.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useTrackByName
+
+This function `useTrackByName` allows you to access a track by referencing its track name. Inside the function, it ensures that the a valid `participant` reference is available by checking for both a passed participant argument and, if not available, a valid participant context.
+
+## Import
+
+```typescript
+import { useTrackByName } from "@livekit/components-react";
+```
+
+## Properties
+
+{% parameter name="name" type="string" optional=false %}
+{% /parameter %}
+
+{% parameter name="participant" type="Participant" optional=true %}
+{% /parameter %}
+
+## Returns
+
+```typescript
+import("../../packages/core/dist/index.d.ts").TrackReferenceOrPlaceholder;
+```

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

@@ -0,0 +1,35 @@
+---
+{
+  "title": "useTrackMutedIndicator",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTrackMutedIndicator.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useTrackMutedIndicator
+
+The `useTrackMutedIndicator` hook is used to implement the `TrackMutedIndicator` component and returns the muted state of the given track.
+
+## Import
+
+```typescript
+import { useTrackMutedIndicator } from "@livekit/components-react";
+```
+
+## Usage
+
+```tsx
+const { isMuted } = useTrackMutedIndicator(trackRef);
+```
+
+## Properties
+
+{% parameter name="trackRef" type="TrackReferenceOrPlaceholder" optional=true %}
+{% /parameter %}
+
+## Returns
+
+```typescript
+TrackMutedIndicatorReturnType;
+```

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

@@ -0,0 +1,24 @@
+---
+{
+  "title": "useTrackRefContext",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/context/track-reference-context.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useTrackRefContext
+
+Ensures that a track reference is provided via context. If not inside a `TrackRefContext`<!-- -->, an error is thrown.
+
+## Import
+
+```typescript
+import { useTrackRefContext } from "@livekit/components-react";
+```
+
+## Returns
+
+```typescript
+TrackReferenceOrPlaceholder;
+```

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

@@ -0,0 +1,48 @@
+---
+{
+  "title": "useTracks",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTracks.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useTracks
+
+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]);
+```
+
+### 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 }
+]);
+```
+
+## Properties
+
+{% parameter name="sources" type="T" optional=true %}
+{% /parameter %}
+
+## Returns
+
+```typescript
+UseTracksHookReturnType<T>;
+```

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

@@ -0,0 +1,43 @@
+---
+{
+  "title": "useTrackToggle",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTrackToggle.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useTrackToggle
+
+The `useTrackToggle` hook is used to implement the `TrackToggle` component and returns state and functionality of the given track.
+
+## Import
+
+```typescript
+import { useTrackToggle } from "@livekit/components-react";
+```
+
+## Usage
+
+```tsx
+const { buttonProps, enabled } = useTrackToggle(trackRef);
+return <button {...buttonProps}>{enabled ? "disable" : "enable"}</button>;
+```
+
+## Returns
+
+```typescript
+{
+  toggle: ((forceState?: boolean) => Promise<void>) |
+    ((
+      forceState?: boolean,
+      captureOptions?:
+        | import("../../packages/core/dist/index.d.ts").CaptureOptionsBySource<T>
+        | undefined
+    ) => Promise<boolean | undefined>);
+  enabled: boolean;
+  pending: boolean;
+  track: import("livekit-client").LocalTrackPublication | undefined;
+  buttonProps: React.ButtonHTMLAttributes<HTMLButtonElement>;
+}
+```

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

@@ -0,0 +1,47 @@
+---
+{
+  "title": "useTrackTranscription",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTrackTranscription.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useTrackTranscription
+
+{% callout type="note" variation="normal" %}
+
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+
+{% /callout %}
+
+## Import
+
+```typescript
+import { useTrackTranscription } from "@livekit/components-react";
+```
+
+## Properties
+
+{% parameter name="trackRef" type="TrackReferenceOrPlaceholder | undefined" optional=false %}
+{% /parameter %}
+
+{% parameter name="options.bufferSize" type="number" optional=true %}
+how many transcription segments should be buffered in state
+
+{% /parameter %}
+
+{% parameter name="options.onTranscription" type="(newSegments: TranscriptionSegment[]) => void" optional=true %}
+optional callback for retrieving newly incoming transcriptions only
+
+{% /parameter %}
+
+## Returns
+
+An object consisting of `segments` with maximum length of opts.windowLength and `activeSegments` that are valid for the current track timestamp
+
+```typescript
+{
+    segments: ReceivedTranscriptionSegment[];
+}
+```

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

@@ -0,0 +1,35 @@
+---
+{
+  "title": "useTrackVolume",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useTrackVolume.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useTrackVolume
+
+{% callout type="note" variation="normal" %}
+
+This feature is experimental and may change or be removed based on developer feedback and real-world usage.
+
+{% /callout %}
+
+Hook for tracking the volume of an audio track using the Web Audio API.
+
+## Import
+
+```typescript
+import { useTrackVolume } from "@livekit/components-react";
+```
+
+## Properties
+
+{% parameter name="trackOrTrackReference" type="LocalAudioTrack | RemoteAudioTrack | TrackReference" optional=true %}
+{% /parameter %}
+
+## Returns
+
+```typescript
+number;
+```

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

@@ -0,0 +1,48 @@
+---
+{
+  "title": "useVisualStableUpdate",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useVisualStableUpdate.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useVisualStableUpdate
+
+The `useVisualStableUpdate` hook is used to prevent visually jarring jumps and shifts of elements in an array. The algorithm only starts to update when there are more items than visually fit on a page. If this is the case, it will make sure that speaking participants move to the first page and are always visible.
+
+## Import
+
+```typescript
+import { useVisualStableUpdate } from "@livekit/components-react";
+```
+
+## Remarks
+
+Updating the array can occur because attendees leave or join a room, or because they mute/unmute or start speaking. The hook is used for the `GridLayout` and `CarouselLayout` components.
+
+## Usage
+
+```tsx
+const trackRefs = useTracks();
+const updatedTrackRefs = useVisualStableUpdate(trackRefs, itemPerPage);
+```
+
+## Properties
+
+{% parameter name="maxItemsOnPage" type="number" optional=false %}
+{% /parameter %}
+
+{% parameter name="trackReferences" type="TrackReferenceOrPlaceholder[]" optional=false %}
+{% /parameter %}
+
+{% parameter name="options.customSortFunction" type="(trackReferences: TrackReferenceOrPlaceholder[]) => TrackReferenceOrPlaceholder[]" optional=true %}
+Overwrites the default sort function.
+
+{% /parameter %}
+
+## Returns
+
+```typescript
+TrackReferenceOrPlaceholder[]
+```

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

@@ -0,0 +1,40 @@
+---
+{
+  "title": "useVoiceAssistant",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useVoiceAssistant.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useVoiceAssistant
+
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
+
+This hook looks for the first agent-participant in the room.
+
+## Import
+
+```typescript
+import { useVoiceAssistant } from "@livekit/components-react";
+```
+
+## Remarks
+
+This hook requires an agent running with livekit-agents &gt;<!-- -->= 0.9.0
+
+## Usage
+
+```tsx
+const { state, audioTrack, agentTranscriptions, agentAttributes } = useVoiceAssistant();
+```
+
+## Returns
+
+```typescript
+VoiceAssistant;
+```