@vivix-ai/ivi-frontend-sdk 0.3.2 → 0.3.3

package/dist/index.d.cts

@@ -72,6 +72,21 @@ interface IviRuntimeTrtcEvent {
     streamType?: unknown;
 }
 type IviRuntimeTrtcEventListener = (event: IviRuntimeTrtcEvent) => void;
+type IviRuntimeTrtcAIDenoiserMode = "normal" | "far_field_reduction";
+interface IviRuntimeTrtcAIDenoiserOptions {
+    /**
+     * 是否启用 TRTC AIDenoiser 插件，默认 true。
+     */
+    enabled?: boolean;
+    /**
+     * 降噪模式，默认 "normal"。
+     */
+    mode?: IviRuntimeTrtcAIDenoiserMode;
+    /**
+     * TRTC AIDenoiser 资源路径；未配置时使用 TRTC SDK 默认加载逻辑。
+     */
+    assetsPath?: string;
+}
 type IviRuntimeConversationLifecycle = "added" | "done";
 type IviRuntimeConversationStatus = "in_progress" | "completed" | "incomplete";
 interface IviRuntimeConversationItem {
@@ -103,6 +118,10 @@ interface IviRuntimeCoordinatorConfig {
      * TRTC SDK 原始事件回调；可用于业务监听远端音视频可用性等底层事件。
      */
     onTrtcEvent?: IviRuntimeTrtcEventListener;
+    /**
+     * TRTC SDK AIDenoiser 降噪配置。默认开启；传 false 可关闭。
+     */
+    trtcAIDenoiser?: boolean | IviRuntimeTrtcAIDenoiserOptions;
 }
 /**
  * 用户输入触发回复链路配置。
@@ -177,9 +196,10 @@ type TrtcSourceListener = (snapshot: TrtcSourceSnapshot) => void;
 declare class TrtcSourceManager {
     private readonly onLog?;
     private readonly onTrtcEvent?;
+    private readonly aiDenoiser?;
     private readonly sessions;
     private readonly listeners;
-    constructor(onLog?: IviRuntimeLogCallback | undefined, onTrtcEvent?: IviRuntimeTrtcEventListener | undefined);
+    constructor(onLog?: IviRuntimeLogCallback | undefined, onTrtcEvent?: IviRuntimeTrtcEventListener | undefined, aiDenoiser?: (boolean | IviRuntimeTrtcAIDenoiserOptions) | undefined);
     /**
      * 将 runtime 当前 sources 与 TRTC 会话池对齐：
      * - 对 ready + trtc 的 source 进行 upsert（必要时建立连接）
@@ -190,7 +210,7 @@ declare class TrtcSourceManager {
      * 按 sourceId 注册/更新 TRTC 配置。
      * 若配置发生变化，会先销毁旧会话再按新参数重建连接。
      */
-    upsertSource(sourceId: string, trtc: IviSourcePlaybackTrtc): void;
+    upsertSource(sourceId: string, trtc: IviSourcePlaybackTrtc, aiDenoiser?: boolean | IviRuntimeTrtcAIDenoiserOptions): void;
     /**
      * 删除指定 source 的 TRTC 会话并释放连接资源。
      * 该操作通常由 source.deleted 或会话重置触发。
@@ -232,6 +252,7 @@ declare class TrtcSourceManager {
      * - 至少一个 view 需出声 -> 对可用远端用户解除静音
      */
     private applyAudioPolicy;
+    private applyAIDenoiserPolicy;
     /**
      * 销毁单个 source 会话：
      * 解绑事件、停止远端视频、退出房间并销毁客户端。
@@ -546,6 +567,11 @@ interface IVITrtcPlayerProps {
     loadingFallback?: ReactNode;
     errorFallback?: ReactNode;
     muted?: boolean;
+    /**
+     * 独立使用 IVITrtcPlayer（未传 runtime）时的 TRTC AIDenoiser 降噪配置。
+     * 默认开启；传 false 可关闭。
+     */
+    trtcAIDenoiser?: boolean | IviRuntimeTrtcAIDenoiserOptions;
 }
 /**
  * 默认 TRTC 播放器：挂载即加入房间并拉流，连接由 TrtcSourceManager 统一复用。
@@ -724,4 +750,4 @@ declare function useManagedIviRuntime(config: IviManagedRuntimeConfig): IviRunti
 
 declare function useIviStageView(): IviStageViewContextValue;
 
-export { EMPTY_RUNTIME_STATE, IVILivekitPlayer, type IVILivekitPlayerProps, IVIStageView, type IVIStageViewProps, IVISubtitleOverlay, type IVISubtitleOverlayProps, type IVISubtitleOverlayStyle, IVITrackSlot, type IVITrackSlotProps, IVITrtcPlayer, type IVITrtcPlayerProps, type IviFrontendClientConfig, IviFrontendSdk, type IviManagedRuntimeConfig, type IviManagedRuntimeLogCallback, type IviManagedRuntimeLogEntry, type IviManagedRuntimeLogLevel, type IviManagedRuntimeLogSource, type IviRuntimeConversationItem, type IviRuntimeConversationLifecycle, type IviRuntimeConversationStatus, IviRuntimeCoordinator, type IviRuntimeCoordinatorConfig, IviRuntimeDispatcher, type IviRuntimeDispatcherConfig, type IviRuntimeEventListener, type IviRuntimeLogCallback, type IviRuntimeLogEntry, type IviRuntimeLogLevel, type IviRuntimeSource, type IviRuntimeSourcePreloadState, type IviRuntimeState, type IviRuntimeStatus, type IviRuntimeStream, type IviRuntimeTrtcEvent, type IviRuntimeTrtcEventListener, type IviRuntimeTrtcEventType, type IviRuntimeUserTextToResponseCallbacks, type IviRuntimeUserTextToResponseOptions, type IviRuntimeUserTextToResponseResult, type IviSourcePlaybackLivekit, type IviSourcePlaybackLivekitDescriptor, type IviStageSlotBinding, type IviStageViewContextValue, type IviSubtitleItem, type IviSubtitleRole, type IviUseSubtitlesOptions, LivekitSourceManager, TrtcSourceManager, isLivekitSourcePlayback, isReadyLivekitRuntimeSource, isSameLivekitConfig, useIviStageView, useIviSubtitles, useManagedIviRuntime, useRuntimeState };
+export { EMPTY_RUNTIME_STATE, IVILivekitPlayer, type IVILivekitPlayerProps, IVIStageView, type IVIStageViewProps, IVISubtitleOverlay, type IVISubtitleOverlayProps, type IVISubtitleOverlayStyle, IVITrackSlot, type IVITrackSlotProps, IVITrtcPlayer, type IVITrtcPlayerProps, type IviFrontendClientConfig, IviFrontendSdk, type IviManagedRuntimeConfig, type IviManagedRuntimeLogCallback, type IviManagedRuntimeLogEntry, type IviManagedRuntimeLogLevel, type IviManagedRuntimeLogSource, type IviRuntimeConversationItem, type IviRuntimeConversationLifecycle, type IviRuntimeConversationStatus, IviRuntimeCoordinator, type IviRuntimeCoordinatorConfig, IviRuntimeDispatcher, type IviRuntimeDispatcherConfig, type IviRuntimeEventListener, type IviRuntimeLogCallback, type IviRuntimeLogEntry, type IviRuntimeLogLevel, type IviRuntimeSource, type IviRuntimeSourcePreloadState, type IviRuntimeState, type IviRuntimeStatus, type IviRuntimeStream, type IviRuntimeTrtcAIDenoiserMode, type IviRuntimeTrtcAIDenoiserOptions, type IviRuntimeTrtcEvent, type IviRuntimeTrtcEventListener, type IviRuntimeTrtcEventType, type IviRuntimeUserTextToResponseCallbacks, type IviRuntimeUserTextToResponseOptions, type IviRuntimeUserTextToResponseResult, type IviSourcePlaybackLivekit, type IviSourcePlaybackLivekitDescriptor, type IviStageSlotBinding, type IviStageViewContextValue, type IviSubtitleItem, type IviSubtitleRole, type IviUseSubtitlesOptions, LivekitSourceManager, TrtcSourceManager, isLivekitSourcePlayback, isReadyLivekitRuntimeSource, isSameLivekitConfig, useIviStageView, useIviSubtitles, useManagedIviRuntime, useRuntimeState };

package/dist/index.d.ts

@@ -72,6 +72,21 @@ interface IviRuntimeTrtcEvent {
     streamType?: unknown;
 }
 type IviRuntimeTrtcEventListener = (event: IviRuntimeTrtcEvent) => void;
+type IviRuntimeTrtcAIDenoiserMode = "normal" | "far_field_reduction";
+interface IviRuntimeTrtcAIDenoiserOptions {
+    /**
+     * 是否启用 TRTC AIDenoiser 插件，默认 true。
+     */
+    enabled?: boolean;
+    /**
+     * 降噪模式，默认 "normal"。
+     */
+    mode?: IviRuntimeTrtcAIDenoiserMode;
+    /**
+     * TRTC AIDenoiser 资源路径；未配置时使用 TRTC SDK 默认加载逻辑。
+     */
+    assetsPath?: string;
+}
 type IviRuntimeConversationLifecycle = "added" | "done";
 type IviRuntimeConversationStatus = "in_progress" | "completed" | "incomplete";
 interface IviRuntimeConversationItem {
@@ -103,6 +118,10 @@ interface IviRuntimeCoordinatorConfig {
      * TRTC SDK 原始事件回调；可用于业务监听远端音视频可用性等底层事件。
      */
     onTrtcEvent?: IviRuntimeTrtcEventListener;
+    /**
+     * TRTC SDK AIDenoiser 降噪配置。默认开启；传 false 可关闭。
+     */
+    trtcAIDenoiser?: boolean | IviRuntimeTrtcAIDenoiserOptions;
 }
 /**
  * 用户输入触发回复链路配置。
@@ -177,9 +196,10 @@ type TrtcSourceListener = (snapshot: TrtcSourceSnapshot) => void;
 declare class TrtcSourceManager {
     private readonly onLog?;
     private readonly onTrtcEvent?;
+    private readonly aiDenoiser?;
     private readonly sessions;
     private readonly listeners;
-    constructor(onLog?: IviRuntimeLogCallback | undefined, onTrtcEvent?: IviRuntimeTrtcEventListener | undefined);
+    constructor(onLog?: IviRuntimeLogCallback | undefined, onTrtcEvent?: IviRuntimeTrtcEventListener | undefined, aiDenoiser?: (boolean | IviRuntimeTrtcAIDenoiserOptions) | undefined);
     /**
      * 将 runtime 当前 sources 与 TRTC 会话池对齐：
      * - 对 ready + trtc 的 source 进行 upsert（必要时建立连接）
@@ -190,7 +210,7 @@ declare class TrtcSourceManager {
      * 按 sourceId 注册/更新 TRTC 配置。
      * 若配置发生变化，会先销毁旧会话再按新参数重建连接。
      */
-    upsertSource(sourceId: string, trtc: IviSourcePlaybackTrtc): void;
+    upsertSource(sourceId: string, trtc: IviSourcePlaybackTrtc, aiDenoiser?: boolean | IviRuntimeTrtcAIDenoiserOptions): void;
     /**
      * 删除指定 source 的 TRTC 会话并释放连接资源。
      * 该操作通常由 source.deleted 或会话重置触发。
@@ -232,6 +252,7 @@ declare class TrtcSourceManager {
      * - 至少一个 view 需出声 -> 对可用远端用户解除静音
      */
     private applyAudioPolicy;
+    private applyAIDenoiserPolicy;
     /**
      * 销毁单个 source 会话：
      * 解绑事件、停止远端视频、退出房间并销毁客户端。
@@ -546,6 +567,11 @@ interface IVITrtcPlayerProps {
     loadingFallback?: ReactNode;
     errorFallback?: ReactNode;
     muted?: boolean;
+    /**
+     * 独立使用 IVITrtcPlayer（未传 runtime）时的 TRTC AIDenoiser 降噪配置。
+     * 默认开启；传 false 可关闭。
+     */
+    trtcAIDenoiser?: boolean | IviRuntimeTrtcAIDenoiserOptions;
 }
 /**
  * 默认 TRTC 播放器：挂载即加入房间并拉流，连接由 TrtcSourceManager 统一复用。
@@ -724,4 +750,4 @@ declare function useManagedIviRuntime(config: IviManagedRuntimeConfig): IviRunti
 
 declare function useIviStageView(): IviStageViewContextValue;
 
-export { EMPTY_RUNTIME_STATE, IVILivekitPlayer, type IVILivekitPlayerProps, IVIStageView, type IVIStageViewProps, IVISubtitleOverlay, type IVISubtitleOverlayProps, type IVISubtitleOverlayStyle, IVITrackSlot, type IVITrackSlotProps, IVITrtcPlayer, type IVITrtcPlayerProps, type IviFrontendClientConfig, IviFrontendSdk, type IviManagedRuntimeConfig, type IviManagedRuntimeLogCallback, type IviManagedRuntimeLogEntry, type IviManagedRuntimeLogLevel, type IviManagedRuntimeLogSource, type IviRuntimeConversationItem, type IviRuntimeConversationLifecycle, type IviRuntimeConversationStatus, IviRuntimeCoordinator, type IviRuntimeCoordinatorConfig, IviRuntimeDispatcher, type IviRuntimeDispatcherConfig, type IviRuntimeEventListener, type IviRuntimeLogCallback, type IviRuntimeLogEntry, type IviRuntimeLogLevel, type IviRuntimeSource, type IviRuntimeSourcePreloadState, type IviRuntimeState, type IviRuntimeStatus, type IviRuntimeStream, type IviRuntimeTrtcEvent, type IviRuntimeTrtcEventListener, type IviRuntimeTrtcEventType, type IviRuntimeUserTextToResponseCallbacks, type IviRuntimeUserTextToResponseOptions, type IviRuntimeUserTextToResponseResult, type IviSourcePlaybackLivekit, type IviSourcePlaybackLivekitDescriptor, type IviStageSlotBinding, type IviStageViewContextValue, type IviSubtitleItem, type IviSubtitleRole, type IviUseSubtitlesOptions, LivekitSourceManager, TrtcSourceManager, isLivekitSourcePlayback, isReadyLivekitRuntimeSource, isSameLivekitConfig, useIviStageView, useIviSubtitles, useManagedIviRuntime, useRuntimeState };
+export { EMPTY_RUNTIME_STATE, IVILivekitPlayer, type IVILivekitPlayerProps, IVIStageView, type IVIStageViewProps, IVISubtitleOverlay, type IVISubtitleOverlayProps, type IVISubtitleOverlayStyle, IVITrackSlot, type IVITrackSlotProps, IVITrtcPlayer, type IVITrtcPlayerProps, type IviFrontendClientConfig, IviFrontendSdk, type IviManagedRuntimeConfig, type IviManagedRuntimeLogCallback, type IviManagedRuntimeLogEntry, type IviManagedRuntimeLogLevel, type IviManagedRuntimeLogSource, type IviRuntimeConversationItem, type IviRuntimeConversationLifecycle, type IviRuntimeConversationStatus, IviRuntimeCoordinator, type IviRuntimeCoordinatorConfig, IviRuntimeDispatcher, type IviRuntimeDispatcherConfig, type IviRuntimeEventListener, type IviRuntimeLogCallback, type IviRuntimeLogEntry, type IviRuntimeLogLevel, type IviRuntimeSource, type IviRuntimeSourcePreloadState, type IviRuntimeState, type IviRuntimeStatus, type IviRuntimeStream, type IviRuntimeTrtcAIDenoiserMode, type IviRuntimeTrtcAIDenoiserOptions, type IviRuntimeTrtcEvent, type IviRuntimeTrtcEventListener, type IviRuntimeTrtcEventType, type IviRuntimeUserTextToResponseCallbacks, type IviRuntimeUserTextToResponseOptions, type IviRuntimeUserTextToResponseResult, type IviSourcePlaybackLivekit, type IviSourcePlaybackLivekitDescriptor, type IviStageSlotBinding, type IviStageViewContextValue, type IviSubtitleItem, type IviSubtitleRole, type IviUseSubtitlesOptions, LivekitSourceManager, TrtcSourceManager, isLivekitSourcePlayback, isReadyLivekitRuntimeSource, isSameLivekitConfig, useIviStageView, useIviSubtitles, useManagedIviRuntime, useRuntimeState };

package/dist/index.js

@@ -1105,10 +1105,15 @@ var ConversationManager = class {
 
 // src/runtime/managers/trtc-source-manager.ts
 var TAG = "[IVI-TRTC]";
+var DEFAULT_DENOISER_OPTIONS = {
+  enabled: true,
+  mode: "normal"
+};
 var TrtcSourceManager = class {
-  constructor(onLog, onTrtcEvent) {
+  constructor(onLog, onTrtcEvent, aiDenoiser) {
     this.onLog = onLog;
     this.onTrtcEvent = onTrtcEvent;
+    this.aiDenoiser = aiDenoiser;
     this.sessions = /* @__PURE__ */ new Map();
     this.listeners = /* @__PURE__ */ new Map();
   }
@@ -1135,21 +1140,21 @@ var TrtcSourceManager = class {
    * 按 sourceId 注册/更新 TRTC 配置。
    * 若配置发生变化，会先销毁旧会话再按新参数重建连接。
    */
-  upsertSource(sourceId, trtc) {
+  upsertSource(sourceId, trtc, aiDenoiser) {
     const existing = this.sessions.get(sourceId);
     if (!existing) {
       this.log("info", `\u65B0\u5EFA\u4F1A\u8BDD source=${sourceId} room=${getTrtcString(trtc, "room_id")} user=${getTrtcString(trtc, "user_id")}`);
-      const session2 = this.createSession(sourceId, trtc);
+      const session2 = this.createSession(sourceId, trtc, aiDenoiser);
       this.sessions.set(sourceId, session2);
       void this.ensureConnected(session2);
       return;
     }
-    if (isSameTrtcConfig(existing.trtc, trtc)) {
+    if (isSameTrtcConfig(existing.trtc, trtc) && isSameAIDenoiserOptions(existing.aiDenoiser, aiDenoiser)) {
       return;
     }
     this.log("info", `\u914D\u7F6E\u53D8\u66F4\uFF0C\u91CD\u5EFA\u4F1A\u8BDD source=${sourceId} room=${getTrtcString(trtc, "room_id")}`);
     void this.disposeSession(existing);
-    const session = this.createSession(sourceId, trtc);
+    const session = this.createSession(sourceId, trtc, aiDenoiser);
     this.sessions.set(sourceId, session);
     void this.ensureConnected(session);
   }
@@ -1286,10 +1291,11 @@ var TrtcSourceManager = class {
     binding.muted = muted;
     void this.applyAudioPolicy(session);
   }
-  createSession(sourceId, trtc) {
+  createSession(sourceId, trtc, aiDenoiser) {
     return {
       sourceId,
       trtc,
+      aiDenoiser,
       TRTC: null,
       client: null,
       connectPromise: null,
@@ -1395,6 +1401,7 @@ var TrtcSourceManager = class {
       session.status = "connected";
       session.error = void 0;
       this.log("info", `\u8FDB\u623F\u6210\u529F source=${session.sourceId} room=${roomId}`);
+      await this.applyAIDenoiserPolicy(session, client, sdkAppId, userId, userSig);
       this.emitSnapshot(session.sourceId, {
         status: session.status
       });
@@ -1480,6 +1487,25 @@ var TrtcSourceManager = class {
       await client.muteRemoteAudio(userId, false);
     }
   }
+  async applyAIDenoiserPolicy(session, client, sdkAppId, userId, userSig) {
+    const options = resolveAIDenoiserOptions(session.aiDenoiser ?? this.aiDenoiser);
+    if (!options.enabled) {
+      this.log("info", `TRTC AIDenoiser \u5DF2\u5173\u95ED source=${session.sourceId}`);
+      return;
+    }
+    try {
+      await client.startPlugin("AIDenoiser", {
+        sdkAppId,
+        userId,
+        userSig,
+        mode: getAIDenoiserModeValue(options.mode),
+        ...options.assetsPath ? { assetsPath: options.assetsPath } : {}
+      });
+      this.log("info", `TRTC AIDenoiser \u5DF2\u5F00\u542F source=${session.sourceId} mode=${options.mode}`);
+    } catch (error) {
+      this.log("warn", `TRTC AIDenoiser \u5F00\u542F\u5931\u8D25 source=${session.sourceId}`, error);
+    }
+  }
   /**
    * 销毁单个 source 会话：
    * 解绑事件、停止远端视频、退出房间并销毁客户端。
@@ -1561,6 +1587,11 @@ function isRuntimeTrtcSource(source) {
 function isSameTrtcConfig(a, b) {
   return a.app_id === b.app_id && a.user_id === b.user_id && a.user_sig === b.user_sig && a.room_id === b.room_id;
 }
+function isSameAIDenoiserOptions(a, b) {
+  const left = resolveAIDenoiserOptions(a);
+  const right = resolveAIDenoiserOptions(b);
+  return left.enabled === right.enabled && left.mode === right.mode && left.assetsPath === right.assetsPath;
+}
 function shouldUseStringRoomId(roomId) {
   if (!/^\d+$/.test(roomId)) {
     return true;
@@ -1572,6 +1603,26 @@ function getTrtcString(trtc, key) {
   const value = trtc[key];
   return typeof value === "string" ? value : "";
 }
+function resolveAIDenoiserOptions(options) {
+  if (options === false) {
+    return {
+      ...DEFAULT_DENOISER_OPTIONS,
+      enabled: false
+    };
+  }
+  if (options === true || options === void 0) {
+    return DEFAULT_DENOISER_OPTIONS;
+  }
+  return {
+    ...DEFAULT_DENOISER_OPTIONS,
+    ...options,
+    enabled: options.enabled ?? DEFAULT_DENOISER_OPTIONS.enabled,
+    mode: options.mode ?? DEFAULT_DENOISER_OPTIONS.mode
+  };
+}
+function getAIDenoiserModeValue(mode) {
+  return mode === "far_field_reduction" ? 1 : 0;
+}
 function buildRemoteVideoKey(userId, streamType) {
   return `${userId}::${streamType}`;
 }
@@ -2074,7 +2125,8 @@ var IviRuntimeCoordinator = class {
     };
     this.trtcSourceManager = new TrtcSourceManager(
       this.config.onLog,
-      (event) => this.emitTrtcEvent(event)
+      (event) => this.emitTrtcEvent(event),
+      this.config.trtcAIDenoiser
     );
     this.livekitSourceManager = new LivekitSourceManager(this.config.onLog);
     this.sessionHandler = new SessionEventHandler(this.sessionManager, {
@@ -3154,7 +3206,8 @@ function IVITrtcPlayer(props) {
     style,
     loadingFallback = null,
     errorFallback = null,
-    muted = false
+    muted = false,
+    trtcAIDenoiser
   } = props;
   const containerRef = useRef(null);
   const viewIdRef = useRef(`trtc-view-${Math.random().toString(36).slice(2, 10)}`);
@@ -3175,7 +3228,7 @@ function IVITrtcPlayer(props) {
     }
     let disposed = false;
     if (shouldManageSourceLifecycle) {
-      manager.upsertSource(resolvedSourceId, trtc);
+      manager.upsertSource(resolvedSourceId, trtc, trtcAIDenoiser);
     }
     const unsubscribe = manager.subscribe(resolvedSourceId, (snapshot) => {
       if (disposed) {
@@ -3206,7 +3259,8 @@ function IVITrtcPlayer(props) {
     trtc.app_id,
     trtc.room_id,
     trtc.user_id,
-    trtc.user_sig
+    trtc.user_sig,
+    trtcAIDenoiser
   ]);
   useEffect(() => {
     manager.updateViewMuted(resolvedSourceId, viewIdRef.current, muted);