@livekit/components-js-docs 0.1.74 → 0.1.77

package/generated-docs/core/participantagentattributes.md

@@ -22,6 +22,7 @@ export declare enum ParticipantAgentAttributes
 | Member                 | Value                                            | Description |
 | ---------------------- | ------------------------------------------------ | ----------- |
 | AgentState             | <code>&quot;lk.agent.state&quot;</code>          |             |
+| Expression             | <code>&quot;lk.expression&quot;</code>           |             |
 | PublishOnBehalf        | <code>&quot;lk.publish_on_behalf&quot;</code>    |             |
 | TranscribedTrackId     | <code>&quot;lk.transcribed_track_id&quot;</code> |             |
 | TranscriptionFinal     | <code>&quot;lk.transcription_final&quot;</code>  |             |

package/generated-docs/core/participantbyidentifierobserver.md

@@ -14,7 +14,7 @@
 ```typescript
 export declare function participantByIdentifierObserver(
   room: Room,
-  { kind, identity }: ParticipantIdentifier,
+  input: ParticipantIdentifier,
   options?: ConnectedParticipantObserverOptions
 ): Observable<RemoteParticipant | undefined>;
 ```

package/generated-docs/core/pin_default_state.md

@@ -7,7 +7,7 @@
 
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# PIN_DEFAULT_STATE
+# PIN\_DEFAULT\_STATE
 
 **Signature:**
 

package/generated-docs/core/receivedmessage.md

@@ -19,9 +19,7 @@ This feature is under active development and may change based on developer feedb
 
 ```typescript
 export type ReceivedMessage =
-  | ReceivedUserTranscriptionMessage
-  | ReceivedAgentTranscriptionMessage
-  | ReceivedChatMessage;
+  ReceivedUserTranscriptionMessage | ReceivedAgentTranscriptionMessage | ReceivedChatMessage;
 ```
 
 **References:** [ReceivedUserTranscriptionMessage](./core/receivedusertranscriptionmessage.md)<!-- -->, [ReceivedAgentTranscriptionMessage](./core/receivedagenttranscriptionmessage.md)<!-- -->, [ReceivedChatMessage](./core/receivedchatmessage.md)

package/generated-docs/core/setupdatamessagehandler.md

@@ -18,7 +18,7 @@ export declare function setupDataMessageHandler<T extends string>(
   onMessage?: (msg: ReceivedDataMessage<T>) => void
 ): {
   messageObservable: Observable<{
-    payload: Uint8Array<ArrayBufferLike>;
+    payload: Uint8Array<ArrayBuffer>;
     topic: T;
     from: import("livekit-client").RemoteParticipant | undefined;
   }>;

package/generated-docs/core/sorttrackreferences.md

@@ -9,7 +9,7 @@
 
 # sortTrackReferences
 
-Default sort for `TrackReferenceOrPlaceholder`<!-- -->, it'll order participants by: 1. local camera track (publication.isLocal) 2. remote screen_share track 3. local screen_share track 4. remote dominant speaker camera track (sorted by speaker with the loudest audio level) 5. other remote speakers that are recently active 6. remote unmuted camera tracks 7. remote tracks sorted by joinedAt
+Default sort for `TrackReferenceOrPlaceholder`<!-- -->, it'll order participants by: 1. local camera track (publication.isLocal) 2. remote screen\_share track 3. local screen\_share track 4. remote dominant speaker camera track (sorted by speaker with the loudest audio level) 5. other remote speakers that are recently active 6. remote unmuted camera tracks 7. remote tracks sorted by joinedAt
 
 **Signature:**
 

package/generated-docs/core/widget_default_state.md

@@ -7,7 +7,7 @@
 
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-# WIDGET_DEFAULT_STATE
+# WIDGET\_DEFAULT\_STATE
 
 **Signature:**
 

package/generated-docs/react/agentmood.md

@@ -0,0 +1,37 @@
+---
+{
+  "title": "AgentMood type",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useAgentExpression.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# AgentMood type
+
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
+
+The agent's normalized emotional delivery.
+
+The wording the TTS provider emits is not a fixed vocabulary: Fish Audio emits single words from a closed set, Inworld emits free-form English ("soft, with genuine care"), and models routinely drift outside whichever set they were given. The agent normalizes that wording to this enum before publishing it, so every client SDK reads the same values.
+
+**Signature:**
+
+```typescript
+export type AgentMood =
+  | "excited"
+  | "happy"
+  | "playful"
+  | "curious"
+  | "surprised"
+  | "hopeful"
+  | "empathetic"
+  | "sad"
+  | "angry"
+  | "anxious"
+  | "calm";
+```

package/generated-docs/react/agentstate.md

@@ -29,9 +29,5 @@ Legacy useVoiceAssistant hook: disconnected ➡️ connecting ➡️ initializin
 
 ```typescript
 export type AgentState =
-  | "disconnected"
-  | "connecting"
-  | "pre-connect-buffering"
-  | "failed"
-  | AgentSdkStates;
+  "disconnected" | "connecting" | "pre-connect-buffering" | "failed" | AgentSdkStates;
 ```

package/generated-docs/react/default_mood_ttl_turns.md

@@ -0,0 +1,24 @@
+---
+{
+  "title": "DEFAULT_MOOD_TTL_TURNS",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useAgentExpression.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# DEFAULT\_MOOD\_TTL\_TURNS
+
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
+
+How many agent turns an expression survives before the mood decays back to null. Without decay, one excited sentence would leave the UI excited for the rest of the session.
+
+**Signature:**
+
+```typescript
+DEFAULT_MOOD_TTL_TURNS = 2;
+```

package/generated-docs/react/expression_attribute.md

@@ -0,0 +1,24 @@
+---
+{
+  "title": "EXPRESSION_ATTRIBUTE",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useAgentExpression.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# EXPRESSION\_ATTRIBUTE
+
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
+
+Published per transcript segment by Expressive Mode: the segment's leading delivery tag.
+
+**Signature:**
+
+```typescript
+EXPRESSION_ATTRIBUTE: "lk.expression";
+```

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

@@ -0,0 +1,46 @@
+---
+{
+  "title": "useAgentExpression",
+  "linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useAgentExpression.ts"
+}
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+# useAgentExpression
+
+{% callout type="note" variation="normal" %}
+
+This feature is under active development and may change based on developer feedback and real-world usage.
+
+{% /callout %}
+
+useAgentExpression returns the agent's current emotional delivery, as published by Expressive Mode.
+
+Reads the transcript stream the session already subscribes to, so it adds no second text stream handler. The mood decays back to null after `ttlTurns` agent turns without a new expression, so a feeling doesn't outlive the moment that produced it.
+
+## Import
+
+```typescript
+import { useAgentExpression } from "@livekit/components-react";
+```
+
+## Usage
+
+```tsx
+const { mood, expression } = useAgentExpression();
+return <span title={expression ?? undefined}>{mood ?? "neutral"}</span>;
+```
+
+## Properties
+
+{% parameter name="opts.ttlTurns" type="number" optional=true %}
+Agent turns an expression survives before the mood decays to null. `0` disables decay.
+
+{% /parameter %}
+
+## Returns
+
+```typescript
+UseAgentExpressionReturn;
+```

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

@@ -23,7 +23,7 @@ Depends on the `LayoutContext` to work properly.
 
 ## Properties
 
-{% parameter name="{ props }.props" type="React.ButtonHTMLAttributes<HTMLButtonElement>" optional=false %}
+{% parameter name="input.props" type="React.ButtonHTMLAttributes<HTMLButtonElement>" optional=false %}
 {% /parameter %}
 
 ## Returns

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

@@ -26,10 +26,10 @@ return <button {...mergedProps}>{inFocus ? "Unfocus" : "Focus"}</button>;
 
 ## Properties
 
-{% parameter name="{ trackRef, props }.props" type="React.ButtonHTMLAttributes<HTMLButtonElement>" optional=false %}
+{% parameter name="input.props" type="React.ButtonHTMLAttributes<HTMLButtonElement>" optional=false %}
 {% /parameter %}
 
-{% parameter name="{ trackRef, props }.trackRef" type="TrackReferenceOrPlaceholder" optional=true %}
+{% parameter name="input.trackRef" type="TrackReferenceOrPlaceholder" optional=true %}
 {% /parameter %}
 
 ## Returns

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

@@ -26,7 +26,7 @@ const audioDevices = useMediaDevices({ kind: "audioinput" });
 
 ## Properties
 
-{% parameter name="{ kind, onError, }" type="{
+{% parameter name="input" type="{
       kind: MediaDeviceKind;
       onError?: (e: Error) => void;
   }" optional=false %}

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

@@ -27,23 +27,23 @@ const { devices, activeDeviceId, setActiveMediaDevice } = useMediaDeviceSelect({
 
 ## Properties
 
-{% parameter name="{ kind, room, track, requestPermissions, onError, }.kind" type="MediaDeviceKind" optional=false %}
+{% parameter name="input.kind" type="MediaDeviceKind" optional=false %}
 {% /parameter %}
 
-{% parameter name="{ kind, room, track, requestPermissions, onError, }.onError" type="(e: Error) => void" optional=true %}
+{% parameter name="input.onError" type="(e: Error) => void" optional=true %}
 this callback gets called if an error is thrown when failing to select a device and also if a user denied permissions, eventhough the `requestPermissions` option is set to `true`<!-- -->. Most commonly this will emit a MediaDeviceError
 
 {% /parameter %}
 
-{% parameter name="{ kind, room, track, requestPermissions, onError, }.requestPermissions" type="boolean" optional=true %}
+{% parameter name="input.requestPermissions" type="boolean" optional=true %}
 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.
 
 {% /parameter %}
 
-{% parameter name="{ kind, room, track, requestPermissions, onError, }.room" type="Room" optional=true %}
+{% parameter name="input.room" type="Room" optional=true %}
 {% /parameter %}
 
-{% parameter name="{ kind, room, track, requestPermissions, onError, }.track" type="LocalAudioTrack | LocalVideoTrack" optional=true %}
+{% parameter name="input.track" type="LocalAudioTrack | LocalVideoTrack" optional=true %}
 {% /parameter %}
 
 ## Returns

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

@@ -23,16 +23,16 @@ The returned props include many data attributes that are useful for CSS styling
 
 ## Properties
 
-{% parameter name="{ trackRef, onParticipantClick, disableSpeakingIndicator, htmlProps, }.htmlProps" type="React.HTMLAttributes<T>" optional=false %}
+{% parameter name="input.htmlProps" type="React.HTMLAttributes<T>" optional=false %}
 {% /parameter %}
 
-{% parameter name="{ trackRef, onParticipantClick, disableSpeakingIndicator, htmlProps, }.disableSpeakingIndicator" type="boolean" optional=true %}
+{% parameter name="input.disableSpeakingIndicator" type="boolean" optional=true %}
 {% /parameter %}
 
-{% parameter name="{ trackRef, onParticipantClick, disableSpeakingIndicator, htmlProps, }.onParticipantClick" type="(event: ParticipantClickEvent) => void" optional=true %}
+{% parameter name="input.onParticipantClick" type="(event: ParticipantClickEvent) => void" optional=true %}
 {% /parameter %}
 
-{% parameter name="{ trackRef, onParticipantClick, disableSpeakingIndicator, htmlProps, }.trackRef" type="TrackReferenceOrPlaceholder" optional=true %}
+{% parameter name="input.trackRef" type="TrackReferenceOrPlaceholder" optional=true %}
 The track reference to display.
 
 {% /parameter %}

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

@@ -25,10 +25,10 @@ import { useStartAudio } from "@livekit/components-react";
 
 ## Properties
 
-{% parameter name="{ room, props }.props" type="React.ButtonHTMLAttributes<HTMLButtonElement>" optional=false %}
+{% parameter name="input.props" type="React.ButtonHTMLAttributes<HTMLButtonElement>" optional=false %}
 {% /parameter %}
 
-{% parameter name="{ room, props }.room" type="Room" optional=true %}
+{% parameter name="input.room" type="Room" optional=true %}
 {% /parameter %}
 
 ## Returns

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

@@ -25,10 +25,10 @@ import { useStartVideo } from "@livekit/components-react";
 
 ## Properties
 
-{% parameter name="{ room, props }.props" type="React.ButtonHTMLAttributes<HTMLButtonElement>" optional=false %}
+{% parameter name="input.props" type="React.ButtonHTMLAttributes<HTMLButtonElement>" optional=false %}
 {% /parameter %}
 
-{% parameter name="{ room, props }.room" type="Room" optional=true %}
+{% parameter name="input.room" type="Room" optional=true %}
 {% /parameter %}
 
 ## Returns

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

@@ -26,7 +26,7 @@ return <button {...buttonProps}>{enabled ? "disable" : "enable"}</button>;
 
 ## Properties
 
-{% parameter name="{ source, onChange, initialState, captureOptions, publishOptions, onDeviceError, room, ...rest }.room" type="Room" optional=true %}
+{% parameter name="input.room" type="Room" optional=true %}
 {% /parameter %}
 
 ## Returns