@eva/plugin-sound 2.0.1-beta.3 → 2.0.1-beta.31

package/dist/plugin-sound.cjs.js

@@ -43,23 +43,52 @@ sound.utils.validateFormats({
     aac: 'audio/aac',
 });
 pixi_js.extensions.add(sound.soundAsset);
+/**
+ * 音频系统
+ *
+ * SoundSystem 负责管理游戏中所有音频组件的加载和播放。
+ * 支持自动与游戏生命周期同步（暂停/恢复），
+ * 提供全局音频控制功能（全部暂停/恢复/停止）。
+ *
+ * @example
+ * ```typescript
+ * const soundSystem = new SoundSystem({
+ *   autoPauseAndStart: true,
+ *   onError: (error) => console.error('Sound error:', error)
+ * });
+ *
+ * game.addSystem(soundSystem);
+ * ```
+ */
 let SoundSystem = class SoundSystem extends eva_js.System {
     constructor(obj) {
         super();
+        /** 是否与游戏生命周期同步暂停和启动 */
         this.autoPauseAndStart = true;
+        /** 管理的音频组件列表 */
         this.components = [];
+        /** 音频缓冲区缓存 */
         this.audioBufferCache = {};
         Object.assign(this, obj);
         if (obj === null || obj === void 0 ? void 0 : obj.useLegacy) {
             sound.sound.useLegacy = true;
         }
     }
+    /**
+     * 恢复播放所有被暂停的音频
+     */
     resumeAll() {
         sound.sound.resumeAll();
     }
+    /**
+     * 暂停所有正在播放的音频
+     */
     pauseAll() {
         sound.sound.pauseAll();
     }
+    /**
+     * 停止所有正在播放的音频
+     */
     stopAll() {
         sound.sound.stopAll();
     }
@@ -69,18 +98,32 @@ let SoundSystem = class SoundSystem extends eva_js.System {
             this.componentChanged(changed);
         }
     }
+    /**
+     * 游戏开始和游戏暂停后开始播放的时候调用。
+     *
+     * Called while the game to play when game pause.
+     */
     onResume() {
         if (!this.autoPauseAndStart) {
             return;
         }
         this.resumeAll();
     }
+    /**
+     * 游戏暂停的时候调用。
+     *
+     * Called while the game paused.
+     */
     onPause() {
         if (!this.autoPauseAndStart) {
             return;
         }
         this.pauseAll();
     }
+    /**
+     * System 被销毁的时候调用。
+     * Called while the system be destroyed.
+     */
     onDestroy() {
         this.components.forEach(component => {
             component.onDestroy();
@@ -121,6 +164,7 @@ let SoundSystem = class SoundSystem extends eva_js.System {
         });
     }
 };
+/** 系统名称 */
 SoundSystem.systemName = 'SoundSystem';
 SoundSystem = __decorate([
     eva_js.decorators.componentObserver({
@@ -129,10 +173,30 @@ SoundSystem = __decorate([
 ], SoundSystem);
 var SoundSystem$1 = SoundSystem;
 
+/**
+ * 音频组件
+ *
+ * Sound 组件用于在游戏对象上播放音频。
+ * 支持音频的播放、暂停、停止、音量控制、循环播放等功能。
+ * 基于 PixiJS Sound 库实现，提供了 Web Audio API 的完整功能。
+ *
+ * @example
+ * ```typescript
+ * const gameObject = new GameObject('bgm');
+ * gameObject.addComponent(new Sound({
+ *   resource: 'background-music',
+ *   autoplay: true,
+ *   loop: true,
+ *   volume: 0.5
+ * }));
+ * ```
+ */
 class Sound extends eva_js.Component {
     constructor() {
         super(...arguments);
+        /** 音频加载状态 */
         this.state = 'unloaded';
+        /** 音频配置参数 */
         this.config = {
             resource: '',
             autoplay: false,
@@ -142,12 +206,16 @@ class Sound extends eva_js.Component {
             seek: 0,
             speed: 1,
         };
+        /** 待执行的操作队列（用于资源加载前的操作缓存） */
         this.actionQueue = [];
+        /** 音频开始播放的时间 */
         this.startTime = 0;
     }
+    /** 获取音频系统上下文 */
     get systemContext() {
         return sound.sound.context.audioContext;
     }
+    /** 音频是否正在播放 */
     get playing() {
         if (!this.buffer)
             return false;
@@ -221,6 +289,7 @@ class Sound extends eva_js.Component {
         }
     }
 }
+/** 组件名称 */
 Sound.componentName = 'Sound';
 var Sound$1 = Sound;
 

package/dist/plugin-sound.d.ts

@@ -3,15 +3,42 @@ import { ComponentChanged } from '@eva/eva.js';
 import { Sound as Sound_2 } from '@pixi/sound';
 import { System } from '@eva/eva.js';
 
+/**
+ * 音频组件
+ *
+ * Sound 组件用于在游戏对象上播放音频。
+ * 支持音频的播放、暂停、停止、音量控制、循环播放等功能。
+ * 基于 PixiJS Sound 库实现，提供了 Web Audio API 的完整功能。
+ *
+ * @example
+ * ```typescript
+ * const gameObject = new GameObject('bgm');
+ * gameObject.addComponent(new Sound({
+ *   resource: 'background-music',
+ *   autoplay: true,
+ *   loop: true,
+ *   volume: 0.5
+ * }));
+ * ```
+ */
 export declare class Sound extends Component<SoundParams> {
+    /** 组件名称 */
     static componentName: string;
+    /** 获取音频系统上下文 */
     get systemContext(): AudioContext;
+    /** 音频系统目标节点 */
     systemDestination: GainNode;
+    /** 音频是否正在播放 */
     get playing(): boolean;
+    /** 音频加载状态 */
     state: 'unloaded' | 'loading' | 'loaded';
+    /** 音频配置参数 */
     config: SoundParams;
+    /** 待执行的操作队列（用于资源加载前的操作缓存） */
     private actionQueue;
+    /** 音频开始播放的时间 */
     startTime: number;
+    /** PixiJS Sound 缓冲区 */
     private buffer;
     get muted(): boolean;
     set muted(v: boolean);
@@ -38,19 +65,64 @@ declare interface SoundParams {
     onEnd?: () => void;
 }
 
+/**
+ * 音频系统
+ *
+ * SoundSystem 负责管理游戏中所有音频组件的加载和播放。
+ * 支持自动与游戏生命周期同步（暂停/恢复），
+ * 提供全局音频控制功能（全部暂停/恢复/停止）。
+ *
+ * @example
+ * ```typescript
+ * const soundSystem = new SoundSystem({
+ *   autoPauseAndStart: true,
+ *   onError: (error) => console.error('Sound error:', error)
+ * });
+ *
+ * game.addSystem(soundSystem);
+ * ```
+ */
 export declare class SoundSystem extends System {
+    /** 系统名称 */
     static systemName: string;
+    /** 是否与游戏生命周期同步暂停和启动 */
     private autoPauseAndStart;
+    /** 错误回调函数 */
     private onError;
+    /** 管理的音频组件列表 */
     private components;
+    /** 音频缓冲区缓存 */
     private audioBufferCache;
     constructor(obj?: SoundSystemParams);
+    /**
+     * 恢复播放所有被暂停的音频
+     */
     resumeAll(): void;
+    /**
+     * 暂停所有正在播放的音频
+     */
     pauseAll(): void;
+    /**
+     * 停止所有正在播放的音频
+     */
     stopAll(): void;
     update(): void;
+    /**
+     * 游戏开始和游戏暂停后开始播放的时候调用。
+     *
+     * Called while the game to play when game pause.
+     */
     onResume(): void;
+    /**
+     * 游戏暂停的时候调用。
+     *
+     * Called while the game paused.
+     */
     onPause(): void;
+    /**
+     * System 被销毁的时候调用。
+     * Called while the system be destroyed.
+     */
     onDestroy(): void;
     componentChanged(changed: ComponentChanged): Promise<void>;
     private add;

package/dist/plugin-sound.esm.js

@@ -39,23 +39,52 @@ utils.validateFormats({
     aac: 'audio/aac',
 });
 extensions.add(soundAsset);
+/**
+ * 音频系统
+ *
+ * SoundSystem 负责管理游戏中所有音频组件的加载和播放。
+ * 支持自动与游戏生命周期同步（暂停/恢复），
+ * 提供全局音频控制功能（全部暂停/恢复/停止）。
+ *
+ * @example
+ * ```typescript
+ * const soundSystem = new SoundSystem({
+ *   autoPauseAndStart: true,
+ *   onError: (error) => console.error('Sound error:', error)
+ * });
+ *
+ * game.addSystem(soundSystem);
+ * ```
+ */
 let SoundSystem = class SoundSystem extends System {
     constructor(obj) {
         super();
+        /** 是否与游戏生命周期同步暂停和启动 */
         this.autoPauseAndStart = true;
+        /** 管理的音频组件列表 */
         this.components = [];
+        /** 音频缓冲区缓存 */
         this.audioBufferCache = {};
         Object.assign(this, obj);
         if (obj === null || obj === void 0 ? void 0 : obj.useLegacy) {
             sound.useLegacy = true;
         }
     }
+    /**
+     * 恢复播放所有被暂停的音频
+     */
     resumeAll() {
         sound.resumeAll();
     }
+    /**
+     * 暂停所有正在播放的音频
+     */
     pauseAll() {
         sound.pauseAll();
     }
+    /**
+     * 停止所有正在播放的音频
+     */
     stopAll() {
         sound.stopAll();
     }
@@ -65,18 +94,32 @@ let SoundSystem = class SoundSystem extends System {
             this.componentChanged(changed);
         }
     }
+    /**
+     * 游戏开始和游戏暂停后开始播放的时候调用。
+     *
+     * Called while the game to play when game pause.
+     */
     onResume() {
         if (!this.autoPauseAndStart) {
             return;
         }
         this.resumeAll();
     }
+    /**
+     * 游戏暂停的时候调用。
+     *
+     * Called while the game paused.
+     */
     onPause() {
         if (!this.autoPauseAndStart) {
             return;
         }
         this.pauseAll();
     }
+    /**
+     * System 被销毁的时候调用。
+     * Called while the system be destroyed.
+     */
     onDestroy() {
         this.components.forEach(component => {
             component.onDestroy();
@@ -117,6 +160,7 @@ let SoundSystem = class SoundSystem extends System {
         });
     }
 };
+/** 系统名称 */
 SoundSystem.systemName = 'SoundSystem';
 SoundSystem = __decorate([
     decorators.componentObserver({
@@ -125,10 +169,30 @@ SoundSystem = __decorate([
 ], SoundSystem);
 var SoundSystem$1 = SoundSystem;
 
+/**
+ * 音频组件
+ *
+ * Sound 组件用于在游戏对象上播放音频。
+ * 支持音频的播放、暂停、停止、音量控制、循环播放等功能。
+ * 基于 PixiJS Sound 库实现，提供了 Web Audio API 的完整功能。
+ *
+ * @example
+ * ```typescript
+ * const gameObject = new GameObject('bgm');
+ * gameObject.addComponent(new Sound({
+ *   resource: 'background-music',
+ *   autoplay: true,
+ *   loop: true,
+ *   volume: 0.5
+ * }));
+ * ```
+ */
 class Sound extends Component {
     constructor() {
         super(...arguments);
+        /** 音频加载状态 */
         this.state = 'unloaded';
+        /** 音频配置参数 */
         this.config = {
             resource: '',
             autoplay: false,
@@ -138,12 +202,16 @@ class Sound extends Component {
             seek: 0,
             speed: 1,
         };
+        /** 待执行的操作队列（用于资源加载前的操作缓存） */
         this.actionQueue = [];
+        /** 音频开始播放的时间 */
         this.startTime = 0;
     }
+    /** 获取音频系统上下文 */
     get systemContext() {
         return sound.context.audioContext;
     }
+    /** 音频是否正在播放 */
     get playing() {
         if (!this.buffer)
             return false;
@@ -217,6 +285,7 @@ class Sound extends Component {
         }
     }
 }
+/** 组件名称 */
 Sound.componentName = 'Sound';
 var Sound$1 = Sound;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eva/plugin-sound",
-  "version": "2.0.1-beta.3",
+  "version": "2.0.1-beta.31",
   "description": "@eva/plugin-sound",
   "main": "index.js",
   "module": "dist/plugin-sound.esm.js",
@@ -18,7 +18,7 @@
   "license": "MIT",
   "homepage": "https://eva.js.org",
   "dependencies": {
-    "@eva/eva.js": "2.0.1-beta.3",
+    "@eva/eva.js": "2.0.1-beta.31",
     "eventemitter3": "^3.1.2",
     "pixi.js": "^8.8.1",
     "@pixi/sound": "^6.0.1"