• Public
  • Public/Protected
  • All

Interface IAudioEngine

This represents an audio engine and it is responsible to play, synchronize and analyse sounds throughout the application.




Implemented by



WarnedWebAudioUnsupportedSearch playground for WarnedWebAudioUnsupported

WarnedWebAudioUnsupported: boolean

Defines if Babylon should emit a warning if WebAudio is not supported.


Readonly audioContextSearch playground for audioContext

audioContext: Nullable<AudioContext>

Gets the current AudioContext if available.

Readonly canUseWebAudioSearch playground for canUseWebAudio

canUseWebAudio: boolean

Gets whether the current host supports Web Audio and thus could create AudioContexts.

Readonly isMP3supportedSearch playground for isMP3supported

isMP3supported: boolean

Gets whether or not mp3 are supported by your browser.

Readonly isOGGsupportedSearch playground for isOGGsupported

isOGGsupported: boolean

Gets whether or not ogg are supported by your browser.

Readonly masterGainSearch playground for masterGain

masterGain: GainNode

The master gain node defines the global audio volume of your audio engine.

onAudioLockedObservableSearch playground for onAudioLockedObservable

onAudioLockedObservable: Observable<IAudioEngine>

Event raised when audio has been locked on the browser.

onAudioUnlockedObservableSearch playground for onAudioUnlockedObservable

onAudioUnlockedObservable: Observable<IAudioEngine>

Event raised when audio has been unlocked on the browser.

Readonly unlockedSearch playground for unlocked

unlocked: boolean

Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).

useCustomUnlockedButtonSearch playground for useCustomUnlockedButton

useCustomUnlockedButton: boolean

Defines if the audio engine relies on a custom unlocked button. In this case, the embedded button will not be displayed.


connectToAnalyserSearch playground for connectToAnalyser

  • connectToAnalyser(analyser: Analyser): void

disposeSearch playground for dispose

  • dispose(): void
  • Releases all held resources

    Returns void

getGlobalVolumeSearch playground for getGlobalVolume

  • getGlobalVolume(): number
  • Gets the global volume sets on the master gain.

    Returns number

    the global volume if set or -1 otherwise

lockSearch playground for lock

  • lock(): void
  • Flags the audio engine in Locked state. This happens due to new browser policies preventing audio to autoplay.

    Returns void

setGlobalVolumeSearch playground for setGlobalVolume

  • setGlobalVolume(newVolume: number): void
  • Sets the global volume of your experience (sets on the master gain).


    • newVolume: number

      Defines the new global volume of the application

    Returns void

unlockSearch playground for unlock

  • unlock(): void
  • Unlocks the audio engine once a user action has been done on the dom. This is helpful to resume play once browser policies have been satisfied.

    Returns void


  • Constructor
  • Property
  • Method
  • Property
  • Method
  • Inherited property
  • Inherited method
  • Static property
  • Static method