Class Sound

constructor

• new Sound(src, options?): Sound

• Construct a Sound by providing the source URL and other options.

  Parameters

  • src: string

    The audio source path, either a relative path or a remote URL

  • Optional options: {
        context: AudioContext;
        forceBuffer: boolean;
    } = {}

    Additional options which configure the Sound

    • context: AudioContext

      A non-default audio context within which the sound should play

    • forceBuffer: boolean

      Force use of an AudioBufferSourceNode even if the audio duration is long

  Returns Sound

id

src

gainNode

buffer

element

destination

effects

startTime

pausedTime

Static STATES

Static MAX_BUFFER_DURATION

Static emittedEvents

context

• get context(): AudioContext

• The audio context within which this Sound is played.

  Returns AudioContext

sourceNode

• get sourceNode(): AudioBufferSourceNode | MediaElementAudioSourceNode

• The AudioSourceNode used to control sound playback.

  Returns AudioBufferSourceNode | MediaElementAudioSourceNode

loaded

• get loaded(): boolean

• Has the audio file been loaded either fully or for streaming.

  Returns boolean

failed

• get failed(): boolean

• Did the audio file fail to load.

  Returns boolean

playing

• get playing(): boolean

• Is this sound currently playing?

  Returns boolean

isBuffer

• get isBuffer(): boolean

• Does this Sound use an AudioBufferSourceNode? Otherwise, the Sound uses a streamed MediaElementAudioSourceNode.

  Returns boolean

gain

• get gain(): AudioParam

• A convenience reference to the GainNode gain audio parameter.

  Returns AudioParam

volume

• get volume(): number

• The currently playing volume of the sound. Undefined until playback has started for the first time.

  Returns number
• set volume(value): void

• Parameters

  • value: number

  Returns void

duration

• get duration(): number

• The total duration of the audio source in seconds.

  Returns number

currentTime

• get currentTime(): number

• The current playback time of the sound.

  Returns number

loop

• get loop(): boolean

• Is the sound looping?

  Returns boolean
• set loop(value): void

• Parameters

  • value: boolean

  Returns void

load

• load(options?): Promise<Sound>

• Load the audio source and prepare it for playback, either using an AudioBuffer or a streamed HTMLAudioElement.

  Parameters

  • Optional options: {
        autoplay: boolean;
        autoplayOptions: SoundPlaybackOptions;
    } = {}

    Additional options which affect resource loading

    • autoplay: boolean

      Automatically begin playback of the sound once loaded

    • autoplayOptions: SoundPlaybackOptions

      Playback options passed to Sound#play, if autoplay

  Returns Promise<Sound>

  A Promise which resolves to the Sound once it is loaded

play

• play(options?, ...args): Promise<Sound>

• Begin playback for the Sound. This method is asynchronous because playback may not start until after an initially provided delay. The Promise resolves before the fade-in of any configured volume transition.

  Parameters

  • Optional options: SoundPlaybackOptions = {}

    Options which configure the beginning of sound playback

  • Rest ...args: any

  Returns Promise<Sound>

  A Promise which resolves once playback has started (excluding fade)

pause

• pause(): void

• Pause playback of the Sound. For AudioBufferSourceNode this stops playback after recording the current time. Calling Sound#play will resume playback from the pausedTime unless some other offset is passed. For a MediaElementAudioSourceNode this simply calls the HTMLAudioElement#pause method directly.

  Returns void

stop

• stop(options?): Promise<Sound>

• Stop playback for the Sound. This method is asynchronous because playback may not stop until after an initially provided delay. The Promise resolves after the fade-out of any configured volume transition.

  Parameters

  • Optional options: SoundPlaybackOptions = {}

    Options which configure the stopping of sound playback

  Returns Promise<Sound>

  A Promise which resolves once playback is fully stopped (including fade)

fade

• fade(volume, options?): Promise<void>

• Fade the volume for this sound between its current level and a desired target volume.

  Parameters

  • volume: number

    The desired target volume level between 0 and 1

  • Optional options: {
        duration: number;
        from: number;
        type: string;
    } = {}

    Additional options that configure the fade operation

    • duration: number

      The duration of the fade effect in milliseconds

    • from: number

      A volume level to start from, the current volume by default

    • type: string

      The type of fade easing, "linear" or "exponential"

  Returns Promise<void>

  A Promise that resolves after the requested fade duration

schedule

• schedule(fn, playbackTime): Promise<any>

• Schedule a function to occur at the next occurrence of a specific playbackTime for this Sound.

  Parameters

  • fn: SoundScheduleCallback

    A function that will be called with this Sound as its single argument

  • playbackTime: number

    The desired playback time at which the function should be called

  Returns Promise<any>

  A Promise which resolves to the returned value of the provided function once it has been evaluated.

  Example: Schedule audio playback changes

  sound.schedule(() => console.log("Do something exactly 30 seconds into the track"), 30);
  sound.schedule(() => console.log("Do something next time the track loops back to the beginning"), 0);
  sound.schedule(() => console.log("Do something 5 seconds before the end of the track"), sound.duration - 5);
  Copy

applyEffects

• applyEffects(effects?): void

• Update the array of effects applied to a Sound instance. Optionally a new array of effects can be assigned. If no effects are passed, the current effects are re-applied.

  Parameters

  • Optional effects: AudioNode[]

    An array of AudioNode effects to apply

  Returns void