@zeewain/3d-avatar-sdk 1.2.0 → 1.2.2

package/dist/examples/test-vue3/src/components/UnityPreview.vue

@@ -0,0 +1,189 @@
+<template>
+  <el-card class="unity-preview" shadow="hover">
+    <template #header>
+      <div class="card-header">
+        <span>Unity 预览</span>
+        <el-tag v-if="sdkStatus.unityLoaded" type="success" size="default">已加载</el-tag>
+        <el-tag v-else type="info" size="default">未加载</el-tag>
+      </div>
+    </template>
+
+    <div class="unity-container-wrapper" v-loading="sdkStatus.unityLoaded && !sdkStatus.avatarLoaded && loadingProgress === 1" element-loading-text="数字人加载中，请稍候..." element-loading-background="rgba(0, 0, 0, 0)">
+      <div id="unity-container" class="unity-container">
+        <div v-if="!sdkStatus.unityLoaded" class="unity-tip">
+          <i class="el-icon-monitor"></i>
+          <p>Unity 内容将在此处加载...</p>
+        </div>
+      </div>
+    </div>
+
+    <div class="unity-controls">
+      <el-button-group>
+        <el-button
+          type="warning"
+          size="default"
+          icon="close"
+          :disabled="!sdkStatus.avatarLoaded"
+          @click="handleUnloadAvatar" 
+        >
+          卸载Avatar
+        </el-button>
+        <el-button
+          type="danger"
+          size="default"
+          icon="delete"
+          :disabled="!sdkStatus.unityLoaded"
+          @click="handleDestroySDK"
+        >
+          销毁实例
+        </el-button>
+      </el-button-group>
+    </div>
+
+    <!-- 加载进度显示 -->
+    <div v-if="loadingProgress > 0 && loadingProgress < 1" class="loading-progress">
+      <el-progress
+        :percentage="Math.round(loadingProgress * 100)"
+        :stroke-width="6"
+        text-inside
+      />
+      <p class="progress-text">Unity 加载中，请稍候...</p>
+    </div>
+  </el-card>
+</template>
+
+<script setup lang="ts">
+import { defineProps, defineEmits } from 'vue';
+
+interface ISDKStatus {
+  unityLoaded: boolean;
+  avatarLoaded: boolean;
+}
+
+const props = defineProps<{
+  sdkStatus: ISDKStatus;
+  loadingProgress: number;
+}>();
+
+const emit = defineEmits<{
+  (e: 'unload-avatar'): void;
+  (e: 'destroy-sdk'): void;
+}>();
+
+function handleUnloadAvatar() {
+  emit('unload-avatar');
+}
+
+function handleDestroySDK() {
+  emit('destroy-sdk');
+}
+</script>
+
+<style lang="scss" scoped>
+// Unity预览
+.unity-preview {
+  position: relative;
+  display: flex;
+  width: 100%;
+  height: 100%;
+  overflow: hidden;
+  flex-direction: column;
+  .card-header {
+    display: flex;
+    justify-content: space-between;
+    align-items: center;
+    font-weight: 600;
+  }
+  :deep(.el-card__body) {
+    display: flex;
+    width: 100%;
+    height: 100%;
+    flex-direction: column;
+    box-sizing: border-box;
+  }
+  .unity-container-wrapper {
+    position: relative;
+    width: 100%;
+    max-height: 600px; // 添加最大高度限制
+    margin-bottom: 15px;
+    overflow: hidden; // 防止内容溢出
+    flex: 1;
+  }
+  .unity-container {
+    position: relative;
+    width: 100%;
+    height: 100%;
+    max-height: 100%; // 确保不超过父容器
+    overflow: hidden;
+    background-color: #000;
+    border-radius: 4px;
+  }
+  .unity-tip {
+    position: absolute;
+    top: 50%;
+    left: 50%;
+    color: white; // 确保在黑色背景上文字可见
+    text-align: center;
+    transform: translate(-50%, -50%);
+    i {
+      margin-bottom: 10px;
+      font-size: 48px;
+    }
+    p {
+      margin: 0;
+      font-size: 14px;
+    }
+  }
+  .unity-controls {
+    display: flex;
+    justify-content: center;
+    padding-top: 10px;
+  }
+  .loading-progress {
+    position: absolute;
+    top: 50%;
+    left: 50%;
+    width: 80%;
+    transform: translate(-50%, -50%);
+    text-align: center;
+    z-index: 10;
+    .progress-text {
+      color: white;
+      margin-top: 10px;
+      font-size: 14px;
+    }
+  }
+}
+
+// 移动端优化
+@media screen and (width <= 768px) {
+  .unity-preview {
+    .unity-container-wrapper {
+      height: 250px;
+      max-height: 250px; // 确保移动端不会超过设定高度
+      flex: none;
+      overflow: hidden; // 防止内容溢出
+    }
+    .unity-controls {
+      .el-button-group {
+        display: flex;
+        flex-direction: column;
+        .el-button {
+          margin: 2px 0;
+        }
+      }
+    }
+  }
+}
+
+// 平板端优化
+@media screen and (width <= 992px) and (width > 768px) {
+  .unity-preview {
+    .unity-container-wrapper {
+      height: 300px; // 平板端适中高度
+      max-height: 300px; // 确保平板端不会超过设定高度
+      overflow: hidden; // 防止内容溢出
+    }
+  }
+}
+</style>

package/dist/examples/test-vue3/src/main.ts

@@ -0,0 +1,12 @@
+import { createApp } from 'vue'
+import App from './App.vue'
+
+// Element Plus 样式
+import 'element-plus/dist/index.css'
+
+// 创建Vue应用实例
+const app = createApp(App)
+
+// 挂载应用
+app.mount('#app')
+ 

package/dist/examples/test-vue3/src/types.ts

@@ -0,0 +1,9 @@
+export interface IGlobalConfig {
+  token: string;
+  avatarCode: string;
+  env: 'dev' | 'test' | 'prod' | 'custom';
+  webglPath?:string;
+  apiBaseUrl?:string;
+  resourcesUrl?:string;
+  idleMotionListString?:string;
+}

package/dist/examples/test-vue3/tsconfig.json

@@ -0,0 +1,44 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "useDefineForClassFields": true,
+    "module": "ESNext",
+    "moduleResolution": "Node",
+    "strict": true,
+    "jsx": "preserve",
+    "sourceMap": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "lib": [
+      "ESNext",
+      "DOM"
+    ],
+    "skipLibCheck": true,
+    "baseUrl": "./",
+    "paths": {
+      "@/*": [
+        "src/*"
+      ],
+      "#/*": [
+        "typings/*"
+      ]
+    },
+    "types": [
+      "vite/client", // https://cn.vitejs.dev/guide/features.html#typescript-compiler-options
+      "element-plus/global",
+    ]
+  },
+  "include": [
+    "src/**/*.ts",
+    "src/**/*.d.ts",
+    "src/**/*.tsx",
+    "src/**/*.vue",
+    "typings/**/*.d.ts"
+  ],
+  "references": [
+    {
+      "path": "./tsconfig.node.json"
+    }
+  ]
+}

package/dist/examples/test-vue3/tsconfig.node.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "composite": true,
+    "module": "ESNext",
+    "moduleResolution": "Node",
+    "esModuleInterop": true,
+    "resolveJsonModule": true
+  },
+  "include": [
+    "package.json",
+    "vite.config.ts",
+    "vite/**/*.ts"
+  ]
+}

package/dist/examples/test-vue3/vite.config.ts

@@ -0,0 +1,75 @@
+import { resolve } from 'path';
+import { URL, fileURLToPath } from 'node:url';
+import { defineConfig, loadEnv } from 'vite';
+import vue from '@vitejs/plugin-vue';
+import AutoImport from 'unplugin-auto-import/vite';
+import Components from 'unplugin-vue-components/vite';
+import { ElementPlusResolver } from 'unplugin-vue-components/resolvers';
+
+// https://vitejs.dev/config/
+export default defineConfig(({ mode, command }) =>
+{
+  // 加载环境变量
+  const env = loadEnv(mode, process.cwd(), '');
+
+  // 检查是否使用本地SDK开发模式
+  const useLocalSDK = env.VITE_USE_LOCAL_SDK === 'true';
+  const localSDKPath = resolve(fileURLToPath(new URL('.', import.meta.url)), '../../dist/index.esm.js');
+
+  console.log('🔧 Vite 配置信息:');
+  console.log(`   - 运行模式: ${mode}`);
+  console.log(`   - 使用本地 SDK: ${useLocalSDK ? '✅ 是' : '❌ 否'}`);
+  if (useLocalSDK)
+  {
+    console.log(`   - 本地 SDK 路径: ${localSDKPath}`);
+    console.log('   - 运行模式: 开发模式');
+  }
+  else
+  {
+    console.log('   - 运行模式: npm包模式');
+  }
+
+  return {
+    base: env.VITE_PUBLIC_PATH || './',
+    plugins: [
+      vue(),
+      AutoImport({
+        resolvers: [ElementPlusResolver()],
+        imports: [
+          'vue',
+          '@vueuse/core'
+        ],
+          dts: true
+      }),
+      Components({
+        resolvers: [ElementPlusResolver()],
+          dts: true
+        })
+    ],
+    resolve: {
+      alias: {
+          '@': fileURLToPath(new URL('./src', import.meta.url)),
+          // 如果启用本地开发模式，将 SDK 指向本地构建版本
+          ...(useLocalSDK && {
+            '@zeewain/3d-avatar-sdk': localSDKPath
+          })
+        }
+    },
+    server: {
+      open: true,
+      port: 20054,
+      proxy: {
+        '/proxy': {
+          target: env.VITE_APP_API_BASEURL,
+          changeOrigin: command === 'serve' && env.VITE_OPEN_PROXY === 'true',
+          rewrite: path => path.replace(/\/proxy/, '')
+        }
+      }
+
+    },
+    build: {
+      outDir: mode === 'production' ? 'dist' : `dist-${mode}`,
+      sourcemap: false,
+    }
+  }
+});

package/dist/index.d.ts

@@ -27,40 +27,6 @@ interface IUnityInstance {
     SetFullscreen?(fullscreen: boolean): void;
 }
 
-/**
- * @fileoverview SDK配置接口定义
- * @description 定义SDK实例初始化所需的配置参数
- */
-/**
- * SDK配置接口
- * @interface IAvatarSDKConfig
- * @description 定义SDK实例初始化所需的配置参数
- */
-interface IAvatarSDKConfig {
-    /** 全局用户认证令牌 */
-    token?: string;
-    /** 运行环境 */
-    env?: 'dev' | 'test' | 'prod' | 'custom';
-    /** api接口地址，仅当env为custom时有效 */
-    apiUrl?: string;
-    /** AB资源文件地址 */
-    resourcesUrl?: string;
-    /** Unity加载器脚本URL */
-    loaderUrl: string;
-    /** Unity数据文件URL */
-    dataUrl: string;
-    /** Unity框架文件URL */
-    frameworkUrl: string;
-    /** Unity代码文件URL */
-    codeUrl: string;
-    /** 容器DOM元素ID，可选，默认为'unity-container' */
-    containerId?: string;
-    /** 待机动作编码列表，随机播放（排重方式）可选 */
-    idleMotionList?: string[];
-    /** 3D渲染引擎加载进度回调函数，可选 */
-    onProgress?: (progress: number) => void;
-}
-
 /**
  * @fileoverview Unity服务基础类型定义
  * @description 定义Unity服务的通用接口和类型，为所有Unity服务提供统一的基础类型
@@ -175,94 +141,6 @@ interface IUnityLogger {
     error(message: string, error?: Error, data?: any): void;
 }
 
-/**
- * @fileoverview Avatar API接口定义
- * @description 定义数字人控制API的核心接口、类型和枚举
- */
-
-/**
- * Avatar操作类型枚举
- * @enum {string}
- * @description 定义Avatar服务支持的操作类型
- */
-declare enum AvatarOperationType {
-    INITIALIZE_AVATAR = "initializeAvatar",
-    PLAY_MOTION = "playMotion",
-    GET_CURRENT_MOTION = "getCurrentMotion",
-    UNLOAD_AVATAR = "unloadAvatar",
-    SET_CAMERA = "setCamera"
-}
-/**
- * Avatar摄像机类型枚举
- * @enum {string}
- * @description 定义Avatar支持的摄像机类型
- */
-declare enum AvatarCameraType {
-    WHOLE = "whole",
-    HALF = "half",
-    FACE = "face"
-}
-/**
- * Avatar回调响应接口
- * @interface IAvatarCallbackResponse
- * @extends {IUnityCallbackResponse}
- * @description 定义Avatar操作的回调响应格式，扩展基础响应接口
- */
-interface IAvatarCallbackResponse extends IUnityCallbackResponse {
-    data?: {
-        /** 动作ID，可选 */
-        motionId?: string;
-        /** 动作剩余时间，可选 */
-        motionRemainingTime?: number;
-    };
-}
-/**
- * Avatar API接口
- * @interface IAvatarAPI
- * @description 定义数字人控制API的核心接口，包含数字人初始化、动作控制、摄像机设置等功能
- */
-interface IAvatarAPI {
-    /**
-     * 初始化数字人
-     * @param avatarCode - 数字人编码
-     * @param cameraType - 摄像机类型，默认为'whole'
-     * @returns Promise<IAvatarCallbackResponse> 初始化操作的Promise
-     */
-    initializeAvatar(avatarCode: string, cameraType?: AvatarCameraType): Promise<IAvatarCallbackResponse>;
-    /**
-     * 播放数字人动作
-     * @param clipCode - 动作编码
-     * @returns Promise<IAvatarCallbackResponse> 播放操作的Promise
-     */
-    playMotion(clipCode: string): Promise<IAvatarCallbackResponse>;
-    /**
-     * 获取当前播放的动作信息
-     * @param getRemainingTime - 是否获取剩余时间
-     * @returns Promise<IAvatarCallbackResponse> 获取操作的Promise
-     */
-    getCurrentMotion(getRemainingTime: boolean): Promise<IAvatarCallbackResponse>;
-    /**
-     * 卸载数字人
-     * @returns Promise<IAvatarCallbackResponse> 卸载操作的Promise
-     */
-    unloadAvatar(): Promise<IAvatarCallbackResponse>;
-    /**
-     * 设置摄像机类型
-     * @param cameraType - 摄像机类型
-     * @returns Promise<IAvatarCallbackResponse> 设置操作的Promise
-     */
-    setCamera(cameraType: AvatarCameraType): Promise<IAvatarCallbackResponse>;
-    /**
-     * 批量执行Avatar操作
-     * @param operations - 操作数组
-     * @returns Promise<IAvatarCallbackResponse[]> 返回所有操作的结果
-     */
-    batchExecute(operations: Array<{
-        method: keyof IAvatarAPI;
-        params: any[];
-    }>): Promise<IAvatarCallbackResponse[]>;
-}
-
 /**
  * @fileoverview 流式播报服务接口定义
  * @description 定义流式播报服务相关的类型、接口和枚举
@@ -436,6 +314,133 @@ interface IBroadcastAPI {
     destroy(): void;
 }
 
+/**
+ * @fileoverview SDK配置接口定义
+ * @description 定义SDK实例初始化所需的配置参数
+ */
+
+/**
+ * SDK配置接口
+ * @interface IAvatarSDKConfig
+ * @description 定义SDK实例初始化所需的配置参数
+ */
+interface IAvatarSDKConfig {
+    /** 全局用户认证令牌 */
+    token?: string;
+    /** 运行环境 */
+    env?: 'dev' | 'test' | 'prod' | 'custom';
+    /** api接口地址，仅当env为custom时有效 */
+    apiUrl?: string;
+    /** 资源文件地址，仅当env为custom时有效 */
+    assetsUrl?: string;
+    /** AB资源文件地址 */
+    resourcesUrl?: string;
+    /** Unity加载器脚本URL */
+    loaderUrl: string;
+    /** Unity数据文件URL */
+    dataUrl: string;
+    /** Unity框架文件URL */
+    frameworkUrl: string;
+    /** Unity代码文件URL */
+    codeUrl: string;
+    /** 容器DOM元素ID，可选，默认为'unity-container' */
+    containerId?: string;
+    /** 待机动作编码列表，随机播放（排重方式）可选 */
+    idleMotionList?: string[];
+    /** 3D渲染引擎加载进度回调函数，可选 */
+    onProgress?: (progress: number) => void;
+    /** 播报回调函数，可选 */
+    broadcastCallbacks?: IBroadcastCallbacks;
+}
+
+/**
+ * @fileoverview Avatar API接口定义
+ * @description 定义数字人控制API的核心接口、类型和枚举
+ */
+
+/**
+ * Avatar操作类型枚举
+ * @enum {string}
+ * @description 定义Avatar服务支持的操作类型
+ */
+declare enum AvatarOperationType {
+    INITIALIZE_AVATAR = "initializeAvatar",
+    PLAY_MOTION = "playMotion",
+    GET_CURRENT_MOTION = "getCurrentMotion",
+    UNLOAD_AVATAR = "unloadAvatar",
+    SET_CAMERA = "setCamera"
+}
+/**
+ * Avatar摄像机类型枚举
+ * @enum {string}
+ * @description 定义Avatar支持的摄像机类型
+ */
+declare enum AvatarCameraType {
+    WHOLE = "whole",
+    HALF = "half",
+    FACE = "face"
+}
+/**
+ * Avatar回调响应接口
+ * @interface IAvatarCallbackResponse
+ * @extends {IUnityCallbackResponse}
+ * @description 定义Avatar操作的回调响应格式，扩展基础响应接口
+ */
+interface IAvatarCallbackResponse extends IUnityCallbackResponse {
+    data?: {
+        /** 动作ID，可选 */
+        motionId?: string;
+        /** 动作剩余时间，可选 */
+        motionRemainingTime?: number;
+    };
+}
+/**
+ * Avatar API接口
+ * @interface IAvatarAPI
+ * @description 定义数字人控制API的核心接口，包含数字人初始化、动作控制、摄像机设置等功能
+ */
+interface IAvatarAPI {
+    /**
+     * 初始化数字人
+     * @param avatarCode - 数字人编码
+     * @param cameraType - 摄像机类型，默认为'whole'
+     * @returns Promise<IAvatarCallbackResponse> 初始化操作的Promise
+     */
+    initializeAvatar(avatarCode: string, cameraType?: AvatarCameraType): Promise<IAvatarCallbackResponse>;
+    /**
+     * 播放数字人动作
+     * @param clipCode - 动作编码
+     * @returns Promise<IAvatarCallbackResponse> 播放操作的Promise
+     */
+    playMotion(clipCode: string): Promise<IAvatarCallbackResponse>;
+    /**
+     * 获取当前播放的动作信息
+     * @param getRemainingTime - 是否获取剩余时间
+     * @returns Promise<IAvatarCallbackResponse> 获取操作的Promise
+     */
+    getCurrentMotion(getRemainingTime: boolean): Promise<IAvatarCallbackResponse>;
+    /**
+     * 卸载数字人
+     * @returns Promise<IAvatarCallbackResponse> 卸载操作的Promise
+     */
+    unloadAvatar(): Promise<IAvatarCallbackResponse>;
+    /**
+     * 设置摄像机类型
+     * @param cameraType - 摄像机类型
+     * @returns Promise<IAvatarCallbackResponse> 设置操作的Promise
+     */
+    setCamera(cameraType: AvatarCameraType): Promise<IAvatarCallbackResponse>;
+    /**
+     * 批量执行Avatar操作
+     * @param operations - 操作数组
+     * @returns Promise<IAvatarCallbackResponse[]> 返回所有操作的结果
+     */
+    batchExecute(operations: Array<{
+        method: keyof IAvatarAPI;
+        params: any[];
+    }>): Promise<IAvatarCallbackResponse[]>;
+}
+
 /**
  * @fileoverview 统一的3D数字人SDK入口类
  * @description 提供统一的SDK接口，内部通过组合模式调用各个服务模块
@@ -716,7 +721,6 @@ declare class AvatarService extends UnityBaseService<AvatarOperationType> implem
     protected get callbackFunctionName(): string;
     /**
      * 构造函数
-     * @param unityInstance - Unity实例对象
      * @param config - 可选的服务配置，用于覆盖默认配置
      * @description 初始化Avatar API，设置Unity实例和配置
      * @example
@@ -952,13 +956,6 @@ declare class BroadcastService extends UnityBaseService<BroadcastOperationType>
     destroy(): void;
     /** 全局回调函数名称 */
     protected get callbackFunctionName(): string;
-    /**
-     * 获取API基础URL
-     * @returns string 返回当前环境的API基础URL
-     * @description 根据当前环境配置获取API基础URL
-     * @private
-     */
-    private getApiBaseUrl;
     /**
      * 获取播报API路径
      * @param type - 播报类型
@@ -983,6 +980,13 @@ declare class BroadcastService extends UnityBaseService<BroadcastOperationType>
      * @private
      */
     private handleError;
+    /**
+     * 处理播报错误
+     * @param errorCode - 错误码
+     * @description 处理播报过程中的错误
+     * @private
+     */
+    private handleBroadcastError;
 }
 
 /**
@@ -1016,7 +1020,7 @@ declare enum NetworkErrorCode {
     CONNECTION_FAILED = 1001,
     /** 请求超时 */
     REQUEST_TIMEOUT = 1002,
-    /** 服务器错误 */
+    /** 服务错误 */
     SERVER_ERROR = 1003,
     /** 未授权访问 */
     UNAUTHORIZED = 1004
@@ -1036,7 +1040,13 @@ declare enum OperationErrorCode {
     /** 操作超时 */
     OPERATION_TIMEOUT = 2004,
     /** 操作被取消 */
-    OPERATION_CANCELLED = 2005
+    OPERATION_CANCELLED = 2005,
+    /** 用户权益额度不存在 */
+    BROADCAST_EQUITY_NOT_EXIST = 2006,
+    /** 用户权益额度不足 */
+    BROADCAST_EQUITY_NOT_ENOUGH = 2007,
+    /** 用户权益额度冻结失败 */
+    BROADCAST_EQUITY_FREEZE_FAILED = 2008
 }
 /**
  * 资源错误码 (3xxx)