Engine API Reference - v2.6.1
    Preparing search index...

    Class SoundInstance

    A SoundInstance plays a Sound.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    source

    Accessors

    currentTime duration isPaused isPlaying isStopped isSuspended loop pitch sound startTime volume

    Methods

    clearExternalNodes fire getExternalNodes hasEvent off on once pause play resume setExternalNodes stop

    Events

    EVENT_END EVENT_PAUSE EVENT_PLAY EVENT_RESUME EVENT_STOP

    Constructors

    • Create a new SoundInstance instance.

      Parameters

      • manager: SoundManager

        The sound manager.

      • sound: Sound

        The sound to play.

      • options: {
            duration?: number;
            loop?: boolean;
            onEnd?: Function;
            onPause?: Function;
            onPlay?: Function;
            onResume?: Function;
            onStop?: Function;
            pitch?: number;
            startTime?: number;
            volume?: number;
        }

        Options for the instance.

        • Optionalduration?: number

          The total time after the startTime in seconds when playback will stop or restart if loop is true. Defaults to 0.

        • Optionalloop?: boolean

          Whether the sound should loop when it reaches the end or not. Defaults to false.

        • OptionalonEnd?: Function

          Function called when the instance ends.

        • OptionalonPause?: Function

          Function called when the instance is paused.

        • OptionalonPlay?: Function

          Function called when the instance starts playing.

        • OptionalonResume?: Function

          Function called when the instance is resumed.

        • OptionalonStop?: Function

          Function called when the instance is stopped.

        • Optionalpitch?: number

          The relative pitch. Defaults to 1 (plays at normal pitch).

        • OptionalstartTime?: number

          The time from which the playback will start in seconds. Default is 0 to start at the beginning. Defaults to 0.

        • Optionalvolume?: number

          The playback volume, between 0 and 1. Defaults to 1.

      Returns SoundInstance

    Properties

    source: AudioBufferSourceNode = null

    Gets the source that plays the sound resource. If the Web Audio API is not supported the type of source is Audio. Source is only available after calling play.

    Accessors

    • get currentTime(): number

      Gets the current time of the sound that is playing.

      Returns number

    • set currentTime(value: number): void

      Sets the current time of the sound that is playing. If the value provided is bigger than the duration of the instance it will wrap from the beginning.

      Parameters

      • value: number

      Returns void

    • get duration(): number

      Gets the duration of the sound that the instance will play starting from startTime.

      Returns number

    • set duration(value: number): void

      Sets the duration of the sound that the instance will play starting from startTime.

      Parameters

      • value: number

      Returns void

    • get isSuspended(): boolean

      Gets whether the instance is currently suspended because the window is not focused.

      Returns boolean

    • get loop(): boolean

      Gets whether the instance will restart when it finishes playing.

      Returns boolean

    • set loop(value: boolean): void

      Sets whether the instance will restart when it finishes playing.

      Parameters

      • value: boolean

      Returns void

    • get pitch(): number

      Gets the pitch modifier to play the sound with.

      Returns number

    • set pitch(pitch: number): void

      Sets the pitch modifier to play the sound with. Must be larger than 0.01.

      Parameters

      • pitch: number

      Returns void

    • get startTime(): number

      Gets the start time from which the sound will start playing.

      Returns number

    • set startTime(value: number): void

      Sets the start time from which the sound will start playing.

      Parameters

      • value: number

      Returns void

    • get volume(): number

      Gets the volume modifier to play the sound with. In range 0-1.

      Returns number

    • set volume(volume: number): void

      Sets the volume modifier to play the sound with. In range 0-1.

      Parameters

      • volume: number

      Returns void

    Methods

    • Fire an event, all additional arguments are passed on to the event listener.

      Parameters

      • name: string

        Name of event to fire.

      • Optionalarg1: any

        First argument that is passed to the event handler.

      • Optionalarg2: any

        Second argument that is passed to the event handler.

      • Optionalarg3: any

        Third argument that is passed to the event handler.

      • Optionalarg4: any

        Fourth argument that is passed to the event handler.

      • Optionalarg5: any

        Fifth argument that is passed to the event handler.

      • Optionalarg6: any

        Sixth argument that is passed to the event handler.

      • Optionalarg7: any

        Seventh argument that is passed to the event handler.

      • Optionalarg8: any

        Eighth argument that is passed to the event handler.

      Returns EventHandler

      Self for chaining.

      obj.fire('test', 'This is the message');

    • Test if there are any handlers bound to an event name.

      Parameters

      • name: string

        The name of the event to test.

      Returns boolean

      True if the object has handlers bound to the specified event name.

      obj.on('test', () => {}); // bind an event to 'test'
      obj.hasEvent('test'); // returns true
      obj.hasEvent('hello'); // returns false

    • Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.

      Parameters

      • Optionalname: string

        Name of the event to unbind.

      • Optionalcallback: HandleEventCallback

        Function to be unbound.

      • Optionalscope: any

        Scope that was used as the this when the event is fired.

      Returns EventHandler

      Self for chaining.

      const handler = () => {};
      obj.on('test', handler);

      obj.off(); // Removes all events
      obj.off('test'); // Removes all events called 'test'
      obj.off('test', handler); // Removes all handler functions, called 'test'
      obj.off('test', handler, this); // Removes all handler functions, called 'test' with scope this

    • Attach an event handler to an event.

      Parameters

      • name: string

        Name of the event to bind the callback to.

      • callback: HandleEventCallback

        Function that is called when event is fired. Note the callback is limited to 8 arguments.

      • Optionalscope: any = ...

        Object to use as 'this' when the event is fired, defaults to current this.

      Returns EventHandle

      Can be used for removing event in the future.

      obj.on('test', (a, b) => {
          console.log(a + b);
      });
      obj.fire('test', 1, 2); // prints 3 to the console

      const evt = obj.on('test', (a, b) => {
          console.log(a + b);
      });
      // some time later
      evt.off();

    • Attach an event handler to an event. This handler will be removed after being fired once.

      Parameters

      • name: string

        Name of the event to bind the callback to.

      • callback: HandleEventCallback

        Function that is called when event is fired. Note the callback is limited to 8 arguments.

      • Optionalscope: any = ...

        Object to use as 'this' when the event is fired, defaults to current this.

      Returns EventHandle

      • can be used for removing event in the future.
      obj.once('test', (a, b) => {
          console.log(a + b);
      });
      obj.fire('test', 1, 2); // prints 3 to the console
      obj.fire('test', 1, 2); // not going to get handled

    • Pauses playback of sound. Call resume() to resume playback from the same position.

      Returns boolean

      Returns true if the sound was paused.

    • Attempt to begin playback the sound. If the AudioContext is suspended, the audio will only start once it's resumed. If the sound is already playing, this will restart the sound.

      Returns boolean

      True if the sound was started immediately.

    • Resumes playback of the sound. Playback resumes at the point that the audio was paused.

      Returns boolean

      Returns true if the sound was resumed.

    • Connects external Web Audio API nodes. You need to pass the first node of the node graph that you created externally and the last node of that graph. The first node will be connected to the audio source and the last node will be connected to the destination of the AudioContext (e.g. speakers). Requires Web Audio API support.

      Parameters

      • firstNode: AudioNode

        The first node that will be connected to the audio source of sound instances.

      • OptionallastNode: AudioNode

        The last node that will be connected to the destination of the AudioContext. If unspecified then the firstNode will be connected to the destination instead.

      Returns void

      const context = app.systems.sound.context;
      const analyzer = context.createAnalyzer();
      const distortion = context.createWaveShaper();
      const filter = context.createBiquadFilter();
      analyzer.connect(distortion);
      distortion.connect(filter);
      instance.setExternalNodes(analyzer, filter);

    • Stops playback of sound. Calling play() again will restart playback from the beginning of the sound.

      Returns boolean

      Returns true if the sound was stopped.

    Events

    EVENT_END: string = 'end'

    Fired when the sound currently played by the instance ends.

    instance.on('end', () => {
        console.log('Instance ended');
    });
    EVENT_PAUSE: string = 'pause'

    Fired when the instance is paused.

    instance.on('pause', () => {
        console.log('Instance paused');
    });
    EVENT_PLAY: string = 'play'

    Fired when the instance starts playing its source.

    instance.on('play', () => {
        console.log('Instance started playing');
    });
    EVENT_RESUME: string = 'resume'

    Fired when the instance is resumed.

    instance.on('resume', () => {
        console.log('Instance resumed');
    });
    EVENT_STOP: string = 'stop'

    Fired when the instance is stopped.

    instance.on('stop', () => {
        console.log('Instance stopped');
    });

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    Events