@xmov/avatar 2.0.0-alpha.38

package/dist/index.d.ts

@@ -0,0 +1,231 @@
+import { AvatarStatus, RenderState, IAvatarOptions, IInitParams, Layout, WalkConfig } from "./types/index";
+import { ISessionResponse, TDownloadProgress } from "./modules/ResourceManager";
+import Errors from './modules/error-handle';
+import './utils/logger.js';
+import { IBRAnimationGeneratorCharInfo_NN, unpackIBRAnimation, formatMJT } from './utils/DataInterface';
+import { getVertices, getWavefrontObjFromVertices, getPCATextures } from './utils/GLPipelineDebugTools';
+import { GLDevice } from './utils/GLDevice';
+import { GLPipeline } from './utils/GLPipeline';
+import { checkCapability } from './utils/capability-checker';
+export default class XmovAvatar {
+    private options;
+    private TAG;
+    private el;
+    private status;
+    private resourceManager;
+    private renderScheduler;
+    private networkMonitor;
+    private ttsa;
+    private debugOverlay;
+    private _offlineTimer;
+    private readonly _offlineInterval;
+    private _env;
+    private avatarCanvasVisible;
+    private pendingInvisibleMode;
+    private isInitialized;
+    onStateChange: (state: string) => void;
+    onDownloadProgress: TDownloadProgress | null;
+    static IBRAnimationGeneratorCharInfo_NN: typeof IBRAnimationGeneratorCharInfo_NN;
+    static unpackIBRAnimation: typeof unpackIBRAnimation;
+    static formatMJT: typeof formatMJT;
+    static getVertices: typeof getVertices;
+    static getPCATextures: typeof getPCATextures;
+    static getWavefrontObjFromVertices: typeof getWavefrontObjFromVertices;
+    static GLDevice: typeof GLDevice;
+    static GLPipeline: typeof GLPipeline;
+    static checkCapability: typeof checkCapability;
+    private boundVisibilityChange;
+    private replayData;
+    private startConnectTime;
+    private connectSuccessTime;
+    private sessionResTime;
+    private charbinResTime;
+    private isfirstReceive;
+    private enableClientInterrupt;
+    private retryCount;
+    private retryTimer;
+    private maxRetryCount;
+    private retryRound;
+    private maxRetryRound;
+    private isRetrying;
+    private isStartRetry;
+    private destroyed;
+    private incompleteInitializationCleanupPromise;
+    private captureAudioCtx;
+    private captureWorklet;
+    private captureSource;
+    private captureSetupPromise;
+    private captureLastSpeechId;
+    private restartPlaybackCaptureImpl;
+    private captureEncodeQueue;
+    private captureGeneration;
+    private pcmCaptureLastSpeechId;
+    private pcmCaptureFirstChunk;
+    private pcmWebMEncoder;
+    private mediaRecorderEncoder;
+    private pcmCaptureMode;
+    private pcmEncodeId;
+    private reconnectDebounceTimer;
+    private networkInfo;
+    private mediaRecorder;
+    private recordedChunks;
+    private stream;
+    private _isClientMode;
+    private _streamingClient;
+    private _videoPlayer;
+    private _eventDispatcher;
+    private _apiForwarder;
+    private _clientOnDownloadProgress;
+    private _pendingInit;
+    private _pendingInitConfig;
+    private _clientSessionId;
+    constructor(options: IAvatarOptions);
+    getStatus(): AvatarStatus | -1;
+    get businessENV(): string;
+    getUniqueSpeakId(): string;
+    private initializeSDK;
+    /**
+     * 薄客户端模式初始化：创建容器、StreamingClient、VideoPlayer、EventDispatcher、APIForwarder
+     */
+    private initializeClient;
+    private renderFrameCallback;
+    init(params: IInitParams): Promise<ISessionResponse | null | undefined>;
+    /**
+     * 初始化音频捕获（MSE 模式）
+     * 通过 AudioContext.createMediaElementSource 接管 <audio> 元素输出，
+     * 按 1600 samples 分桶后使用 WebCodecs 编码为 opus (WebM 容器)，
+     * 并回调给业务侧用于 ASR 回声消除（AEC）。
+     *
+     * 架构：
+     * - AudioWorklet 负责 100ms 分桶和静音检测
+     * - WebCodecs AudioEncoder + WebMMuxer 负责 opus/WebM 编码
+     * - 每次 speak 会话的首段音频自动包含 WebM 容器头（isFirstChunk=true）
+     *
+     * 注意：
+     * - createMediaElementSource 对同一个 audio 元素只能调用一次
+     * - 接管后必须手动 connect 到 destination，否则音频不会播放
+     * - MSE 播放器 stop 时只销毁 MediaSource，audio 元素不变，捕获绑定不受影响
+     */
+    protected setAudioPlaybackDataHandler(handler?: IAvatarOptions["onAudioPlaybackData"]): void;
+    protected restartAudioPlaybackCapture(): void;
+    protected enableAudioPlaybackCapture(): Promise<void>;
+    private setupAudioCapture;
+    /**
+     * 初始化 PCM 模式音频捕获（raw_audio=true 时使用）
+     * 通过 PCMAudioPlayer 的 capture worklet 拦截音频输出，
+     * 经 WebCodecs 或 MediaRecorder 编码为 WebM/Opus 后回调给业务侧
+     */
+    private setupPCMCapture;
+    visibilitychange(): void;
+    setReplayData(data: any): void;
+    handleReplaySend(frame: number): void;
+    private connectTtsa;
+    protected start(): void;
+    protected onTtsaReady(_sessionInfo?: ISessionResponse): void;
+    private _reload;
+    protected onSessionReloaded(_sessionInfo: ISessionResponse): Promise<void>;
+    protected onSessionReloadExhausted(_error?: unknown): void;
+    protected restartSessionForTransport(reason: string): Promise<void>;
+    protected cancelSessionRestart(): void;
+    reloadSuccess(): void;
+    protected stop(): Promise<void>;
+    private handleBeforeUnload;
+    isDestroyed(): boolean;
+    destroyClient(): Promise<void>;
+    destroy(stop_reason?: string): Promise<void>;
+    idle(): void;
+    listen(): void;
+    think(): void;
+    interactiveidle(): void;
+    speak(ssml: string, is_start?: boolean, is_end?: boolean, extra?: {
+        client_speak_id: string;
+        client_frame: number;
+    }): string | undefined;
+    setOffsetFrame(offsetFrame: number): void;
+    syncTimestamp(): void;
+    /**
+       * 通知后端进入隐身模式
+       */
+    private notifyEnterInvisibleMode;
+    /**
+     * 通知后端退出隐身模式
+     */
+    private notifyExitInvisibleMode;
+    setVolume(volume: number): void;
+    getSessionId(): string | undefined;
+    showDebugInfo(): void;
+    hideDebugInfo(): void;
+    changeAvatarVisible(visible: boolean): void;
+    /**
+     * 在初始化未完成时清理所有已初始化的资源
+     * @param reason 清理原因
+     */
+    protected cleanupBeforeInitComplete(reason: string): Promise<void>;
+    protected reportInitializationFailure(message: string, cause?: unknown): void;
+    private offlineHandle;
+    stopSessionFromSocket(reason: string): Promise<void>;
+    offlineMode(): void;
+    onlineMode(): void;
+    onMessage(params: Parameters<typeof Errors>[0]): void;
+    onStatusChange(status: AvatarStatus): void;
+    /**
+     * 切换隐身模式（暂停/恢复音视频实时渲染）
+     */
+    switchInvisibleMode(): void;
+    private setInvisibleMode;
+    getPendingInvisibleMode(): boolean;
+    /**
+     * 获取当前渲染状态
+     */
+    getRenderState(): RenderState;
+    changeLayout(layout: Layout): void;
+    changeWalkConfig(walkConfig: WalkConfig): void;
+    interrupt(type: string): number;
+    private triggerReconnect;
+    reStartSession(): void;
+    private _retryImpl;
+    private clearAllRetryTimers;
+    private resetRetryState;
+    seekToFrame(frame: number): void;
+    startRecoder(): Promise<void>;
+    stopRecoder(): void;
+    exportVideo(): void;
+    getOptions(): IAvatarOptions;
+    /**
+     * [测试用] 模拟 WebGL 上下文丢失
+     * 用于测试分阶段恢复策略是否正常工作
+     *
+     * @param restoreAfterMs 自动恢复上下文的延迟时间（毫秒），默认 5000ms
+     * @param forceFail 强制恢复失败（用于测试 medium/full 阶段的升级逻辑）
+     *
+     * @example
+     * // 在浏览器控制台执行：
+     * avatar.simulateContextLoss(5000);        // 模拟丢失，5秒后自动恢复
+     * avatar.simulateContextLoss(0, true);     // 模拟丢失，不自动恢复（测试升级逻辑）
+     */
+    simulateContextLoss(restoreAfterMs?: number, forceFail?: boolean): void;
+    /**
+     * [测试用] 获取当前 WebGL 上下文恢复状态
+     */
+    getRecoveryStatus(): {
+        isRecovering: boolean;
+        stage: string;
+        attempts: number;
+        maxAttempts: number;
+        isUsingReducedResolution: boolean;
+    } | null;
+    /**
+     * [测试用] 批量测试分阶段恢复
+     * 依次触发多次上下文丢失，观察各阶段的恢复情况
+     */
+    testStagedRecovery(): Promise<void>;
+    /**
+     * 手动重启 WebGL：创建新 canvas + 新 GLDevice + 新 GLPipeline
+     * 用于分阶段恢复全部失败后的手动恢复
+     * @returns 是否成功
+     *
+     * @example
+     * const ok = avatar.restartWebGL();
+     */
+    restartWebGL(): boolean;
+}