SFXPlayer.js

  1. /* global platypus */
  2. import {arrayCache, greenSplice} from './utils/array.js';
  3. import Sound from 'pixi-sound';
  5. /**
  6.  * This class plays sfx audio and manages Springroll volume changes.
  7.  *
  8.  * @memberof platypus
  9.  * @class SFXPlayer
  10.  */
  11.  export default class SFXPlayer {
  12.     constructor () {
  13.         this.volume = 1;
  14.         this.player = Sound;
  15.         this.playingAudio = arrayCache.setUp();
  16.         this.sounds = arrayCache.setUp();
  17.     }
  19.     /**
  20.      * Plays a sound.
  21.      *
  22.      * @method platypus.SFXPlayer#play
  23.      * @param {String} sound Sound Id to play.
  24.      * @param {Object} data PixiSound data to inform sound playback.
  25.      * @return {pixiSound.MediaInstance} The media instance of the playing sound.
  26.      * @public
  27.      */
  28.     play (sound, data) {
  29.         const
  30.             audio = sound.play ? sound.play(data) : this.player.play(sound, data);
  32.         audio.initialVolume = (typeof data.initialVolume === 'number' ? data.initialVolume : audio.volume);
  33.         audio.set('volume', audio.volume * this.volume);
  34.         this.playingAudio.push(audio);
  35.         this.sounds.push(sound);
  36.         audio.on('end', () => {
  37.             const index = this.playingAudio.indexOf(audio);
  39.             greenSplice(this.playingAudio, index);
  40.             greenSplice(this.sounds, index);
  41.         });
  43.         return audio;
  44.     }
  46.     /**
  47.      * Plays a sound.
  48.      *
  49.      * @method platypus.SFXPlayer#stop
  50.      * @param {pixiSound.MediaInstance} audio Audio to stop.
  51.      * @public
  52.      */
  53.     stop (audio) {
  54.         const index = this.playingAudio.indexOf(audio);
  56.         audio.stop();
  57.         if (index >= 0) {
  58.             greenSplice(this.playingAudio, index);
  59.             greenSplice(this.sounds, index);
  60.         } else {
  61.             platypus.debug.warn('SFXPlayer: Did not find "' + audio.soundId + '"');
  62.         }
  63.     }
  65.     /**
  66.      * Sets volume on all playing sound effects.
  67.      *
  68.      * @method platypus.SFXPlayer#setVolume
  69.      * @param {Number} volume A value between 0-1 to set volume on all playing sound effects.
  70.      * @public
  71.      */
  72.     setVolume (volume) {
  73.         const
  74.             playingAudio = this.playingAudio;
  76.         this.volume = volume;
  77.         for (let i = 0; i < playingAudio.length; i++) {
  78.             const
  79.                 audio = playingAudio[i];
  81.             audio.set('volume', audio.initialVolume * this.volume);
  82.         }
  83.     }
  85.     /**
  86.      * Cleans up this SFXPlayer.
  87.      * @method platypus.SFXPlayer#destroy
  88.      * @public
  89.      */
  90.     destroy () {
  91.         arrayCache.recycle(this.playingAudio);
  92.         this.playingAudio = null;
  93.         arrayCache.recycle(this.sounds);
  94.         this.sounds = null;
  95.     }
  96. };