Interface IAudioEngine
Hierarchy
-
IDisposable
- IAudioEngine
Implemented by
Index
Properties
Warned Web Audio UnsupportedSearch playground for WarnedWebAudioUnsupported
Defines if Babylon should emit a warning if WebAudio is not supported.
Readonly audio ContextSearch playground for audioContext
Gets the current AudioContext if available.
Readonly can Use Web AudioSearch playground for canUseWebAudio
Gets whether the current host supports Web Audio and thus could create AudioContexts.
Readonly isMP3supportedSearch playground for isMP3supported
Gets whether or not mp3 are supported by your browser.
Readonly isOGGsupportedSearch playground for isOGGsupported
Gets whether or not ogg are supported by your browser.
Readonly master GainSearch playground for masterGain
The master gain node defines the global audio volume of your audio engine.
on Audio Locked ObservableSearch playground for onAudioLockedObservable
Event raised when audio has been locked on the browser.
on Audio Unlocked ObservableSearch playground for onAudioUnlockedObservable
Event raised when audio has been unlocked on the browser.
Readonly unlockedSearch playground for unlocked
Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
use Custom Unlocked ButtonSearch playground for useCustomUnlockedButton
Defines if the audio engine relies on a custom unlocked button. In this case, the embedded button will not be displayed.
Methods
connect ToAnalyserSearch playground for connectToAnalyser
-
Connect the audio engine to an audio analyser allowing some amazing synchornization between the sounds/music and your visualization (VuMeter for instance).
Parameters
-
analyser: Analyser
The analyser to connect to the engine
Returns void
-
disposeSearch playground for dispose
-
Releases all held resources
Returns void
get Global VolumeSearch playground for getGlobalVolume
-
Gets the global volume sets on the master gain.
Returns number
the global volume if set or -1 otherwise
lockSearch playground for lock
-
Flags the audio engine in Locked state. This happens due to new browser policies preventing audio to autoplay.
Returns void
set Global VolumeSearch playground for setGlobalVolume
-
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
-
unlockSearch playground for unlock
-
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
This represents an audio engine and it is responsible to play, synchronize and analyse sounds throughout the application.
https://doc.babylonjs.com/how_to/playing_sounds_and_music