realtime-avatar 0.3.0

package/dist/react-native.d.ts

@@ -0,0 +1,103 @@
+import { LiveKitRoomProps } from '@livekit/react-native';
+export { AudioSession, VideoTrack, VideoTrackProps, registerGlobals } from '@livekit/react-native';
+import { ReactNode, ReactElement } from 'react';
+import { aK as LiveKitSessionGrant, a as AvatarVideoFit } from './proxy-client-cZyX50-O.js';
+export { b as ApproachingEndEvent, c as ApproachingEndReason, A as AvatarSessionClient, 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, U as MAX_RECONNECT_ATTEMPTS, V as MAX_SESSION_INSTRUCTIONS_CHARS, Z as ProxyClientOptions, _ as QualityCap, $ as RECONNECT_BACKOFF_MS, 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, aL as isNativeLiveTrackSubscribed, aw as knownBehaviorStates, ax as mapTurnState, ay as sessionBehaviorSchema, az as sessionClipSchema, aB as splitCallTranscript, aC as useAvatarPlayoutDelay, aD as useAvatarQualityGovernor, aE as useCallTranscript, aF as useLiveKitAvatarGrant, aM as useLiveTrackProducing, aG as useMicLease, aH as useRealtimeSession, aI as useReleaseMicLeaseOnTrackEnded, aJ as useSessionLifecycle } from './proxy-client-cZyX50-O.js';
+import { StyleProp, ViewStyle } from 'react-native';
+export { useChat, useConnectionState, useLocalParticipant, useRoomContext, useTrackToggle, useTranscriptions, useVoiceAssistant } from '@livekit/components-react';
+export { DisconnectReason, RemoteAudioTrack, RemoteTrack, RemoteVideoTrack, Room, RoomEvent, SendTextOptions, Track } from 'livekit-client';
+import 'zod';
+
+type RealtimeAvatarLiveKitRoomProps = Omit<LiveKitRoomProps, "serverUrl" | "token" | "connect" | "audio" | "video" | "options"> & {
+    grant: LiveKitSessionGrant | null | undefined;
+    connect?: boolean;
+    /** Native LiveKit audio publish option. Defaults to server-STT sessions only. */
+    audio?: LiveKitRoomProps["audio"];
+    /** Native LiveKit video publish option. Defaults to false for avatar calls. */
+    video?: LiveKitRoomProps["video"];
+    /** Passed directly to LiveKitRoom. */
+    options?: LiveKitRoomProps["options"];
+    /**
+     * Start the OS audio session while the room is connected (and stop it after).
+     * Default true — without an active session, iOS plays no call audio. Set false
+     * when the app manages `AudioSession` itself (custom category/mode).
+     */
+    manageAudioSession?: boolean;
+    children?: ReactNode;
+};
+/**
+ * Own the native OS audio session for the duration of `enabled`. Split out of
+ * the room bridge so an app that composes its own room (imperative Room, custom
+ * LiveKitRoom props) can still one-line the session lifecycle.
+ */
+declare function useRealtimeAvatarAudioSession(enabled: boolean): void;
+/** Thin typed bridge from a Realtime Avatar grant into the native LiveKitRoom. */
+declare function RealtimeAvatarLiveKitRoom(props: RealtimeAvatarLiveKitRoomProps): ReactElement;
+
+/** What the surface hands `renderIdleVideo` — enough to drop in any RN player. */
+type IdleVideoRender = {
+    /** The idle clip URL (never null — the callback only runs when one exists). */
+    url: string;
+    /** Absolute-fill style for the player, matching the other layers' box. */
+    style: StyleProp<ViewStyle>;
+    /** The surface's fit, as the player's resize semantic ("cover" | "contain"). */
+    resizeMode: AvatarVideoFit;
+};
+type AvatarVideoSurfaceProps = {
+    /**
+     * The avatar's idle/ambient clip URL, layered OVER the {@link poster} floor
+     * via {@link renderIdleVideo}. Pass `null` for avatars with no idle clip;
+     * the poster floor then shows at rest.
+     */
+    idleVideoUrl: string | null;
+    /**
+     * Renders the idle clip with the APP's video player (expo-video,
+     * react-native-video, …) — native has no built-in <video>, and the SDK does
+     * not pick a player for you. Loop it and keep it muted. When omitted, the
+     * idle layer is skipped and the poster is the resting floor.
+     */
+    renderIdleVideo?: (idle: IdleVideoRender) => ReactNode;
+    /**
+     * The avatar's PORTRAIT (its face) — the DEEPEST floor, behind the idle clip
+     * and the live video. It paints immediately and is the guaranteed no-frames
+     * backdrop, so the surface is never a black box while connecting / listening
+     * / between turns. Pass `null` to fall through to the app's own floor.
+     */
+    poster?: string | null;
+    /**
+     * The caller's INTENT to show the live stream. Still gated on the LiveKit
+     * connection state and a subscribed, PRODUCING video track, so a stale `true`
+     * can never leave a frozen/black live layer up. Default true.
+     */
+    live?: boolean;
+    /** Enable the subscriber-side quality governor (stats + SFU-pause tiers). Default true. */
+    adaptiveQuality?: boolean;
+    /** How media fits the box — mirrors CSS object-fit. Both layers share it. Default "contain". */
+    fit?: AvatarVideoFit;
+    /** Crossfade duration (ms) between idle and live. Default 500. */
+    crossfadeMs?: number;
+    /**
+     * Debounce (ms) before dropping BACK to the idle/poster floor once the live
+     * layer stops, so back-to-back turns don't flash the floor between them.
+     * Default 700. A disconnect bypasses this and reverts immediately.
+     */
+    idleReturnDelayMs?: number;
+    /** Style for the box (the layers fill it). The CONSUMER owns the aspect box. */
+    style?: StyleProp<ViewStyle>;
+    /** Overlay content rendered above both media layers (badges, chrome, scrims). */
+    children?: ReactNode;
+    /** Surface a small "live · WxH" badge when the live layer is shown. Default true. */
+    showLiveBadge?: boolean;
+    /** Test id for the box. */
+    testID?: string;
+};
+/**
+ * The native avatar video surface: one box rendering the poster floor, the
+ * (app-injected) idle clip, and the realtime LiveKit video as pixel-aligned
+ * layers with a crossfade — falling back to the idle/poster floor whenever the
+ * realtime session is not connected or producing. Must be rendered inside a
+ * LiveKit room context (e.g. under the native `RealtimeAvatarLiveKitRoom`).
+ */
+declare function AvatarVideoSurface(props: AvatarVideoSurfaceProps): ReactElement;
+
+export { AvatarVideoFit, AvatarVideoSurface, type AvatarVideoSurfaceProps, type IdleVideoRender, RealtimeAvatarLiveKitRoom, type RealtimeAvatarLiveKitRoomProps, useRealtimeAvatarAudioSession };