@caperjs/core 0.1.0

package/lib/plugins/actions/constants.d.ts

@@ -0,0 +1,52 @@
+import { Action } from '../..';
+export declare const DefaultActionContexts: {
+    default: string;
+    menu: string;
+    pause: string;
+    popup: string;
+    game: string;
+};
+export declare const DefaultActionContextsArray: string[];
+export declare const DefaultActions: Action[];
+export declare const defaultActionsList: {
+    action: {
+        context: string;
+    };
+    back: {
+        context: string[];
+    };
+    next: {
+        context: string[];
+    };
+    select: {
+        context: string[];
+    };
+    menu: {
+        context: string[];
+    };
+    down: {
+        context: string[];
+    };
+    up: {
+        context: string[];
+    };
+    left: {
+        context: string[];
+    };
+    right: {
+        context: string;
+    };
+    pause: {
+        context: string;
+    };
+    unpause: {
+        context: string;
+    };
+    start: {
+        context: string;
+    };
+};
+export declare const DefaultButtonIds: {
+    __default_do_not_use__: string;
+};
+//# sourceMappingURL=constants.d.ts.map

package/lib/plugins/actions/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/plugins/actions/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAE/B,eAAO,MAAM,qBAAqB;;;;;;CAMjC,CAAC;AAEF,eAAO,MAAM,0BAA0B,UAAgD,CAAC;AAExF,eAAO,MAAM,cAAc,EAAE,MAAM,EAalC,CAAC;AAEF,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAa9B,CAAC;AAEF,eAAO,MAAM,gBAAgB;;CAE5B,CAAC"}

package/lib/plugins/actions/index.d.ts

@@ -0,0 +1,5 @@
+export * from './ActionsPlugin';
+export * from './constants';
+export * from './methods';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/lib/plugins/actions/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/plugins/actions/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,aAAa,CAAC;AAC5B,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC"}

package/lib/plugins/actions/methods.d.ts

@@ -0,0 +1,11 @@
+import { UserActions, UserButtons, UserContexts } from './types';
+/**
+ * Define the contexts for the actions.
+ * @param contexts - The contexts to define.
+ * @default ['default', 'game', 'menu', 'pause', 'popup', 'default']
+ * @returns {ActionContext[]}
+ */
+export declare function defineContexts<C extends UserContexts = UserContexts>(contexts?: C): C;
+export declare function defineActions<C extends UserContexts = UserContexts, U extends UserActions = UserActions<C>>(contexts: C, actions: U, useDefaultActions?: boolean): U;
+export declare function defineButtons<B extends UserButtons = UserButtons>(buttons?: B): B;
+//# sourceMappingURL=methods.d.ts.map

package/lib/plugins/actions/methods.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"methods.d.ts","sourceRoot":"","sources":["../../../src/plugins/actions/methods.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,WAAW,EAAE,KAAK,YAAY,EAAE,MAAM,SAAS,CAAC;AAEhF;;;;;GAKG;AAEH,wBAAgB,cAAc,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY,EAAE,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,CAErF;AAED,wBAAgB,aAAa,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY,EAAE,CAAC,SAAS,WAAW,GAAG,WAAW,CAAC,CAAC,CAAC,EACzG,QAAQ,EAAE,CAAC,EACX,OAAO,EAAE,CAAC,EACV,iBAAiB,GAAE,OAAc,GAChC,CAAC,CAKH;AAED,wBAAgB,aAAa,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,EAAE,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,CAEjF"}

package/lib/plugins/actions/types.d.ts

@@ -0,0 +1,25 @@
+import { Signal } from '../../signals';
+import { DefaultActionContexts, DefaultButtonIds } from './constants';
+export type ActionContext = keyof typeof DefaultActionContexts | (string & {});
+export type Action = 'up' | 'down' | 'left' | 'right' | 'action' | 'next' | 'back' | 'pause' | 'unpause' | 'start' | 'select' | 'menu' | ((string | number) & {});
+export type ActionDetail<T = any> = {
+    id: string | number;
+    context: string | ActionContext;
+    data?: T;
+};
+export type ActionSignal<TActionData = any> = Signal<(detail: ActionDetail<TActionData>) => void>;
+export type ActionsList = (Action | (string & {}))[];
+export type ActionKey = Action | (string & {});
+export type ActionMap<C extends UserContexts = UserContexts> = {
+    [K in ActionKey]: ActionDefinition<C>;
+};
+export type UserActions<C extends UserContexts = UserContexts> = Partial<ActionMap<C>>;
+export type ExtractContext<C extends readonly ActionContext[]> = C[number];
+export type UserContexts = ActionContext[];
+export interface ActionDefinition<C extends UserContexts = UserContexts> {
+    context: ExtractContext<C> | ExtractContext<C>[] | '*' | (string & {});
+}
+export type UserButton = keyof typeof DefaultButtonIds | (string & {});
+export type UserButtons = UserButton[];
+export type ExtractButtonId<B extends UserButtons> = B[number];
+//# sourceMappingURL=types.d.ts.map

package/lib/plugins/actions/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/plugins/actions/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvC,OAAO,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAEtE,MAAM,MAAM,aAAa,GAAG,MAAM,OAAO,qBAAqB,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAE/E,MAAM,MAAM,MAAM,GACd,IAAI,GACJ,MAAM,GACN,MAAM,GACN,OAAO,GACP,QAAQ,GACR,MAAM,GACN,MAAM,GACN,OAAO,GACP,SAAS,GACT,OAAO,GACP,QAAQ,GACR,MAAM,GACN,CAAC,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC;AAE7B,MAAM,MAAM,YAAY,CAAC,CAAC,GAAG,GAAG,IAAI;IAClC,EAAE,EAAE,MAAM,GAAG,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,GAAG,aAAa,CAAC;IAChC,IAAI,CAAC,EAAE,CAAC,CAAC;CACV,CAAC;AACF,MAAM,MAAM,YAAY,CAAC,WAAW,GAAG,GAAG,IAAI,MAAM,CAAC,CAAC,MAAM,EAAE,YAAY,CAAC,WAAW,CAAC,KAAK,IAAI,CAAC,CAAC;AAClG,MAAM,MAAM,WAAW,GAAG,CAAC,MAAM,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC;AACrD,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAE/C,MAAM,MAAM,SAAS,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY,IAAI;KAC5D,CAAC,IAAI,SAAS,GAAG,gBAAgB,CAAC,CAAC,CAAC;CACtC,CAAC;AAEF,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;AAEvF,MAAM,MAAM,cAAc,CAAC,CAAC,SAAS,SAAS,aAAa,EAAE,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC;AAC3E,MAAM,MAAM,YAAY,GAAG,aAAa,EAAE,CAAC;AAE3C,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY;IACrE,OAAO,EAAE,cAAc,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;CACxE;AAED,MAAM,MAAM,UAAU,GAAG,MAAM,OAAO,gBAAgB,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAEvE,MAAM,MAAM,WAAW,GAAG,UAAU,EAAE,CAAC;AAEvC,MAAM,MAAM,eAAe,CAAC,CAAC,SAAS,WAAW,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC"}

package/lib/plugins/audio/AudioChannel.d.ts

@@ -0,0 +1,46 @@
+import { IAudioInstance } from './AudioInstance';
+import { ChannelName, IAudioManagerPlugin } from './AudioManagerPlugin';
+export interface IAudioChannel {
+    name: string;
+    muted: boolean;
+    volume: number;
+    instances: IAudioInstance[];
+    add(id: string, instance: IAudioInstance): IAudioInstance;
+    get(id: string): IAudioInstance | undefined;
+    remove(id: string): IAudioInstance | undefined;
+    removeInstance(instance: IAudioInstance): void;
+    updateVolume(): void;
+    restore(): void;
+    destroy(): void;
+    pause(): void;
+    resume(): void;
+}
+export declare class AudioChannel<C extends ChannelName = ChannelName> {
+    name: C;
+    manager: IAudioManagerPlugin<C>;
+    private _sounds;
+    constructor(name: C, manager: IAudioManagerPlugin<C>);
+    get instances(): IAudioInstance[];
+    private _muted;
+    get muted(): boolean;
+    set muted(value: boolean);
+    private _volume;
+    get volume(): number;
+    set volume(value: number);
+    add(id: string, instance: IAudioInstance): IAudioInstance;
+    get(id: string): IAudioInstance | undefined;
+    remove(id: string): IAudioInstance | undefined;
+    /**
+     * Removes a single instance from its alias bucket without stopping or
+     * destroying it, for use when an instance has naturally reached the end
+     * of its life. No-op if the instance is not currently tracked.
+     */
+    removeInstance(instance: IAudioInstance): void;
+    pause(): void;
+    resume(): void;
+    _setMuted(): void;
+    updateVolume(): void;
+    restore(): void;
+    destroy(): void;
+}
+//# sourceMappingURL=AudioChannel.d.ts.map

package/lib/plugins/audio/AudioChannel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AudioChannel.d.ts","sourceRoot":"","sources":["../../../src/plugins/audio/AudioChannel.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAExE,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,cAAc,EAAE,CAAC;IAE5B,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,cAAc,CAAC;IAE1D,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,CAAC;IAE5C,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,CAAC;IAE/C,cAAc,CAAC,QAAQ,EAAE,cAAc,GAAG,IAAI,CAAC;IAE/C,YAAY,IAAI,IAAI,CAAC;IAErB,OAAO,IAAI,IAAI,CAAC;IAEhB,OAAO,IAAI,IAAI,CAAC;IAEhB,KAAK,IAAI,IAAI,CAAC;IAEd,MAAM,IAAI,IAAI,CAAC;CAChB;AAED,qBAAa,YAAY,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW;IAIlD,IAAI,EAAE,CAAC;IACP,OAAO,EAAE,mBAAmB,CAAC,CAAC,CAAC;IAJxC,OAAO,CAAC,OAAO,CAAsE;gBAG5E,IAAI,EAAE,CAAC,EACP,OAAO,EAAE,mBAAmB,CAAC,CAAC,CAAC;IAKxC,IAAI,SAAS,IAAI,cAAc,EAAE,CAEhC;IAED,OAAO,CAAC,MAAM,CAAkB;IAEhC,IAAI,KAAK,IAAI,OAAO,CAEnB;IAED,IAAI,KAAK,CAAC,KAAK,EAAE,OAAO,EAIvB;IAED,OAAO,CAAC,OAAO,CAAe;IAE9B,IAAI,MAAM,IAAI,MAAM,CAEnB;IAED,IAAI,MAAM,CAAC,KAAK,EAAE,MAAM,EAGvB;IAED,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,cAAc,GAAG,cAAc;IAUzD,GAAG,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAK3C,MAAM,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS;IAa9C;;;;OAIG;IACH,cAAc,CAAC,QAAQ,EAAE,cAAc,GAAG,IAAI;IAe9C,KAAK,IAAI,IAAI;IAYb,MAAM,IAAI,IAAI;IAYd,SAAS,IAAI,IAAI;IAQjB,YAAY;IAWZ,OAAO;IAKP,OAAO;CACR"}

package/lib/plugins/audio/AudioChannel.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=AudioChannel.test.d.ts.map

package/lib/plugins/audio/AudioChannel.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AudioChannel.test.d.ts","sourceRoot":"","sources":["../../../src/plugins/audio/AudioChannel.test.ts"],"names":[],"mappings":""}

package/lib/plugins/audio/AudioInstance.d.ts

@@ -0,0 +1,79 @@
+import { IMediaInstance } from '@pixi/sound';
+import { Signal } from '../../signals';
+import { IAudioChannel } from './AudioChannel';
+import { ChannelName, IAudioManagerPlugin } from './AudioManagerPlugin';
+export interface IAudioInstance<C extends ChannelName = ChannelName> {
+    volume: number;
+    storedVolume: number;
+    media: IMediaInstance;
+    channel: IAudioChannel;
+    muted: boolean;
+    id: string;
+    manager: IAudioManagerPlugin<C>;
+    onStart: Signal<(instance: IAudioInstance) => void>;
+    onStop: Signal<(instance: IAudioInstance) => void>;
+    onEnd: Signal<(instance: IAudioInstance) => void>;
+    onPaused: Signal<(instance: IAudioInstance) => void>;
+    onResumed: Signal<(instance: IAudioInstance) => void>;
+    isPlaying: boolean;
+    fadeTo(volume: number, duration: number): gsap.core.Tween;
+    stop(): void;
+    destroy(): void;
+    remove(): void;
+    updateVolume(): void;
+    addListeners(): void;
+    removeListeners(): void;
+    pause(): void;
+    play(): void;
+    resume(): void;
+}
+export declare class AudioInstance<C extends ChannelName = ChannelName> implements IAudioInstance {
+    id: string;
+    channel: IAudioChannel;
+    manager: IAudioManagerPlugin;
+    storedVolume: number;
+    onStart: Signal<(instance: IAudioInstance) => void>;
+    onStop: Signal<(instance: IAudioInstance) => void>;
+    onEnd: Signal<(instance: IAudioInstance) => void>;
+    onPaused: Signal<(instance: IAudioInstance) => void>;
+    onResumed: Signal<(instance: IAudioInstance) => void>;
+    onProgress: Signal<(instance: IAudioInstance) => void>;
+    constructor(id: string, channel: IAudioChannel, manager: IAudioManagerPlugin);
+    private _media;
+    get media(): IMediaInstance;
+    set media(value: IMediaInstance);
+    private _volume;
+    get volume(): number;
+    set volume(value: number);
+    private _muted;
+    get muted(): boolean;
+    set muted(value: boolean);
+    /**
+     * The volume that should actually reach the media instance: the logical
+     * (unmuted) volume folded through the channel and master volume, forced
+     * to 0 whenever this instance or its channel is muted. Centralizing this
+     * keeps `media.muted` from being the sole thing standing between a muted
+     * channel and audible sound.
+     */
+    private get _effectiveVolume();
+    private _isPlaying;
+    get isPlaying(): boolean;
+    set isPlaying(value: boolean);
+    pause(): void;
+    resume(): void;
+    remove(): void;
+    stop(): void;
+    updateVolume(): void;
+    addListeners(): void;
+    removeListeners(): void;
+    destroy(): void;
+    fadeTo(volume: number, duration: number): gsap.core.Tween;
+    play(time?: number): void;
+    private _handleMediaEnded;
+    private _handleMediaStarted;
+    private _handleMediaStopped;
+    private _handleMediaPaused;
+    private _handleMediaProgress;
+    private _handleMediaResumed;
+}
+//# sourceMappingURL=AudioInstance.d.ts.map

package/lib/plugins/audio/AudioInstance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AudioInstance.d.ts","sourceRoot":"","sources":["../../../src/plugins/audio/AudioInstance.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7C,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAEvC,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,OAAO,EAAE,WAAW,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAExE,MAAM,WAAW,cAAc,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW;IACjE,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,cAAc,CAAC;IACtB,OAAO,EAAE,aAAa,CAAC;IACvB,KAAK,EAAE,OAAO,CAAC;IACf,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,mBAAmB,CAAC,CAAC,CAAC,CAAC;IAChC,OAAO,EAAE,MAAM,CAAC,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAC,CAAC;IACpD,MAAM,EAAE,MAAM,CAAC,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAC,CAAC;IACnD,KAAK,EAAE,MAAM,CAAC,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAC,CAAC;IAClD,QAAQ,EAAE,MAAM,CAAC,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAC,CAAC;IACrD,SAAS,EAAE,MAAM,CAAC,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAC,CAAC;IACtD,SAAS,EAAE,OAAO,CAAC;IAEnB,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;IAE1D,IAAI,IAAI,IAAI,CAAC;IAEb,OAAO,IAAI,IAAI,CAAC;IAEhB,MAAM,IAAI,IAAI,CAAC;IAEf,YAAY,IAAI,IAAI,CAAC;IAErB,YAAY,IAAI,IAAI,CAAC;IAErB,eAAe,IAAI,IAAI,CAAC;IAExB,KAAK,IAAI,IAAI,CAAC;IAEd,IAAI,IAAI,IAAI,CAAC;IAEb,MAAM,IAAI,IAAI,CAAC;CAChB;AAED,qBAAa,aAAa,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,CAAE,YAAW,cAAc;IAU9E,EAAE,EAAE,MAAM;IACV,OAAO,EAAE,aAAa;IACtB,OAAO,EAAE,mBAAmB;IAX9B,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAC,CAAoD;IACvG,MAAM,EAAE,MAAM,CAAC,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAC,CAAoD;IACtG,KAAK,EAAE,MAAM,CAAC,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAC,CAAoD;IACrG,QAAQ,EAAE,MAAM,CAAC,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAC,CAAoD;IACxG,SAAS,EAAE,MAAM,CAAC,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAC,CAAoD;IACzG,UAAU,EAAE,MAAM,CAAC,CAAC,QAAQ,EAAE,cAAc,KAAK,IAAI,CAAC,CAAoD;gBAGxG,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,aAAa,EACtB,OAAO,EAAE,mBAAmB;IAMrC,OAAO,CAAC,MAAM,CAAiB;IAE/B,IAAI,KAAK,IAAI,cAAc,CAE1B;IAED,IAAI,KAAK,CAAC,KAAK,EAAE,cAAc,EAS9B;IAED,OAAO,CAAC,OAAO,CAAa;IAE5B,IAAW,MAAM,IAAI,MAAM,CAE1B;IAED,IAAW,MAAM,CAAC,KAAK,EAAE,MAAM,EAK9B;IAED,OAAO,CAAC,MAAM,CAAkB;IAEhC,IAAI,KAAK,IAAI,OAAO,CAEnB;IAED,IAAI,KAAK,CAAC,KAAK,EAAE,OAAO,EAMvB;IAED;;;;;;OAMG;IACH,OAAO,KAAK,gBAAgB,GAG3B;IAED,OAAO,CAAC,UAAU,CAAkB;IAEpC,IAAI,SAAS,IAIQ,OAAO,CAF3B;IAED,IAAI,SAAS,CAAC,KAAK,EAAE,OAAO,EAE3B;IAED,KAAK,IAAI,IAAI;IAOb,MAAM,IAAI,IAAI;IAOd,MAAM,IAAI,IAAI;IAKd,IAAI;IAQJ,YAAY,IAAI,IAAI;IAIpB,YAAY;IAUZ,eAAe;IAaR,OAAO;IAKP,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK;IAIzD,IAAI,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI;IAShC,OAAO,CAAC,iBAAiB;IAKzB,OAAO,CAAC,mBAAmB;IAK3B,OAAO,CAAC,mBAAmB;IAK3B,OAAO,CAAC,kBAAkB;IAK1B,OAAO,CAAC,oBAAoB;IAI5B,OAAO,CAAC,mBAAmB;CAI5B"}

package/lib/plugins/audio/AudioManagerPlugin.d.ts

@@ -0,0 +1,323 @@
+import { PlayOptions } from '@pixi/sound';
+import { AssetsManifest, UnresolvedAsset } from 'pixi.js';
+import { Signal } from '../../signals';
+import { AudioAsset } from '../../utils';
+import { IPlugin, Plugin } from '../Plugin';
+import { IApplication } from '../../core';
+import { IAudioChannel } from './AudioChannel';
+import { IAudioInstance } from './AudioInstance';
+import TweenVars = gsap.TweenVars;
+export type SoundDetail = {
+    id: string;
+    instance: IAudioInstance;
+    channelName: string;
+};
+export type ChannelVolumeDetail = {
+    channel: IAudioChannel;
+    volume: number;
+};
+export type ChannelMutedDetail = {
+    channel: IAudioChannel;
+    muted: boolean;
+};
+export type ChannelName = 'music' | 'sfx' | 'voiceover' | (string & {});
+export interface IAudioManagerPlugin<C extends ChannelName = ChannelName> extends IPlugin {
+    onSoundStarted: Signal<(detail: SoundDetail) => void>;
+    onSoundEnded: Signal<(detail: SoundDetail) => void>;
+    onMasterVolumeChanged: Signal<(volume: number) => void>;
+    onChannelVolumeChanged: Signal<(detail: ChannelVolumeDetail) => void>;
+    onMuted: Signal<(muted: boolean) => void>;
+    onChannelMuted: Signal<(detail: ChannelMutedDetail) => void>;
+    masterVolume: number;
+    muted: boolean;
+    channels: Map<string, IAudioChannel>;
+    music: IAudioChannel;
+    sfx: IAudioChannel;
+    voiceover: IAudioChannel;
+    vo: IAudioChannel;
+    readonly paused: boolean;
+    /**
+     * The WebAudio context sounds are actually played on. Anything building
+     * `PlayOptions.filters` MUST create its nodes on this context: WebAudio
+     * refuses to connect nodes across contexts, and caper may not share a
+     * `@pixi/sound` instance (and therefore a context) with the consuming app.
+     * `undefined` under the htmlaudio fallback, where filters do not apply.
+     */
+    readonly audioContext: AudioContext | undefined;
+    createChannel(name: string): void;
+    play(soundId: AudioAsset, channelName: C, options?: PlayOptions): Promise<IAudioInstance>;
+    isPlaying(soundId: AudioAsset, channelName: C): boolean;
+    load(soundId: AudioAsset | AudioAsset[], channelName: C, options?: PlayOptions): void;
+    stop(soundId: AudioAsset, channelName: C): IAudioInstance | undefined;
+    setChannelVolume(channelName: C | C[], volume: number): void;
+    getChannel(name: C): IAudioChannel | undefined;
+    addAllFromManifest(manifest: AssetsManifest): void;
+    addAllFromBundle(bundleName: string, manifest?: AssetsManifest | string | undefined): void;
+    add(soundAsset: UnresolvedAsset): void;
+    fade(soundId: AudioAsset, channelName: C, props?: gsap.TweenVars): Promise<gsap.core.Tween | null>;
+    fadeIn(soundId: AudioAsset, channelName: C, props?: gsap.TweenVars): Promise<gsap.core.Tween | null>;
+    fadeOut(soundId: AudioAsset, channelName: C, props?: gsap.TweenVars): Promise<gsap.core.Tween | null>;
+    crossFade(outSoundId: AudioAsset, inSoundId: AudioAsset, channelName: C, duration?: number): Promise<gsap.core.Tween | null>;
+    mute(): void;
+    unmute(): void;
+    pause(): void;
+    resume(): void;
+    suspend(): void;
+    restore(): Promise<void>;
+    getAudioInstance(soundId: AudioAsset, channelName: C): IAudioInstance | undefined;
+    stopAll(fade?: boolean, duration?: number, props?: TweenVars): void;
+}
+/**
+ * AudioManager is a class that manages audio playback in the application.
+ * It provides methods to play, stop, fade in/out, and crossfade sounds.
+ * It also allows you to create and manage audio channels.
+ *
+ * @example
+ * const audioManager = new AudioManager();
+ * audioManager.play('soundId', 'music');
+ */
+export declare class AudioManagerPlugin<C extends ChannelName = ChannelName> extends Plugin implements IAudioManagerPlugin<C> {
+    /**
+     * Signal that is emitted when a sound starts playing.
+     * The callback function receives a SoundDetail object.
+     */
+    onSoundStarted: Signal<(detail: SoundDetail) => void>;
+    /**
+     * Signal that is emitted when a sound ends.
+     * The callback function receives a SoundDetail object.
+     */
+    onSoundEnded: Signal<(detail: SoundDetail) => void>;
+    /**
+     * Signal that is emitted when the system is muted or unmuted.
+     */
+    onMuted: Signal<(muted: boolean) => void>;
+    /**
+     * Signal that is emitted when the master volume changes.
+     * The callback function receives the new volume as a number.
+     */
+    onMasterVolumeChanged: Signal<(volume: number) => void>;
+    /**
+     * Signal that is emitted when a channel's volume changes.
+     * The callback function receives a ChannelVolumeDetail object.
+     */
+    onChannelVolumeChanged: Signal<(detail: ChannelVolumeDetail) => void>;
+    /**
+     * Signal that is emitted when a channel is muted or unmuted.
+     * The callback function receives a ChannelMutedDetail object.
+     */
+    onChannelMuted: Signal<(detail: ChannelMutedDetail) => void>;
+    private _storedVolume;
+    private _paused;
+    private _idMap;
+    /**
+     * Creates a new AudioManager instance.
+     * @param {string} id - The ID of the AudioManager. Default is 'AudioManager'.
+     */
+    constructor(id?: string);
+    private _masterVolume;
+    /**
+     * The WebAudio context sounds actually play on — see
+     * {@link IAudioManagerPlugin.audioContext}. Exposed so consumers can build
+     * `PlayOptions.filters` on the right context instead of guessing.
+     */
+    get audioContext(): AudioContext | undefined;
+    /**
+     * Gets the master volume.
+     * @returns {number} The master volume.
+     */
+    get masterVolume(): number;
+    /**
+     * Sets the master volume.
+     * @param {number} value - The new master volume.
+     */
+    set masterVolume(value: number);
+    private _muted;
+    /**
+     * Gets whether the audio is muted.
+     * @returns {boolean} True if the audio is muted, false otherwise.
+     */
+    get muted(): boolean;
+    /**
+     * Sets whether the audio is muted.
+     * @param {boolean} value - True to mute the audio, false to unmute.
+     */
+    set muted(value: boolean);
+    private _channels;
+    /**
+     * Gets the map of audio channels.
+     * @returns {Map<string, IAudioChannel>} The map of audio channels.
+     */
+    get channels(): Map<string, IAudioChannel>;
+    get music(): IAudioChannel;
+    get sfx(): IAudioChannel;
+    get voiceover(): IAudioChannel;
+    get vo(): IAudioChannel;
+    destroy(): void;
+    /**
+     * Initializes the AudioManager.
+     * @param {IApplication} app
+     * @returns {Promise<void>}
+     */
+    initialize(_options: any, app: IApplication): Promise<void>;
+    /**
+     * Creates a new audio channel.
+     * @param {string} name
+     */
+    createChannel(name: string): void;
+    /**
+     * Sets the volume of the specified channel.
+     * @param {ChannelName|ChannelName[]} channelName
+     * @param {number} volume
+     */
+    setChannelVolume(channelName: C | C[], volume: number): void;
+    /**
+     * Gets the audio channel with the specified name.
+     * @param {C} name
+     * @returns {IAudioChannel | undefined}
+     */
+    getChannel(name: C): IAudioChannel | undefined;
+    /**
+     * Mutes the audio.
+     */
+    mute(): void;
+    /**
+     * Unmutes the audio.
+     */
+    unmute(): void;
+    /**
+     * Pauses the audio.
+     */
+    pause(): void;
+    /**
+     * Resumes the audio.
+     */
+    resume(): void;
+    get paused(): boolean;
+    /**
+     * Adds all sound assets from the specified manifest.
+     * @param {AssetsManifest} manifest
+     */
+    addAllFromManifest(manifest: AssetsManifest): void;
+    private _addPrefix;
+    /**
+     * Adds all sound assets from the specified bundle.
+     * @param {string} bundleName
+     * @param {AssetsManifest | string | undefined} manifest
+     */
+    addAllFromBundle(bundleName: string, manifest?: AssetsManifest | string | undefined): void;
+    /**
+     * Adds a sound asset to the AudioManager.
+     * @param {UnresolvedAsset} soundAsset
+     */
+    add(soundAsset: UnresolvedAsset): void;
+    isPlaying(soundId: string, channelName: C): boolean;
+    /**
+     * Plays a sound with the specified ID in the specified channel.
+     * @param {string} soundId
+     * @param {C} channelName
+     * @param {PlayOptions} options
+     * @returns {Promise<IAudioInstance>}
+     */
+    /**
+     * Drops any filter whose nodes belong to a different `AudioContext` than the
+     * one playback runs on.
+     *
+     * WebAudio refuses cross-context `connect()`, and @pixi/sound wires filters
+     * deep inside `WebAudioInstance.play()` — so one foreign filter throws
+     * `InvalidAccessError` from a place the caller cannot catch, and the sound
+     * never plays AT ALL. Silent-and-unattributable is the worst failure mode we
+     * can hand an app, so prefer dry audio plus a pointed error: the sound is
+     * still heard, and the log says exactly how to fix it. This is easy to hit
+     * because an app bundling its own `@pixi/sound` gets a different context than
+     * caper's — build filters on {@link audioContext}.
+     */
+    private _usableFilters;
+    play(soundId: AudioAsset, channelName?: C, options?: PlayOptions): Promise<IAudioInstance>;
+    /**
+     * Stops a sound with the specified ID in the specified channel.
+     * @param {AudioAsset} soundId
+     * @param {C} channelName
+     * @returns {IAudioInstance | undefined}
+     */
+    stop(soundId: AudioAsset, channelName?: C): IAudioInstance | undefined;
+    /**
+     * Fades in a sound with the specified ID in the specified channel.
+     * @param {AudioAsset} soundId
+     * @param {C} channelName
+     * @param {gsap.TweenVars} props
+     * @returns {Promise<gsap.core.Tween | null>}
+     */
+    fadeIn(soundId: AudioAsset, channelName: C | undefined, props: gsap.TweenVars): Promise<gsap.core.Tween | null>;
+    /**
+     * Fades out a sound with the specified ID in the specified channel.
+     * @param {AudioAsset} soundId
+     * @param {C} channelName
+     * @param {Partial<gsap.TweenVars>} props
+     * @returns {Promise<gsap.core.Tween | null>}
+     */
+    fadeOut(soundId: AudioAsset, channelName?: C, props?: Partial<gsap.TweenVars>): Promise<gsap.core.Tween | null>;
+    /**
+     * Crossfades between two sounds in the specified channel.
+     * @param {AudioAsset} outSoundId
+     * @param {AudioAsset} inSoundId
+     * @param {ChannelName} channelName
+     * @param {number} duration
+     * @returns {Promise<gsap.core.Tween | null>}
+     */
+    crossFade(outSoundId: AudioAsset, inSoundId: AudioAsset, channelName?: ChannelName, duration?: number): Promise<gsap.core.Tween | null>;
+    /**
+     * Fades a sound with the specified ID in the specified channel.
+     * @param {AudioAsset} soundId
+     * @param {ChannelName} channelName
+     * @param {gsap.TweenVars} props
+     * @param {boolean} stopOnComplete
+     * @returns {Promise<gsap.core.Tween | null>}
+     */
+    fade(soundId: AudioAsset, channelName: ChannelName | undefined, props: gsap.TweenVars, stopOnComplete?: boolean): Promise<gsap.core.Tween | null>;
+    /**
+     * Restores the audio state after it has been suspended.
+     */
+    restore(): Promise<void>;
+    /**
+     * Suspends the audio by setting the master volume to 0 and pausing all sounds.
+     */
+    suspend(): void;
+    getAudioInstance(soundId: AudioAsset, channelName?: C): IAudioInstance | undefined;
+    load(soundId: AudioAsset | AudioAsset[], channelName?: C, options?: PlayOptions): void;
+    stopAll(fade?: boolean, duration?: number, props?: TweenVars): void;
+    protected getCoreSignals(): string[];
+    private _verifySoundId;
+    private _findAndAddFromManifest;
+    /**
+     * @private
+     */
+    private _setMuted;
+    /**
+     * @private
+     */
+    private _setPaused;
+    /**
+     * Sets the volume of the specified channel.
+     * @param {C} channelName
+     * @param {number} volume
+     * @private
+     */
+    private _setChannelVolume;
+    /**
+     * Sound started event handler. Emit the onSoundStarted signal.
+     * @param {string} id
+     * @param {IAudioInstance} instance
+     * @param {C} channelName
+     * @private
+     */
+    private _soundStarted;
+    /**
+     * Sound ended event handler. Emit the onSoundEnded signal.
+     * @param {string} id
+     * @param {IAudioInstance} instance
+     * @param {C} channelName
+     * @private
+     */
+    private _soundEnded;
+}
+//# sourceMappingURL=AudioManagerPlugin.d.ts.map

package/lib/plugins/audio/AudioManagerPlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AudioManagerPlugin.d.ts","sourceRoot":"","sources":["../../../src/plugins/audio/AudioManagerPlugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,WAAW,EAA0C,MAAM,aAAa,CAAC;AAE3F,OAAO,EAAU,cAAc,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAClE,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvC,OAAO,EAAE,UAAU,EAAU,MAAM,aAAa,CAAC;AACjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACzC,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC,OAAO,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAC1C,OAAO,EAAgB,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC7D,OAAO,EAAiB,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAChE,OAAO,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;AAElC,MAAM,MAAM,WAAW,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,cAAc,CAAC;IAAC,WAAW,EAAE,MAAM,CAAA;CAAE,CAAC;AACxF,MAAM,MAAM,mBAAmB,GAAG;IAAE,OAAO,EAAE,aAAa,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAC7E,MAAM,MAAM,kBAAkB,GAAG;IAAE,OAAO,EAAE,aAAa,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,CAAC;AAC5E,MAAM,MAAM,WAAW,GAAG,OAAO,GAAG,KAAK,GAAG,WAAW,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAqCxE,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,CAAE,SAAQ,OAAO;IACvF,cAAc,EAAE,MAAM,CAAC,CAAC,MAAM,EAAE,WAAW,KAAK,IAAI,CAAC,CAAC;IACtD,YAAY,EAAE,MAAM,CAAC,CAAC,MAAM,EAAE,WAAW,KAAK,IAAI,CAAC,CAAC;IACpD,qBAAqB,EAAE,MAAM,CAAC,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC,CAAC;IACxD,sBAAsB,EAAE,MAAM,CAAC,CAAC,MAAM,EAAE,mBAAmB,KAAK,IAAI,CAAC,CAAC;IACtE,OAAO,EAAE,MAAM,CAAC,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC,CAAC;IAC1C,cAAc,EAAE,MAAM,CAAC,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC,CAAC;IAE7D,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,OAAO,CAAC;IACf,QAAQ,EAAE,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IACrC,KAAK,EAAE,aAAa,CAAC;IACrB,GAAG,EAAE,aAAa,CAAC;IACnB,SAAS,EAAE,aAAa,CAAC;IACzB,EAAE,EAAE,aAAa,CAAC;IAElB,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IAEzB;;;;;;OAMG;IACH,QAAQ,CAAC,YAAY,EAAE,YAAY,GAAG,SAAS,CAAC;IAEhD,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAE1F,SAAS,CAAC,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC,GAAG,OAAO,CAAC;IAExD,IAAI,CAAC,OAAO,EAAE,UAAU,GAAG,UAAU,EAAE,EAAE,WAAW,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IAEtF,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC,GAAG,cAAc,GAAG,SAAS,CAAC;IAEtE,gBAAgB,CAAC,WAAW,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7D,UAAU,CAAC,IAAI,EAAE,CAAC,GAAG,aAAa,GAAG,SAAS,CAAC;IAE/C,kBAAkB,CAAC,QAAQ,EAAE,cAAc,GAAG,IAAI,CAAC;IAEnD,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,MAAM,GAAG,SAAS,GAAG,IAAI,CAAC;IAE3F,GAAG,CAAC,UAAU,EAAE,eAAe,GAAG,IAAI,CAAC;IAEvC,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;IAEnG,MAAM,CAAC,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;IAErG,OAAO,CAAC,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC,EAAE,KAAK,CAAC,EAAE,IAAI,CAAC,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;IAEtG,SAAS,CACP,UAAU,EAAE,UAAU,EACtB,SAAS,EAAE,UAAU,EACrB,WAAW,EAAE,CAAC,EACd,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC;IAEnC,IAAI,IAAI,IAAI,CAAC;IAEb,MAAM,IAAI,IAAI,CAAC;IAEf,KAAK,IAAI,IAAI,CAAC;IAEd,MAAM,IAAI,IAAI,CAAC;IAEf,OAAO,IAAI,IAAI,CAAC;IAEhB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzB,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,WAAW,EAAE,CAAC,GAAG,cAAc,GAAG,SAAS,CAAC;IAElF,OAAO,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,SAAS,GAAG,IAAI,CAAC;CACrE;AAED;;;;;;;;GAQG;AACH,qBAAa,kBAAkB,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,CAAE,SAAQ,MAAO,YAAW,mBAAmB,CAAC,CAAC,CAAC;IAEnH;;;OAGG;IACI,cAAc,EAAE,MAAM,CAAC,CAAC,MAAM,EAAE,WAAW,KAAK,IAAI,CAAC,CAA+C;IAC3G;;;OAGG;IACI,YAAY,EAAE,MAAM,CAAC,CAAC,MAAM,EAAE,WAAW,KAAK,IAAI,CAAC,CAA+C;IACzG;;OAEG;IACI,OAAO,EAAE,MAAM,CAAC,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC,CAA0C;IAC1F;;;OAGG;IACI,qBAAqB,EAAE,MAAM,CAAC,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC,CAA0C;IACxG;;;OAGG;IACI,sBAAsB,EAAE,MAAM,CAAC,CAAC,MAAM,EAAE,mBAAmB,KAAK,IAAI,CAAC,CAExE;IACJ;;;OAGG;IACI,cAAc,EAAE,MAAM,CAAC,CAAC,MAAM,EAAE,kBAAkB,KAAK,IAAI,CAAC,CAE/D;IAEJ,OAAO,CAAC,aAAa,CAAiC;IACtD,OAAO,CAAC,OAAO,CAAkB;IACjC,OAAO,CAAC,MAAM,CAAkC;IAEhD;;;OAGG;gBACgB,EAAE,GAAE,MAAgB;IAQvC,OAAO,CAAC,aAAa,CAAa;IAElC;;;;OAIG;IACH,IAAI,YAAY,IAAI,YAAY,GAAG,SAAS,CAE3C;IAED;;;OAGG;IACH,IAAI,YAAY,IAAI,MAAM,CAEzB;IAED;;;OAGG;IACH,IAAI,YAAY,CAAC,KAAK,EAAE,MAAM,EAG7B;IAED,OAAO,CAAC,MAAM,CAAkB;IAEhC;;;OAGG;IACH,IAAI,KAAK,IAAI,OAAO,CAEnB;IAED;;;OAGG;IACH,IAAI,KAAK,CAAC,KAAK,EAAE,OAAO,EAGvB;IAED,OAAO,CAAC,SAAS,CAAoC;IAErD;;;OAGG;IACH,IAAI,QAAQ,IAAI,GAAG,CAAC,MAAM,EAAE,aAAa,CAAC,CAEzC;IAED,IAAI,KAAK,IAAI,aAAa,CAEzB;IAED,IAAI,GAAG,IAAI,aAAa,CAEvB;IAED,IAAI,SAAS,IAAI,aAAa,CAE7B;IAED,IAAI,EAAE,IAAI,aAAa,CAEtB;IAEM,OAAO,IAAI,IAAI;IActB;;;;OAIG;IACI,UAAU,CAAC,QAAQ,EAAE,GAAG,EAAE,GAAG,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAQlE;;;OAGG;IACI,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAQxC;;;;OAIG;IACI,gBAAgB,CAAC,WAAW,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,GAAG,IAAI;IAOnE;;;;OAIG;IACI,UAAU,CAAC,IAAI,EAAE,CAAC,GAAG,aAAa,GAAG,SAAS;IAIrD;;OAEG;IACI,IAAI;IAKX;;OAEG;IACI,MAAM;IAKb;;OAEG;IACI,KAAK,IAAI,IAAI;IAKpB;;OAEG;IACI,MAAM,IAAI,IAAI;IAKrB,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED;;;OAGG;IACI,kBAAkB,CAAC,QAAQ,EAAE,cAAc;IAMlD,OAAO,CAAC,UAAU;IAYlB;;;;OAIG;IACI,gBAAgB,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,MAAM,GAAG,SAAS;IA4B1F;;;OAGG;IACI,GAAG,CAAC,UAAU,EAAE,eAAe,GAAG,IAAI;IAuB7C,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,GAAG,OAAO;IAQnD;;;;;;OAMG;IACH;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,cAAc;IAuBT,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,WAAW,GAAE,CAAc,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,cAAc,CAAC;IAmDnH;;;;;OAKG;IACI,IAAI,CAAC,OAAO,EAAE,UAAU,EAAE,WAAW,GAAE,CAAc,GAAG,cAAc,GAAG,SAAS;IASzF;;;;;;OAMG;IACU,MAAM,CACjB,OAAO,EAAE,UAAU,EACnB,WAAW,EAAE,CAAC,YAAe,EAC7B,KAAK,EAAE,IAAI,CAAC,SAAS,GACpB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IAelC;;;;;;OAMG;IACU,OAAO,CAClB,OAAO,EAAE,UAAU,EACnB,WAAW,GAAE,CAAgB,EAC7B,KAAK,GAAE,OAAO,CAAC,IAAI,CAAC,SAAS,CAAiB,GAC7C,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IAclC;;;;;;;OAOG;IACU,SAAS,CACpB,UAAU,EAAE,UAAU,EACtB,SAAS,EAAE,UAAU,EACrB,WAAW,GAAE,WAAqB,EAClC,QAAQ,GAAE,MAAU,GACnB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IAMlC;;;;;;;OAOG;IACU,IAAI,CACf,OAAO,EAAE,UAAU,EACnB,WAAW,EAAE,WAAW,YAAU,EAClC,KAAK,EAAE,IAAI,CAAC,SAAS,EACrB,cAAc,GAAE,OAAe,GAC9B,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IAkBlC;;OAEG;IACU,OAAO;IAepB;;OAEG;IACI,OAAO;IAMP,gBAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,WAAW,GAAE,CAAc,GAAG,cAAc,GAAG,SAAS;IAU9F,IAAI,CAAC,OAAO,EAAE,UAAU,GAAG,UAAU,EAAE,EAAE,WAAW,GAAE,CAAc,EAAE,OAAO,CAAC,EAAE,WAAW,GAAG,IAAI;IAuBlG,OAAO,CAAC,IAAI,GAAE,OAAe,EAAE,QAAQ,GAAE,MAAU,EAAE,KAAK,GAAE,SAAc;IA8BjF,SAAS,CAAC,cAAc,IAAI,MAAM,EAAE;IAWpC,OAAO,CAAC,cAAc;IAwCtB,OAAO,CAAC,uBAAuB;IAwC/B;;OAEG;IACH,OAAO,CAAC,SAAS;IASjB;;OAEG;IACH,OAAO,CAAC,UAAU;IAQlB;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IASzB;;;;;;OAMG;IACH,OAAO,CAAC,aAAa;IAKrB;;;;;;OAMG;IACH,OAAO,CAAC,WAAW;CAIpB"}

package/lib/plugins/audio/VoiceOverPlugin.d.ts

@@ -0,0 +1,69 @@
+import { Signal } from '../../signals';
+import { IPlugin, Plugin } from '../Plugin';
+import { IAudioInstance } from './AudioInstance';
+export type PlayMode = 'append' | 'override' | 'new';
+export type VoCallback = (didPlay: boolean) => void;
+export type VoKey = string | number;
+export type Caption = {
+    id: string;
+    args?: {
+        [key: string]: string;
+    };
+};
+export interface IPlayVoiceOverOptions {
+    mode?: PlayMode;
+    priority?: number;
+    callback?: VoCallback;
+    localized?: boolean;
+}
+export interface IVoiceOverPlugin extends IPlugin {
+    fadeOutDuration: number;
+    debug: boolean;
+    onVoiceOverStart: Signal<(instance: IAudioInstance) => void>;
+    onVoiceOverPaused: Signal<(instance: IAudioInstance) => void>;
+    onVoiceOverResumed: Signal<(instance: IAudioInstance) => void>;
+    onVoiceOverComplete: Signal<(instance: IAudioInstance) => void>;
+    onVoiceOverStopped: Signal<(instance?: IAudioInstance) => void>;
+    paused: boolean;
+    playVO(key: VoKey | VoKey[], mode?: PlayMode, callback?: VoCallback): Promise<IAudioInstance>;
+    playVO(key: VoKey | VoKey[], callback?: VoCallback): Promise<IAudioInstance>;
+    playVO(key: VoKey | VoKey[], options?: IPlayVoiceOverOptions): Promise<IAudioInstance>;
+    stopVO(): Promise<void>;
+    pauseVO(): void;
+    resumeVO(): void;
+}
+export declare class VoiceOverPlugin extends Plugin implements IVoiceOverPlugin {
+    readonly id = "voiceover";
+    fadeOutDuration: number;
+    debug: boolean;
+    onVoiceOverStart: Signal<(instance: IAudioInstance) => void>;
+    onVoiceOverPaused: Signal<(instance: IAudioInstance) => void>;
+    onVoiceOverComplete: Signal<(instance: IAudioInstance) => void>;
+    onVoiceOverResumed: Signal<(instance: IAudioInstance) => void>;
+    onVoiceOverStopped: Signal<(instance?: IAudioInstance) => void>;
+    private readonly _queue;
+    private readonly _pausedQueue;
+    private _paused;
+    get paused(): boolean;
+    get activeTimeout(): gsap.core.Tween | undefined;
+    get activeVO(): IAudioInstance | undefined;
+    initialize(): Promise<void>;
+    playVO(key: VoKey | VoKey[], mode?: PlayMode, callback?: VoCallback): Promise<IAudioInstance>;
+    playVO(key: VoKey | VoKey[], callback?: VoCallback): Promise<IAudioInstance>;
+    playVO(key: VoKey | VoKey[], options?: IPlayVoiceOverOptions): Promise<IAudioInstance>;
+    stopVO(): Promise<void>;
+    pauseVO(): void;
+    resumeVO(): void;
+    protected getCoreSignals(): string[];
+    private addToQueue;
+    private playNext;
+    private _handleActiveVOStarted;
+    private _handleActiveVOPaused;
+    private _handleActiveVOResumed;
+    private _handleActiveVOEndedWithoutPlaying;
+    private _handleActiveVOEnded;
+    private _currentItemCallback;
+    private onPause;
+    private onResume;
+}
+//# sourceMappingURL=VoiceOverPlugin.d.ts.map