AudioEngine

This represents the default audio engine used in babylon. It is responsible to play, synchronize and analyse sounds throughout the application.

see

http://doc.babylonjs.com/how_to/playing_sounds_and_music

Hierarchy

  • AudioEngine

Implements

Index

Constructors

constructor

Find examples in Playground
  • Instantiates a new audio engine.

    There should be only one per page as some browsers restrict the number of audio contexts you can create.

    Parameters

    • Optional hostElement: Nullable<HTMLElement>

      defines the host element where to display the mute icon if necessary

    Returns AudioEngine

Properties

WarnedWebAudioUnsupported

Find examples in Playground
WarnedWebAudioUnsupported: boolean

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

ignorenaming

audioContext

Find examples in Playground
audioContext: Nullable<AudioContext>

Gets the current AudioContext if available.

canUseWebAudio

Find examples in Playground
canUseWebAudio: boolean

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

isMP3supported

Find examples in Playground
isMP3supported: boolean

Gets whether or not mp3 are supported by your browser.

isOGGsupported

Find examples in Playground
isOGGsupported: boolean

Gets whether or not ogg are supported by your browser.

masterGain

Find examples in Playground
masterGain: GainNode

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

onAudioLockedObservable

Find examples in Playground
onAudioLockedObservable: Observable<AudioEngine>

Event raised when audio has been locked on the browser.

onAudioUnlockedObservable

Find examples in Playground
onAudioUnlockedObservable: Observable<AudioEngine>

Event raised when audio has been unlocked on the browser.

unlocked

Find examples in Playground
unlocked: boolean

Gets whether audio has been unlocked on the device. Some Browsers have strong restrictions about Audio and won t autoplay unless a user interaction has happened.

useCustomUnlockedButton

Find examples in Playground
useCustomUnlockedButton: boolean

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

Methods

connectToAnalyser

Find examples in Playground
  • connectToAnalyser(analyser: Analyser): void

dispose

Find examples in Playground
  • dispose(): void
  • Destroy and release the resources associated with the audio ccontext.

    Returns void

getGlobalVolume

Find examples in Playground
  • getGlobalVolume(): number
  • Gets the global volume sets on the master gain.

    Returns number

    the global volume if set or -1 otherwise

lock

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

    Returns void

setGlobalVolume

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

    Parameters

    • newVolume: number

      Defines the new global volume of the application

    Returns void

unlock

Find examples in Playground
  • 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

Generated using TypeDoc