realtime-avatar 0.3.0

package/dist/react.d.ts

@@ -0,0 +1,107 @@
+import { ReactNode } from 'react';
+import { A as AvatarSessionClient, a as AvatarVideoFit } from './proxy-client-cZyX50-O.js';
+export { b as ApproachingEndEvent, c as ApproachingEndReason, d as AvatarVideoSurface, e as AvatarVideoSurfaceProps, B as BehaviorSnapshot, C as CallTranscript, f as CallTranscriptSegment, g as CartesiaTtsModel, h as ClipResult, i as ClosingTurnResult, j as CreditsLowEvent, D as DEFAULT_APPROACHING_END_LEAD_SECONDS, k as DEFAULT_AVATAR_PLAYOUT_DELAY_SECONDS, l as DEFAULT_CREDITS_LOW_LEAD_SECONDS, m as DEFAULT_GOVERNOR_CONFIG, n as DEFAULT_GRACE_CEILING_SECONDS, o as DEFAULT_GRACE_WINDOW_LEAD_SECONDS, p as DEFAULT_IDLE_SECONDS, q as DEFAULT_IDLE_WARN_LEAD_SECONDS, r as DEFAULT_TURN_TIMEOUT_SECONDS, E as EndReason, s as EndedEvent, t as ExtendResult, F as FishTtsModel, u as FreezeReadingFn, G as Governor, v as GovernorAction, w as GovernorConfig, x as GovernorSignal, y as GovernorState, z as GraceWindowClosedEvent, H as GraceWindowOpenEvent, I as GraceWindowState, J as IdleWarningEvent, K as KnownBehaviorState, L as LLMProvider, M as LLMSelection, N as LiveKitAvatarGrantState, O as LiveKitAvatarGrantStatus, P as LiveKitCapacityState, Q as LiveKitConnectionStatus, R as LiveKitSessionRequest, S as LiveKitSessionStartResult, T as LivePlaybackKeeper, U as MAX_RECONNECT_ATTEMPTS, V as MAX_SESSION_INSTRUCTIONS_CHARS, W as MIC_LEASE_ENDED_TIMEOUT_MS, X as MicLease, Y as PlayableVideoElement, Z as ProxyClientOptions, _ as QualityCap, $ as RECONNECT_BACKOFF_MS, a0 as RealtimeAvatarCapacityError, a1 as RealtimeAvatarLiveKitRoom, a2 as RealtimeAvatarLiveKitRoomProps, a3 as RealtimeAvatarRequestOptions, a4 as RealtimeSessionApi, a5 as RealtimeSessionMedia, a6 as RealtimeSessionRoomSinks, a7 as ReconnectPolicy, a8 as ReconnectingEvent, a9 as RecoveryState, aa as RetryStep, ab as SessionBehavior, ac as SessionClip, ad as SessionClocks, ae as SessionEndReason, af as SessionLifecycleApi, ag as SessionLifecyclePhase, ah as SessionLifecyclePhaseKind, ai as SessionLifecycleRoomBridge, aj as SessionLifecycleRoomBridgeProps, ak as SurfaceLayers, al as TurnState, am as TurnTimeoutEvent, an as UseAvatarQualityGovernorInput, ao as UseLiveKitAvatarGrantInput, ap as UseRealtimeSessionInput, aq as UseSessionLifecycleInput, ar as VoiceSpec, as as VoiceSpecInput, at as capacityErrorFromBusy, au as capacityStateFromGrant, av as createProxyClient, aw as knownBehaviorStates, ax as mapTurnState, ay as sessionBehaviorSchema, az as sessionClipSchema, aA as shouldReplayPendingTurn, aB as splitCallTranscript, aC as useAvatarPlayoutDelay, aD as useAvatarQualityGovernor, aE as useCallTranscript, aF as useLiveKitAvatarGrant, aG as useMicLease, aH as useRealtimeSession, aI as useReleaseMicLeaseOnTrackEnded, aJ as useSessionLifecycle } from './proxy-client-cZyX50-O.js';
+import '@livekit/components-react';
+import 'livekit-client';
+import 'zod';
+
+/**
+ * The CONNECT surface (client half) — one component that puts a live character on screen.
+ *
+ * WHY THIS EXISTS. The lower-level surface is deliberately LiveKit-first: the app owns the
+ * room, mounts the lifecycle bridge, maps a nine-arm phase union to its own copy, and wires
+ * the video surface. That is the right shape for a team that wants to own media policy, and
+ * it is far too much surface for a team that wants a character on screen. Worse, it makes
+ * the transport part of the integration contract: an app that names `RealtimeAvatarLiveKitRoom`
+ * and `SessionLifecycleRoomBridge` is coupled to WebRTC-via-LiveKit forever.
+ *
+ * `<AvatarCall>` closes that hole. It mounts the room, the bridge, and the video surface, and
+ * reports a FIVE-arm status that says nothing about how the pixels arrive. Swapping the
+ * transport underneath is then our problem, not the integrator's.
+ *
+ * Everything the lower-level API offers is still exported and still supported — this is
+ * additive. Reach for it when you genuinely need to own the room.
+ */
+
+/**
+ * What the app renders a banner for. Deliberately NOT the internal phase union: those arms
+ * name connection mechanics, and an integrator should never write `case "reconnectable"`.
+ */
+type AvatarCallStatus = 
+/** Getting the character ready. */
+"connecting"
+/** Every slot is busy; we are holding a place in line. Not an error. */
+ | "waiting"
+/** She is there. */
+ | "live"
+/** A blip; recovering automatically. */
+ | "recovering"
+/** Over. `onEnded` already told you why. */
+ | "ended";
+/** Why a call ended — the only vocabulary an end screen needs. */
+type AvatarCallEndReason = "user_ended" | "session_cap" | "idle" | "disconnected" | "out_of_credits" | "agent_ended" | "failed";
+type AvatarCallHandle = {
+    status: AvatarCallStatus;
+    /** Place in line while `status === "waiting"`, else null. */
+    queuePosition: number | null;
+    /** Seconds until the hard cap, or null before the clock lands. */
+    secondsRemaining: number | null;
+    /** Say something to her. Optional `steer` shapes THIS reply only (tool results go here). */
+    say: (text: string, options?: {
+        steer?: string;
+    }) => Promise<void>;
+    /** Speak one exact line, verbatim, then end. For goodbyes and disclosures. */
+    sayAndEnd: (text: string) => void;
+    /** The user is still here — postpones the idle disconnect. */
+    keepAlive: () => void;
+    /** End now. */
+    end: () => void;
+};
+type AvatarCallProps = {
+    client: AvatarSessionClient;
+    /** Which character. */
+    avatarId: string;
+    /** `voice` is audio-only and cheaper; `avatar` (default) is the full call. */
+    mode?: "avatar" | "voice";
+    /** Listen to the user's microphone. Default true. */
+    listen?: boolean;
+    /** A looping clip shown before she is live and whenever the stream is not producing. */
+    idleVideoUrl?: string | null;
+    /** A still shown before the idle clip is playable. */
+    poster?: string | null;
+    fit?: AvatarVideoFit;
+    className?: string;
+    /** Your remaining balance in ms, if you want `onLowBalance`. */
+    balanceMs?: number;
+    onStatusChange?: (status: AvatarCallStatus) => void;
+    onEnded?: (event: {
+        reason: AvatarCallEndReason;
+    }) => void;
+    /** She is nearly out of time — write her goodbye and pass it to `sayAndEnd`. */
+    onEnding?: (event: {
+        secondsLeft: number;
+        call: AvatarCallHandle;
+    }) => void;
+    /** The user went quiet. */
+    onQuiet?: (event: {
+        secondsLeft: number;
+    }) => void;
+    /** Balance running low. */
+    onLowBalance?: (event: {
+        secondsLeft: number;
+    }) => void;
+    /** Overlay your own UI on the video; receives the same handle as `useAvatarCall`. */
+    children?: (call: AvatarCallHandle) => ReactNode;
+};
+/**
+ * The connect-level hook, for apps that want their own layout around the video. Returns the
+ * same handle `<AvatarCall>` hands its children, plus the element to render.
+ */
+declare function useAvatarCall(props: AvatarCallProps): {
+    call: AvatarCallHandle;
+    view: ReactNode;
+};
+/** One component: a live character on screen. */
+declare function AvatarCall(props: AvatarCallProps): ReactNode;
+
+export { AvatarCall, type AvatarCallEndReason, type AvatarCallHandle, type AvatarCallProps, type AvatarCallStatus, AvatarSessionClient, AvatarVideoFit, useAvatarCall };