Class AudioEngine
Hierarchy
- AudioEngine
Implements
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
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
-
Optional audioContext: Nullable<AudioContext>
defines the audio context to be used by the audio engine
-
Optional audioDestination: Nullable<AudioDestinationNode | MediaStreamAudioDestinationNode>
defines the audio destination node to be used by audio engine
Returns AudioEngine
-
Properties
Warned
Defines if Babylon should emit a warning if WebAudio is not supported.
can
Gets whether the current host supports Web Audio and thus could create AudioContexts.
isMP3supportedSearch playground for isMP3supported
Gets whether or not mp3 are supported by your browser.
isOGGsupportedSearch playground for isOGGsupported
Gets whether or not ogg are supported by your browser.
master
The master gain node defines the global audio volume of your audio engine.
on
Event raised when audio has been locked on the browser.
on
Event raised when audio has been unlocked on the browser.
unlockedSearch playground for unlocked
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.
use
Defines if the audio engine relies on a custom unlocked button. In this case, the embedded button will not be displayed.
Accessors
audio
-
Gets the current AudioContext if available.
Returns Nullable<AudioContext>
Methods
connect
-
Connect the audio engine to an audio analyser allowing some amazing synchronization 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
-
Destroy and release the resources associated with the audio context.
Returns void
get
-
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
-
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 the default audio engine used in babylon. It is responsible to play, synchronize and analyse sounds throughout the application.
https://doc.babylonjs.com/how_to/playing_sounds_and_music