safex-webgl 1.0.0

package/dist/audio/engine.d.ts

@@ -0,0 +1,171 @@
+/**
+ * audioEngine is the singleton object, it provide simple audio APIs.
+ * @namespace
+ */
+export declare const audioEngine: {
+    _currMusic: any;
+    _musicVolume: number;
+    features: any;
+    /**
+     * Indicates whether any background music can be played or not.
+     * @returns {boolean} <i>true</i> if the background music is playing, otherwise <i>false</i>
+     */
+    willPlayMusic: () => boolean;
+    /**
+     * Play music.
+     * @param {String} url The path of the music file without filename extension.
+     * @param {Boolean} loop Whether the music loop or not.
+     * @example
+     * //example
+     * audioEngine.playMusic(path, false);
+     */
+    playMusic: (url: any, loop: any) => void;
+    /**
+     * Stop playing music.
+     * @param {Boolean} [releaseData] If release the music data or not.As default value is false.
+     * @example
+     * //example
+     * audioEngine.stopMusic();
+     */
+    stopMusic: (releaseData: any) => void;
+    /**
+     * Pause playing music.
+     * @example
+     * //example
+     * audioEngine.pauseMusic();
+     */
+    pauseMusic: () => void;
+    /**
+     * Resume playing music.
+     * @example
+     * //example
+     * audioEngine.resumeMusic();
+     */
+    resumeMusic: () => void;
+    /**
+     * Rewind playing music.
+     * @example
+     * //example
+     * audioEngine.rewindMusic();
+     */
+    rewindMusic: () => void;
+    /**
+     * The volume of the music max value is 1.0,the min value is 0.0 .
+     * @return {Number}
+     * @example
+     * //example
+     * var volume = audioEngine.getMusicVolume();
+     */
+    getMusicVolume: () => any;
+    /**
+     * Set the volume of music.
+     * @param {Number} volume Volume must be in 0.0~1.0 .
+     * @example
+     * //example
+     * audioEngine.setMusicVolume(0.5);
+     */
+    setMusicVolume: (volume: any) => void;
+    /**
+     * Whether the music is playing.
+     * @return {Boolean} If is playing return true,or return false.
+     * @example
+     * //example
+     *  if (audioEngine.isMusicPlaying()) {
+     *      log("music is playing");
+     *  }
+     *  else {
+     *      log("music is not playing");
+     *  }
+     */
+    isMusicPlaying: () => any;
+    _audioPool: {};
+    _maxAudioInstance: number;
+    _effectVolume: number;
+    /**
+     * Play sound effect.
+     * @param {String} url The path of the sound effect with filename extension.
+     * @param {Boolean} loop Whether to loop the effect playing, default value is false
+     * @return {Number|null} the audio id
+     * @example
+     * //example
+     * var soundId = audioEngine.playEffect(path);
+     */
+    playEffect: (url: any, loop: any) => any;
+    /**
+     * Set the volume of sound effects.
+     * @param {Number} volume Volume must be in 0.0~1.0 .
+     * @example
+     * //example
+     * audioEngine.setEffectsVolume(0.5);
+     */
+    setEffectsVolume: (volume: any) => void;
+    /**
+     * The volume of the effects max value is 1.0,the min value is 0.0 .
+     * @return {Number}
+     * @example
+     * //example
+     * var effectVolume = audioEngine.getEffectsVolume();
+     */
+    getEffectsVolume: () => any;
+    /**
+     * Pause playing sound effect.
+     * @param {Number} audio The return value of function playEffect.
+     * @example
+     * //example
+     * audioEngine.pauseEffect(audioID);
+     */
+    pauseEffect: (audio: any) => void;
+    /**
+     * Pause all playing sound effect.
+     * @example
+     * //example
+     * audioEngine.pauseAllEffects();
+     */
+    pauseAllEffects: () => void;
+    /**
+     * Resume playing sound effect.
+     * @param {Number} audio The return value of function playEffect.
+     * @audioID
+     * //example
+     * audioEngine.resumeEffect(audioID);
+     */
+    resumeEffect: (audio: any) => void;
+    /**
+     * Resume all playing sound effect
+     * @example
+     * //example
+     * audioEngine.resumeAllEffects();
+     */
+    resumeAllEffects: () => void;
+    /**
+     * Stop playing sound effect.
+     * @param {Number} audio The return value of function playEffect.
+     * @example
+     * //example
+     * audioEngine.stopEffect(audioID);
+     */
+    stopEffect: (audio: any) => void;
+    /**
+     * Stop all playing sound effects.
+     * @example
+     * //example
+     * audioEngine.stopAllEffects();
+     */
+    stopAllEffects: () => void;
+    /**
+     * Unload the preloaded effect from internal buffer
+     * @param {String} url
+     * @example
+     * //example
+     * audioEngine.unloadEffect(EFFECT_FILE);
+     */
+    unloadEffect: (url: any) => void;
+    /**
+     * End music and effects.
+     */
+    end: () => void;
+    _pauseCache: any[];
+    _pausePlaying: () => void;
+    _resumePlaying: () => void;
+};
+//# sourceMappingURL=engine.d.ts.map

package/dist/audio/engine.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"engine.d.ts","sourceRoot":"","sources":["../../src/audio/engine.ts"],"names":[],"mappings":"AA4KA;;;GAGG;AACH,eAAO,MAAM,WAAW;;;;IAMtB;;;OAGG;;IAKH;;;;;;;OAOG;;IAuBH;;;;;;OAMG;;IAeH;;;;;OAKG;;IAMH;;;;;OAKG;;IAMH;;;;;OAKG;;IASH;;;;;;OAMG;;IAKH;;;;;;OAMG;;IAcH;;;;;;;;;;;OAWG;;;;;IAaH;;;;;;;;OAQG;;IAuEH;;;;;;OAMG;;IAkBH;;;;;;OAMG;;IAKH;;;;;;OAMG;;IAOH;;;;;OAKG;;IAaH;;;;;;OAMG;;IAKH;;;;;OAKG;;IAWH;;;;;;OAMG;;IAOH;;;;;OAKG;;IAaH;;;;;;OAMG;;IAiBH;;OAEG;;;;;CAgCJ,CAAA"}