@livekit/components-js-docs 0.1.76 → 0.1.78
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/generated-docs/core/createdataobserver.md +2 -1
- package/generated-docs/core/grid_layouts.md +1 -1
- package/generated-docs/core/index.md +146 -146
- package/generated-docs/core/participantagentattributes.md +1 -0
- package/generated-docs/core/pin_default_state.md +1 -1
- package/generated-docs/core/receivedmessage.md +1 -3
- package/generated-docs/core/setupchatmessagehandler.md +1 -1
- package/generated-docs/core/setupdatamessagehandler.md +2 -2
- package/generated-docs/core/sorttrackreferences.md +1 -1
- package/generated-docs/core/widget_default_state.md +1 -1
- package/generated-docs/react/agentmood.md +37 -0
- package/generated-docs/react/agentstate.md +1 -5
- package/generated-docs/react/default_mood_ttl_turns.md +24 -0
- package/generated-docs/react/expression_attribute.md +24 -0
- package/generated-docs/react/hook/useagentexpression.md +46 -0
- package/generated-docs/react/hook/usemediadeviceselect.md +5 -1
- package/generated-docs/react/index.md +7 -0
- package/generated-docs/react/meta-data.json +1 -1
- package/generated-docs/react/parseexpression.md +24 -0
- package/generated-docs/react/useagentexpressionoptions.md +30 -0
- package/generated-docs/react/useagentexpressionoptions.ttlturns.md +21 -0
- package/generated-docs/react/useagentexpressionreturn.expression.md +21 -0
- package/generated-docs/react/useagentexpressionreturn.md +29 -0
- package/generated-docs/react/useagentexpressionreturn.mood.md +21 -0
- package/generated-docs/react/usemediadeviceselectprops.track.md +6 -0
- package/generated-docs/react/usesessionreturn.md +1 -3
- package/package.json +2 -2
|
@@ -22,6 +22,7 @@ export declare enum ParticipantAgentAttributes
|
|
|
22
22
|
| Member | Value | Description |
|
|
23
23
|
| ---------------------- | ------------------------------------------------ | ----------- |
|
|
24
24
|
| AgentState | <code>"lk.agent.state"</code> | |
|
|
25
|
+
| Expression | <code>"lk.expression"</code> | |
|
|
25
26
|
| PublishOnBehalf | <code>"lk.publish_on_behalf"</code> | |
|
|
26
27
|
| TranscribedTrackId | <code>"lk.transcribed_track_id"</code> | |
|
|
27
28
|
| TranscriptionFinal | <code>"lk.transcription_final"</code> | |
|
|
@@ -19,9 +19,7 @@ This feature is under active development and may change based on developer feedb
|
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
21
|
export type ReceivedMessage =
|
|
22
|
-
|
|
|
23
|
-
| ReceivedAgentTranscriptionMessage
|
|
24
|
-
| ReceivedChatMessage;
|
|
22
|
+
ReceivedUserTranscriptionMessage | ReceivedAgentTranscriptionMessage | ReceivedChatMessage;
|
|
25
23
|
```
|
|
26
24
|
|
|
27
25
|
**References:** [ReceivedUserTranscriptionMessage](./core/receivedusertranscriptionmessage.md)<!-- -->, [ReceivedAgentTranscriptionMessage](./core/receivedagenttranscriptionmessage.md)<!-- -->, [ReceivedChatMessage](./core/receivedchatmessage.md)
|
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
|
|
14
14
|
```typescript
|
|
15
15
|
export declare function setupChatMessageHandler(room: Room): {
|
|
16
|
-
chatObservable: Observable<
|
|
16
|
+
chatObservable: import("rxjs").Observable<
|
|
17
17
|
[
|
|
18
18
|
message: ChatMessage,
|
|
19
19
|
participant?: LocalParticipant | import("livekit-client").RemoteParticipant | undefined
|
|
@@ -17,12 +17,12 @@ export declare function setupDataMessageHandler<T extends string>(
|
|
|
17
17
|
topic?: T | [T, ...T[]],
|
|
18
18
|
onMessage?: (msg: ReceivedDataMessage<T>) => void
|
|
19
19
|
): {
|
|
20
|
-
messageObservable: Observable<{
|
|
20
|
+
messageObservable: import("rxjs").Observable<{
|
|
21
21
|
payload: Uint8Array<ArrayBuffer>;
|
|
22
22
|
topic: T;
|
|
23
23
|
from: import("livekit-client").RemoteParticipant | undefined;
|
|
24
24
|
}>;
|
|
25
|
-
isSendingObservable: Observable<boolean>;
|
|
25
|
+
isSendingObservable: import("rxjs").Observable<boolean>;
|
|
26
26
|
send: (payload: Uint8Array, options?: DataPublishOptions) => Promise<void>;
|
|
27
27
|
};
|
|
28
28
|
```
|
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
|
|
10
10
|
# sortTrackReferences
|
|
11
11
|
|
|
12
|
-
Default sort for `TrackReferenceOrPlaceholder`<!-- -->, it'll order participants by: 1. local camera track (publication.isLocal) 2. remote
|
|
12
|
+
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
|
|
13
13
|
|
|
14
14
|
**Signature:**
|
|
15
15
|
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "AgentMood type",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useAgentExpression.ts"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
# AgentMood type
|
|
11
|
+
|
|
12
|
+
{% callout type="note" variation="normal" %}
|
|
13
|
+
|
|
14
|
+
This feature is under active development and may change based on developer feedback and real-world usage.
|
|
15
|
+
|
|
16
|
+
{% /callout %}
|
|
17
|
+
|
|
18
|
+
The agent's normalized emotional delivery.
|
|
19
|
+
|
|
20
|
+
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.
|
|
21
|
+
|
|
22
|
+
**Signature:**
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
export type AgentMood =
|
|
26
|
+
| "excited"
|
|
27
|
+
| "happy"
|
|
28
|
+
| "playful"
|
|
29
|
+
| "curious"
|
|
30
|
+
| "surprised"
|
|
31
|
+
| "hopeful"
|
|
32
|
+
| "empathetic"
|
|
33
|
+
| "sad"
|
|
34
|
+
| "angry"
|
|
35
|
+
| "anxious"
|
|
36
|
+
| "calm";
|
|
37
|
+
```
|
|
@@ -29,9 +29,5 @@ Legacy useVoiceAssistant hook: disconnected ➡️ connecting ➡️ initializin
|
|
|
29
29
|
|
|
30
30
|
```typescript
|
|
31
31
|
export type AgentState =
|
|
32
|
-
| "
|
|
33
|
-
| "connecting"
|
|
34
|
-
| "pre-connect-buffering"
|
|
35
|
-
| "failed"
|
|
36
|
-
| AgentSdkStates;
|
|
32
|
+
"disconnected" | "connecting" | "pre-connect-buffering" | "failed" | AgentSdkStates;
|
|
37
33
|
```
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "DEFAULT_MOOD_TTL_TURNS",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useAgentExpression.ts"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
# DEFAULT\_MOOD\_TTL\_TURNS
|
|
11
|
+
|
|
12
|
+
{% callout type="note" variation="normal" %}
|
|
13
|
+
|
|
14
|
+
This feature is under active development and may change based on developer feedback and real-world usage.
|
|
15
|
+
|
|
16
|
+
{% /callout %}
|
|
17
|
+
|
|
18
|
+
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.
|
|
19
|
+
|
|
20
|
+
**Signature:**
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
DEFAULT_MOOD_TTL_TURNS = 2;
|
|
24
|
+
```
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "EXPRESSION_ATTRIBUTE",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useAgentExpression.ts"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
# EXPRESSION\_ATTRIBUTE
|
|
11
|
+
|
|
12
|
+
{% callout type="note" variation="normal" %}
|
|
13
|
+
|
|
14
|
+
This feature is under active development and may change based on developer feedback and real-world usage.
|
|
15
|
+
|
|
16
|
+
{% /callout %}
|
|
17
|
+
|
|
18
|
+
Published per transcript segment by Expressive Mode: the segment's leading delivery tag.
|
|
19
|
+
|
|
20
|
+
**Signature:**
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
EXPRESSION_ATTRIBUTE: "lk.expression";
|
|
24
|
+
```
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "useAgentExpression",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useAgentExpression.ts"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
# useAgentExpression
|
|
11
|
+
|
|
12
|
+
{% callout type="note" variation="normal" %}
|
|
13
|
+
|
|
14
|
+
This feature is under active development and may change based on developer feedback and real-world usage.
|
|
15
|
+
|
|
16
|
+
{% /callout %}
|
|
17
|
+
|
|
18
|
+
useAgentExpression returns the agent's current emotional delivery, as published by Expressive Mode.
|
|
19
|
+
|
|
20
|
+
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.
|
|
21
|
+
|
|
22
|
+
## Import
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
import { useAgentExpression } from "@livekit/components-react";
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
## Usage
|
|
29
|
+
|
|
30
|
+
```tsx
|
|
31
|
+
const { mood, expression } = useAgentExpression();
|
|
32
|
+
return <span title={expression ?? undefined}>{mood ?? "neutral"}</span>;
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Properties
|
|
36
|
+
|
|
37
|
+
{% parameter name="opts.ttlTurns" type="number" optional=true %}
|
|
38
|
+
Agent turns an expression survives before the mood decays to null. `0` disables decay.
|
|
39
|
+
|
|
40
|
+
{% /parameter %}
|
|
41
|
+
|
|
42
|
+
## Returns
|
|
43
|
+
|
|
44
|
+
```typescript
|
|
45
|
+
UseAgentExpressionReturn;
|
|
46
|
+
```
|
|
@@ -43,7 +43,11 @@ this will call getUserMedia if the permissions are not yet given to enumerate th
|
|
|
43
43
|
{% parameter name="input.room" type="Room" optional=true %}
|
|
44
44
|
{% /parameter %}
|
|
45
45
|
|
|
46
|
-
{% parameter name="input.track" type="LocalAudioTrack | LocalVideoTrack" optional=true %}
|
|
46
|
+
{% parameter name="input.track" type="LocalAudioTrack | LocalVideoTrack" optional=true deprecated=true %}
|
|
47
|
+
{% callout type="caution" variation="compact" %}
|
|
48
|
+
Passing a local track is no longer needed. Without a `room`<!-- -->, the hook falls back to the room from the context or to a new, unconnected `Room`<!-- -->, and tracks the active device through that room.
|
|
49
|
+
|
|
50
|
+
{% /callout %}
|
|
47
51
|
{% /parameter %}
|
|
48
52
|
|
|
49
53
|
## Returns
|
|
@@ -65,6 +65,7 @@
|
|
|
65
65
|
| Hook | Description |
|
|
66
66
|
| --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
67
67
|
| [useAgent(session)](./react/hook/useagent.md) | **_(BETA)_** useAgent encapculates all agent state, normalizing some quirks around how LiveKit Agents work. |
|
|
68
|
+
| [useAgentExpression(opts)](./react/hook/useagentexpression.md) | <p>**_(BETA)_** useAgentExpression returns the agent's current emotional delivery, as published by Expressive Mode.</p><p>Reads the transcript stream the session already subscribes to, so it adds no second text stream handler. The mood decays back to null after <code>ttlTurns</code> agent turns without a new expression, so a feeling doesn't outlive the moment that produced it.</p> |
|
|
68
69
|
| [useAudioPlayback(room)](./react/hook/useaudioplayback.md) | In many browsers to start audio playback, the user must perform a user-initiated event such as clicking a button. The <code>useAudioPlayback</code> hook returns an object with a boolean <code>canPlayAudio</code> flag that indicates whether audio playback is allowed in the current context, as well as a <code>startAudio</code> function that can be called in a button <code>onClick</code> callback to start audio playback in the current context. |
|
|
69
70
|
| [useAudioWaveform(trackOrTrackReference, options)](./react/hook/useaudiowaveform.md) | |
|
|
70
71
|
| [useChat(options)](./react/hook/usechat.md) | The <code>useChat</code> hook provides chat functionality for a LiveKit room. |
|
|
@@ -154,6 +155,7 @@
|
|
|
154
155
|
| ------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
155
156
|
| [AgentCallbacks](./react/agentcallbacks.md) | **_(BETA)_** |
|
|
156
157
|
| [AgentEvent](./react/agentevent.md) | **_(BETA)_** |
|
|
158
|
+
| [AgentMood](./react/agentmood.md) | <p>**_(BETA)_** The agent's normalized emotional delivery.</p><p>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.</p> |
|
|
157
159
|
| [AgentState](./react/agentstate.md) | <p>**_(BETA)_** State representing the current status of the agent, whether it is ready for speach, etc</p><p>For most agents (which have the preconnect audio buffer feature enabled), this is the lifecycle: connecting ➡️ pre-connect-buffering ➡️ initializing/listening/thinking/speaking</p><p>For agents without the preconnect audio feature enabled: connecting ➡️ initializing ➡️ idle/listening/thinking/speaking</p><p>If an agent fails to connect: connecting ➡️ pre-connect-buffering/initializing ➡️ failed</p><p>Legacy useVoiceAssistant hook: disconnected ➡️ connecting ➡️ initializing ➡️ listening/thinking/speaking</p> |
|
|
158
160
|
| [AllowAudioPlaybackProps](./react/allowaudioplaybackprops.md) | |
|
|
159
161
|
| [AllowMediaPlaybackProps](./react/allowmediaplaybackprops.md) | |
|
|
@@ -174,7 +176,9 @@
|
|
|
174
176
|
| [ConnectionStatusProps](./react/connectionstatusprops.md) | |
|
|
175
177
|
| [ControlBarControls](./react/controlbarcontrols.md) | |
|
|
176
178
|
| [ControlBarProps](./react/controlbarprops.md) | |
|
|
179
|
+
| [DEFAULT\_MOOD\_TTL\_TURNS](./react/default_mood_ttl_turns.md) | **_(BETA)_** 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. |
|
|
177
180
|
| [DisconnectButtonProps](./react/disconnectbuttonprops.md) | |
|
|
181
|
+
| [EXPRESSION\_ATTRIBUTE](./react/expression_attribute.md) | **_(BETA)_** Published per transcript segment by Expressive Mode: the segment's leading delivery tag. |
|
|
178
182
|
| [FocusLayoutContainerProps](./react/focuslayoutcontainerprops.md) | |
|
|
179
183
|
| [FocusLayoutProps](./react/focuslayoutprops.md) | |
|
|
180
184
|
| [FocusToggleProps](./react/focustoggleprops.md) | |
|
|
@@ -189,6 +193,7 @@
|
|
|
189
193
|
| [MessagesCallbacks](./react/messagescallbacks.md) | **_(BETA)_** |
|
|
190
194
|
| [MessagesEvent](./react/messagesevent.md) | **_(BETA)_** |
|
|
191
195
|
| [MultiBandTrackVolumeOptions](./react/multibandtrackvolumeoptions.md) | Interface for configuring options for the useMultibandTrackVolume hook. |
|
|
196
|
+
| [parseExpression(segment)](./react/parseexpression.md) | **_(BETA)_** The expression published on a transcript segment, or null when it carries none. |
|
|
192
197
|
| [ParticipantLoopProps](./react/participantloopprops.md) | |
|
|
193
198
|
| [ParticipantNameProps](./react/participantnameprops.md) | |
|
|
194
199
|
| [ParticipantTileProps](./react/participanttileprops.md) | |
|
|
@@ -207,6 +212,8 @@
|
|
|
207
212
|
| [TrackMutedIndicatorProps](./react/trackmutedindicatorprops.md) | |
|
|
208
213
|
| [TrackToggleProps](./react/tracktoggleprops.md) | |
|
|
209
214
|
| [TrackTranscriptionOptions](./react/tracktranscriptionoptions.md) | |
|
|
215
|
+
| [UseAgentExpressionOptions](./react/useagentexpressionoptions.md) | **_(BETA)_** |
|
|
216
|
+
| [UseAgentExpressionReturn](./react/useagentexpressionreturn.md) | **_(BETA)_** |
|
|
210
217
|
| [UseAgentReturn](./react/useagentreturn.md) | **_(BETA)_** |
|
|
211
218
|
| [UseChatToggleProps](./react/usechattoggleprops.md) | |
|
|
212
219
|
| [UseFocusToggleProps](./react/usefocustoggleprops.md) | |
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"components":[{"filename":"audioconference.md","title":"AudioConference"},{"filename":"audiotrack.md","title":"AudioTrack"},{"filename":"audiovisualizer.md","title":"AudioVisualizer"},{"filename":"barvisualizer.md","title":"BarVisualizer"},{"filename":"carousellayout.md","title":"CarouselLayout"},{"filename":"chat.md","title":"Chat"},{"filename":"chatentry.md","title":"ChatEntry"},{"filename":"chattoggle.md","title":"ChatToggle"},{"filename":"clearpinbutton.md","title":"ClearPinButton"},{"filename":"connectionqualityindicator.md","title":"ConnectionQualityIndicator"},{"filename":"connectionstate.md","title":"ConnectionState"},{"filename":"connectionstatetoast.md","title":"ConnectionStateToast"},{"filename":"controlbar.md","title":"ControlBar"},{"filename":"disconnectbutton.md","title":"DisconnectButton"},{"filename":"focuslayout.md","title":"FocusLayout"},{"filename":"focuslayoutcontainer.md","title":"FocusLayoutContainer"},{"filename":"focustoggle.md","title":"FocusToggle"},{"filename":"gridlayout.md","title":"GridLayout"},{"filename":"layoutcontext.md","title":"LayoutContext"},{"filename":"layoutcontextprovider.md","title":"LayoutContextProvider"},{"filename":"livekitroom.md","title":"LiveKitRoom"},{"filename":"mediadevicemenu.md","title":"MediaDeviceMenu"},{"filename":"mediadeviceselect.md","title":"MediaDeviceSelect"},{"filename":"participantaudiotile.md","title":"ParticipantAudioTile"},{"filename":"participantcontext.md","title":"ParticipantContext"},{"filename":"participantcontextifneeded.md","title":"ParticipantContextIfNeeded"},{"filename":"participantloop.md","title":"ParticipantLoop"},{"filename":"participantname.md","title":"ParticipantName"},{"filename":"participanttile.md","title":"ParticipantTile"},{"filename":"prejoin.md","title":"PreJoin"},{"filename":"roomaudiorenderer.md","title":"RoomAudioRenderer"},{"filename":"roomcontext.md","title":"RoomContext"},{"filename":"roomname.md","title":"RoomName"},{"filename":"sessionprovider.md","title":"SessionProvider"},{"filename":"startaudio.md","title":"StartAudio"},{"filename":"startmediabutton.md","title":"StartMediaButton"},{"filename":"toast.md","title":"Toast"},{"filename":"trackloop.md","title":"TrackLoop"},{"filename":"trackmutedindicator.md","title":"TrackMutedIndicator"},{"filename":"trackrefcontext.md","title":"TrackRefContext"},{"filename":"tracktoggle.md","title":"TrackToggle"},{"filename":"videoconference.md","title":"VideoConference"},{"filename":"videotrack.md","title":"VideoTrack"},{"filename":"voiceassistantcontrolbar.md","title":"VoiceAssistantControlBar"}],"hooks":[{"filename":"useagent.md","title":"useAgent"},{"filename":"useaudioplayback.md","title":"useAudioPlayback"},{"filename":"useaudiowaveform.md","title":"useAudioWaveform"},{"filename":"usechat.md","title":"useChat"},{"filename":"usechattoggle.md","title":"useChatToggle"},{"filename":"useclearpinbutton.md","title":"useClearPinButton"},{"filename":"useconnectionqualityindicator.md","title":"useConnectionQualityIndicator"},{"filename":"useconnectionstate.md","title":"useConnectionState"},{"filename":"usecreatelayoutcontext.md","title":"useCreateLayoutContext"},{"filename":"usedatachannel.md","title":"useDataChannel"},{"filename":"usedisconnectbutton.md","title":"useDisconnectButton"},{"filename":"useensurecreatelayoutcontext.md","title":"useEnsureCreateLayoutContext"},{"filename":"useensurelayoutcontext.md","title":"useEnsureLayoutContext"},{"filename":"useensureparticipant.md","title":"useEnsureParticipant"},{"filename":"useensureroom.md","title":"useEnsureRoom"},{"filename":"useensuresession.md","title":"useEnsureSession"},{"filename":"useensuretrackref.md","title":"useEnsureTrackRef"},{"filename":"useevents.md","title":"useEvents"},{"filename":"usefacingmode.md","title":"useFacingMode"},{"filename":"usefocustoggle.md","title":"useFocusToggle"},{"filename":"usegridlayout.md","title":"useGridLayout"},{"filename":"useisencrypted.md","title":"useIsEncrypted"},{"filename":"useismuted.md","title":"useIsMuted"},{"filename":"useisrecording.md","title":"useIsRecording"},{"filename":"useisspeaking.md","title":"useIsSpeaking"},{"filename":"usekrispnoisefilter.md","title":"useKrispNoiseFilter"},{"filename":"uselayoutcontext.md","title":"useLayoutContext"},{"filename":"uselivekitroom.md","title":"useLiveKitRoom"},{"filename":"uselocalparticipant.md","title":"useLocalParticipant"},{"filename":"uselocalparticipantpermissions.md","title":"useLocalParticipantPermissions"},{"filename":"usemaybelayoutcontext.md","title":"useMaybeLayoutContext"},{"filename":"usemaybeparticipantcontext.md","title":"useMaybeParticipantContext"},{"filename":"usemayberoomcontext.md","title":"useMaybeRoomContext"},{"filename":"usemaybesessioncontext.md","title":"useMaybeSessionContext"},{"filename":"usemaybetrackrefcontext.md","title":"useMaybeTrackRefContext"},{"filename":"usemediadevices.md","title":"useMediaDevices"},{"filename":"usemediadeviceselect.md","title":"useMediaDeviceSelect"},{"filename":"usemultibandtrackvolume.md","title":"useMultibandTrackVolume"},{"filename":"usepagination.md","title":"usePagination"},{"filename":"useparticipantattribute.md","title":"useParticipantAttribute"},{"filename":"useparticipantattributes.md","title":"useParticipantAttributes"},{"filename":"useparticipantcontext.md","title":"useParticipantContext"},{"filename":"useparticipantinfo.md","title":"useParticipantInfo"},{"filename":"useparticipantpermissions.md","title":"useParticipantPermissions"},{"filename":"useparticipants.md","title":"useParticipants"},{"filename":"useparticipanttile.md","title":"useParticipantTile"},{"filename":"useparticipanttracks.md","title":"useParticipantTracks"},{"filename":"usepersistentuserchoices.md","title":"usePersistentUserChoices"},{"filename":"usepinnedtracks.md","title":"usePinnedTracks"},{"filename":"usepreviewdevice.md","title":"usePreviewDevice"},{"filename":"usepreviewtracks.md","title":"usePreviewTracks"},{"filename":"useremoteparticipant.md","title":"useRemoteParticipant"},{"filename":"useremoteparticipants.md","title":"useRemoteParticipants"},{"filename":"useroomcontext.md","title":"useRoomContext"},{"filename":"useroominfo.md","title":"useRoomInfo"},{"filename":"userpc.md","title":"useRpc"},{"filename":"usesequentialroomconnectdisconnect.md","title":"useSequentialRoomConnectDisconnect"},{"filename":"usesession.md","title":"useSession"},{"filename":"usesessioncontext.md","title":"useSessionContext"},{"filename":"usesessionmessages.md","title":"useSessionMessages"},{"filename":"usesortedparticipants.md","title":"useSortedParticipants"},{"filename":"usespeakingparticipants.md","title":"useSpeakingParticipants"},{"filename":"usestartaudio.md","title":"useStartAudio"},{"filename":"usestartvideo.md","title":"useStartVideo"},{"filename":"useswipe.md","title":"useSwipe"},{"filename":"usetextstream.md","title":"useTextStream"},{"filename":"usetoken.md","title":"useToken"},{"filename":"usetrackbyname.md","title":"useTrackByName"},{"filename":"usetrackmutedindicator.md","title":"useTrackMutedIndicator"},{"filename":"usetrackrefcontext.md","title":"useTrackRefContext"},{"filename":"usetracks.md","title":"useTracks"},{"filename":"usetracktoggle.md","title":"useTrackToggle"},{"filename":"usetracktranscription.md","title":"useTrackTranscription"},{"filename":"usetrackvolume.md","title":"useTrackVolume"},{"filename":"usetranscriptions.md","title":"useTranscriptions"},{"filename":"usevisualstableupdate.md","title":"useVisualStableUpdate"},{"filename":"usevoiceassistant.md","title":"useVoiceAssistant"}]}
|
|
1
|
+
{"components":[{"filename":"audioconference.md","title":"AudioConference"},{"filename":"audiotrack.md","title":"AudioTrack"},{"filename":"audiovisualizer.md","title":"AudioVisualizer"},{"filename":"barvisualizer.md","title":"BarVisualizer"},{"filename":"carousellayout.md","title":"CarouselLayout"},{"filename":"chat.md","title":"Chat"},{"filename":"chatentry.md","title":"ChatEntry"},{"filename":"chattoggle.md","title":"ChatToggle"},{"filename":"clearpinbutton.md","title":"ClearPinButton"},{"filename":"connectionqualityindicator.md","title":"ConnectionQualityIndicator"},{"filename":"connectionstate.md","title":"ConnectionState"},{"filename":"connectionstatetoast.md","title":"ConnectionStateToast"},{"filename":"controlbar.md","title":"ControlBar"},{"filename":"disconnectbutton.md","title":"DisconnectButton"},{"filename":"focuslayout.md","title":"FocusLayout"},{"filename":"focuslayoutcontainer.md","title":"FocusLayoutContainer"},{"filename":"focustoggle.md","title":"FocusToggle"},{"filename":"gridlayout.md","title":"GridLayout"},{"filename":"layoutcontext.md","title":"LayoutContext"},{"filename":"layoutcontextprovider.md","title":"LayoutContextProvider"},{"filename":"livekitroom.md","title":"LiveKitRoom"},{"filename":"mediadevicemenu.md","title":"MediaDeviceMenu"},{"filename":"mediadeviceselect.md","title":"MediaDeviceSelect"},{"filename":"participantaudiotile.md","title":"ParticipantAudioTile"},{"filename":"participantcontext.md","title":"ParticipantContext"},{"filename":"participantcontextifneeded.md","title":"ParticipantContextIfNeeded"},{"filename":"participantloop.md","title":"ParticipantLoop"},{"filename":"participantname.md","title":"ParticipantName"},{"filename":"participanttile.md","title":"ParticipantTile"},{"filename":"prejoin.md","title":"PreJoin"},{"filename":"roomaudiorenderer.md","title":"RoomAudioRenderer"},{"filename":"roomcontext.md","title":"RoomContext"},{"filename":"roomname.md","title":"RoomName"},{"filename":"sessionprovider.md","title":"SessionProvider"},{"filename":"startaudio.md","title":"StartAudio"},{"filename":"startmediabutton.md","title":"StartMediaButton"},{"filename":"toast.md","title":"Toast"},{"filename":"trackloop.md","title":"TrackLoop"},{"filename":"trackmutedindicator.md","title":"TrackMutedIndicator"},{"filename":"trackrefcontext.md","title":"TrackRefContext"},{"filename":"tracktoggle.md","title":"TrackToggle"},{"filename":"videoconference.md","title":"VideoConference"},{"filename":"videotrack.md","title":"VideoTrack"},{"filename":"voiceassistantcontrolbar.md","title":"VoiceAssistantControlBar"}],"hooks":[{"filename":"useagent.md","title":"useAgent"},{"filename":"useagentexpression.md","title":"useAgentExpression"},{"filename":"useaudioplayback.md","title":"useAudioPlayback"},{"filename":"useaudiowaveform.md","title":"useAudioWaveform"},{"filename":"usechat.md","title":"useChat"},{"filename":"usechattoggle.md","title":"useChatToggle"},{"filename":"useclearpinbutton.md","title":"useClearPinButton"},{"filename":"useconnectionqualityindicator.md","title":"useConnectionQualityIndicator"},{"filename":"useconnectionstate.md","title":"useConnectionState"},{"filename":"usecreatelayoutcontext.md","title":"useCreateLayoutContext"},{"filename":"usedatachannel.md","title":"useDataChannel"},{"filename":"usedisconnectbutton.md","title":"useDisconnectButton"},{"filename":"useensurecreatelayoutcontext.md","title":"useEnsureCreateLayoutContext"},{"filename":"useensurelayoutcontext.md","title":"useEnsureLayoutContext"},{"filename":"useensureparticipant.md","title":"useEnsureParticipant"},{"filename":"useensureroom.md","title":"useEnsureRoom"},{"filename":"useensuresession.md","title":"useEnsureSession"},{"filename":"useensuretrackref.md","title":"useEnsureTrackRef"},{"filename":"useevents.md","title":"useEvents"},{"filename":"usefacingmode.md","title":"useFacingMode"},{"filename":"usefocustoggle.md","title":"useFocusToggle"},{"filename":"usegridlayout.md","title":"useGridLayout"},{"filename":"useisencrypted.md","title":"useIsEncrypted"},{"filename":"useismuted.md","title":"useIsMuted"},{"filename":"useisrecording.md","title":"useIsRecording"},{"filename":"useisspeaking.md","title":"useIsSpeaking"},{"filename":"usekrispnoisefilter.md","title":"useKrispNoiseFilter"},{"filename":"uselayoutcontext.md","title":"useLayoutContext"},{"filename":"uselivekitroom.md","title":"useLiveKitRoom"},{"filename":"uselocalparticipant.md","title":"useLocalParticipant"},{"filename":"uselocalparticipantpermissions.md","title":"useLocalParticipantPermissions"},{"filename":"usemaybelayoutcontext.md","title":"useMaybeLayoutContext"},{"filename":"usemaybeparticipantcontext.md","title":"useMaybeParticipantContext"},{"filename":"usemayberoomcontext.md","title":"useMaybeRoomContext"},{"filename":"usemaybesessioncontext.md","title":"useMaybeSessionContext"},{"filename":"usemaybetrackrefcontext.md","title":"useMaybeTrackRefContext"},{"filename":"usemediadevices.md","title":"useMediaDevices"},{"filename":"usemediadeviceselect.md","title":"useMediaDeviceSelect"},{"filename":"usemultibandtrackvolume.md","title":"useMultibandTrackVolume"},{"filename":"usepagination.md","title":"usePagination"},{"filename":"useparticipantattribute.md","title":"useParticipantAttribute"},{"filename":"useparticipantattributes.md","title":"useParticipantAttributes"},{"filename":"useparticipantcontext.md","title":"useParticipantContext"},{"filename":"useparticipantinfo.md","title":"useParticipantInfo"},{"filename":"useparticipantpermissions.md","title":"useParticipantPermissions"},{"filename":"useparticipants.md","title":"useParticipants"},{"filename":"useparticipanttile.md","title":"useParticipantTile"},{"filename":"useparticipanttracks.md","title":"useParticipantTracks"},{"filename":"usepersistentuserchoices.md","title":"usePersistentUserChoices"},{"filename":"usepinnedtracks.md","title":"usePinnedTracks"},{"filename":"usepreviewdevice.md","title":"usePreviewDevice"},{"filename":"usepreviewtracks.md","title":"usePreviewTracks"},{"filename":"useremoteparticipant.md","title":"useRemoteParticipant"},{"filename":"useremoteparticipants.md","title":"useRemoteParticipants"},{"filename":"useroomcontext.md","title":"useRoomContext"},{"filename":"useroominfo.md","title":"useRoomInfo"},{"filename":"userpc.md","title":"useRpc"},{"filename":"usesequentialroomconnectdisconnect.md","title":"useSequentialRoomConnectDisconnect"},{"filename":"usesession.md","title":"useSession"},{"filename":"usesessioncontext.md","title":"useSessionContext"},{"filename":"usesessionmessages.md","title":"useSessionMessages"},{"filename":"usesortedparticipants.md","title":"useSortedParticipants"},{"filename":"usespeakingparticipants.md","title":"useSpeakingParticipants"},{"filename":"usestartaudio.md","title":"useStartAudio"},{"filename":"usestartvideo.md","title":"useStartVideo"},{"filename":"useswipe.md","title":"useSwipe"},{"filename":"usetextstream.md","title":"useTextStream"},{"filename":"usetoken.md","title":"useToken"},{"filename":"usetrackbyname.md","title":"useTrackByName"},{"filename":"usetrackmutedindicator.md","title":"useTrackMutedIndicator"},{"filename":"usetrackrefcontext.md","title":"useTrackRefContext"},{"filename":"usetracks.md","title":"useTracks"},{"filename":"usetracktoggle.md","title":"useTrackToggle"},{"filename":"usetracktranscription.md","title":"useTrackTranscription"},{"filename":"usetrackvolume.md","title":"useTrackVolume"},{"filename":"usetranscriptions.md","title":"useTranscriptions"},{"filename":"usevisualstableupdate.md","title":"useVisualStableUpdate"},{"filename":"usevoiceassistant.md","title":"useVoiceAssistant"}]}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "parseExpression",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useAgentExpression.ts"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
# parseExpression
|
|
11
|
+
|
|
12
|
+
{% callout type="note" variation="normal" %}
|
|
13
|
+
|
|
14
|
+
This feature is under active development and may change based on developer feedback and real-world usage.
|
|
15
|
+
|
|
16
|
+
{% /callout %}
|
|
17
|
+
|
|
18
|
+
The expression published on a transcript segment, or null when it carries none.
|
|
19
|
+
|
|
20
|
+
**Signature:**
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
export declare function parseExpression(segment: TextStreamData): UseAgentExpressionReturn | null;
|
|
24
|
+
```
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "UseAgentExpressionOptions interface",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useAgentExpression.ts"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
# UseAgentExpressionOptions interface
|
|
11
|
+
|
|
12
|
+
{% callout type="note" variation="normal" %}
|
|
13
|
+
|
|
14
|
+
This feature is under active development and may change based on developer feedback and real-world usage.
|
|
15
|
+
|
|
16
|
+
{% /callout %}
|
|
17
|
+
|
|
18
|
+
**Signature:**
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
export interface UseAgentExpressionOptions extends UseTranscriptionsOptions
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
**Extends:** [UseTranscriptionsOptions](./react/usetranscriptionsoptions.md)
|
|
25
|
+
|
|
26
|
+
## Properties
|
|
27
|
+
|
|
28
|
+
| Property | Type | Description |
|
|
29
|
+
| ---------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------- |
|
|
30
|
+
| [ttlTurns?](./react/useagentexpressionoptions.ttlturns.md) | number | **_(BETA)_** _(Optional)_ Agent turns an expression survives before the mood decays to null. <code>0</code> disables decay. |
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "UseAgentExpressionOptions.ttlTurns property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
6
|
+
|
|
7
|
+
# UseAgentExpressionOptions.ttlTurns property
|
|
8
|
+
|
|
9
|
+
{% callout type="note" variation="normal" %}
|
|
10
|
+
|
|
11
|
+
This feature is under active development and may change based on developer feedback and real-world usage.
|
|
12
|
+
|
|
13
|
+
{% /callout %}
|
|
14
|
+
|
|
15
|
+
Agent turns an expression survives before the mood decays to null. `0` disables decay.
|
|
16
|
+
|
|
17
|
+
**Signature:**
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
ttlTurns?: number;
|
|
21
|
+
```
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "UseAgentExpressionReturn.expression property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
6
|
+
|
|
7
|
+
# UseAgentExpressionReturn.expression property
|
|
8
|
+
|
|
9
|
+
{% callout type="note" variation="normal" %}
|
|
10
|
+
|
|
11
|
+
This feature is under active development and may change based on developer feedback and real-world usage.
|
|
12
|
+
|
|
13
|
+
{% /callout %}
|
|
14
|
+
|
|
15
|
+
The provider's own delivery wording behind the mood, verbatim and free-form.
|
|
16
|
+
|
|
17
|
+
**Signature:**
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
expression: string | null;
|
|
21
|
+
```
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
---
|
|
2
|
+
{
|
|
3
|
+
"title": "UseAgentExpressionReturn interface",
|
|
4
|
+
"linkToSource": "https://github.com/livekit/components-js/blob/main/packages/react/src/hooks/useAgentExpression.ts"
|
|
5
|
+
}
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
9
|
+
|
|
10
|
+
# UseAgentExpressionReturn interface
|
|
11
|
+
|
|
12
|
+
{% callout type="note" variation="normal" %}
|
|
13
|
+
|
|
14
|
+
This feature is under active development and may change based on developer feedback and real-world usage.
|
|
15
|
+
|
|
16
|
+
{% /callout %}
|
|
17
|
+
|
|
18
|
+
**Signature:**
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
export interface UseAgentExpressionReturn
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Properties
|
|
25
|
+
|
|
26
|
+
| Property | Type | Description |
|
|
27
|
+
| ------------------------------------------------------------ | ----------------------------------------- | -------------------------------------------------------------------------------------------- |
|
|
28
|
+
| [expression](./react/useagentexpressionreturn.expression.md) | string \| null | **_(BETA)_** The provider's own delivery wording behind the mood, verbatim and free-form. |
|
|
29
|
+
| [mood](./react/useagentexpressionreturn.mood.md) | [AgentMood](./react/agentmood.md) \| null | **_(BETA)_** The normalized mood, or null when the agent hasn't expressed anything recently. |
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
---
|
|
2
|
+
{ "title": "UseAgentExpressionReturn.mood property" }
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
6
|
+
|
|
7
|
+
# UseAgentExpressionReturn.mood property
|
|
8
|
+
|
|
9
|
+
{% callout type="note" variation="normal" %}
|
|
10
|
+
|
|
11
|
+
This feature is under active development and may change based on developer feedback and real-world usage.
|
|
12
|
+
|
|
13
|
+
{% /callout %}
|
|
14
|
+
|
|
15
|
+
The normalized mood, or null when the agent hasn't expressed anything recently.
|
|
16
|
+
|
|
17
|
+
**Signature:**
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
mood: AgentMood | null;
|
|
21
|
+
```
|
|
@@ -6,6 +6,12 @@
|
|
|
6
6
|
|
|
7
7
|
# UseMediaDeviceSelectProps.track property
|
|
8
8
|
|
|
9
|
+
{% callout type="caution" variation="normal" %}
|
|
10
|
+
|
|
11
|
+
This API is deprecated: Passing a local track is no longer needed. Without a `room`<!-- -->, the hook falls back to the room from the context or to a new, unconnected `Room`<!-- -->, and tracks the active device through that room.
|
|
12
|
+
|
|
13
|
+
{% /callout %}
|
|
14
|
+
|
|
9
15
|
**Signature:**
|
|
10
16
|
|
|
11
17
|
```typescript
|
|
@@ -19,9 +19,7 @@ This feature is under active development and may change based on developer feedb
|
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
21
|
export type UseSessionReturn = (
|
|
22
|
-
|
|
|
23
|
-
| SessionStateConnected
|
|
24
|
-
| SessionStateDisconnected
|
|
22
|
+
SessionStateConnecting | SessionStateConnected | SessionStateDisconnected
|
|
25
23
|
) &
|
|
26
24
|
SessionActions;
|
|
27
25
|
```
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@livekit/components-js-docs",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.78",
|
|
4
4
|
"description": "Automatically generated documentation pages for LiveKit Components JS. Intended to be consumed by the documentation page.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"directory": "/docs/beta-docs"
|
|
9
9
|
},
|
|
10
10
|
"dependencies": {
|
|
11
|
-
"@livekit/components-react": "2.9.
|
|
11
|
+
"@livekit/components-react": "2.9.25"
|
|
12
12
|
},
|
|
13
13
|
"author": "",
|
|
14
14
|
"license": "Apache-2.0",
|