Class Sound

constructor

• new Sound(
      name: string,
      urlOrArrayBuffer: any,
      scene?: Nullable<Scene>,
      readyToPlayCallback?: Nullable<() => void>,
      options?: ISoundOptions,
  ): Sound

  Create a sound and attach it to a scene

  Parameters

  • name: string

    Name of your sound

  • urlOrArrayBuffer: any

    Url to the sound to load async or ArrayBuffer, it also works with MediaStreams and AudioBuffers

  • Optionalscene: Nullable<Scene>

    defines the scene the sound belongs to

  • readyToPlayCallback: Nullable<() => void> = null

    Provide a callback function if you'd like to load your code once the sound is ready to be played

  • Optionaloptions: ISoundOptions

    Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming

  Returns Sound

metadata

onEndedObservable

refDistance

rolloffFactor

soundTrackId

useCustomAttenuation

autoplay

• get autoplay(): boolean

  Does the sound autoplay once loaded.

  Returns boolean

• set autoplay(value: boolean): void

  Parameters

  • value: boolean

  Returns void

currentTime

• get currentTime(): number

  Gets the current time for the sound.

  Returns number

directionalConeInnerAngle

• get directionalConeInnerAngle(): number

  Gets or sets the inner angle for the directional cone.

  Returns number

• set directionalConeInnerAngle(value: number): void

  Gets or sets the inner angle for the directional cone.

  Parameters

  • value: number

  Returns void

directionalConeOuterAngle

• get directionalConeOuterAngle(): number

  Gets or sets the outer angle for the directional cone.

  Returns number

• set directionalConeOuterAngle(value: number): void

  Gets or sets the outer angle for the directional cone.

  Parameters

  • value: number

  Returns void

distanceModel

• get distanceModel(): "linear" | "inverse" | "exponential"

  Define the distance attenuation model the sound will follow.

  Returns "linear" | "inverse" | "exponential"

  See

  https://doc.babylonjs.com/legacy/audio#creating-a-spatial-3d-sound

• set distanceModel(value: "linear" | "inverse" | "exponential"): void

  Parameters

  • value: "linear" | "inverse" | "exponential"

  Returns void

isPaused

• get isPaused(): boolean

  Is this sound currently paused.

  Returns boolean

isPlaying

• get isPlaying(): boolean

  Is this sound currently played.

  Returns boolean

loop

• get loop(): boolean

  Does the sound loop after it finishes playing once.

  Returns boolean

• set loop(value: boolean): void

  Parameters

  • value: boolean

  Returns void

maxDistance

• get maxDistance(): number

  Define the max distance the sound should be heard (intensity just became 0 at this point).

  Returns number

  See

  https://doc.babylonjs.com/legacy/audio#creating-a-spatial-3d-sound

• set maxDistance(value: number): void

  Parameters

  • value: number

  Returns void

name

• get name(): string

  The name of the sound in the scene.

  Returns string

• set name(value: string): void

  Parameters

  • value: string

  Returns void

spatialSound

• get spatialSound(): boolean

  Does this sound enables spatial sound.

  Returns boolean

  See

  https://doc.babylonjs.com/legacy/audio#creating-a-spatial-3d-sound

• set spatialSound(newValue: boolean): void

  Does this sound enables spatial sound.

  Parameters

  • newValue: boolean

  Returns void

  See

  https://doc.babylonjs.com/legacy/audio#creating-a-spatial-3d-sound

attachToMesh

• attachToMesh(transformNode: TransformNode): void

  Attach the sound to a dedicated mesh

  Parameters

  • transformNode: TransformNode

    The transform node to connect the sound with

  Returns void

  See

  https://doc.babylonjs.com/legacy/audio#attaching-a-sound-to-a-mesh

clone

• clone(): Nullable<Sound>

  Clone the current sound in the scene.

  Returns Nullable<Sound>

  the new sound clone

connectToSoundTrackAudioNode

• connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void

  Connect this sound to a sound track audio node like gain...

  Parameters

  • soundTrackAudioNode: AudioNode

    the sound track audio node to connect to

  Returns void

detachFromMesh

• detachFromMesh(): void

  Detach the sound from the previously attached mesh

  Returns void

  See

  https://doc.babylonjs.com/legacy/audio#attaching-a-sound-to-a-mesh

dispose

• dispose(): void

  Release the sound and its associated resources

  Returns void

getAudioBuffer

• getAudioBuffer(): Nullable<AudioBuffer>

  Gets the current underlying audio buffer containing the data

  Returns Nullable<AudioBuffer>

  the audio buffer

getClassName

• getClassName(): string

  Get the current class name.

  Returns string

  current class name

getPlaybackRate

• getPlaybackRate(): number

  Gets the sound play back rate.

  Returns number

  the play back rate of the sound

getSoundGain

• getSoundGain(): Nullable<GainNode>

  Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.

  Returns Nullable<GainNode>

  the gain node

getSoundSource

• getSoundSource(): Nullable<AudioBufferSourceNode>

  Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.

  Returns Nullable<AudioBufferSourceNode>

  the source node

getVolume

• getVolume(): number

  Gets the volume of the sound.

  Returns number

  the volume of the sound

isReady

• isReady(): boolean

  Gets if the sounds is ready to be played or not.

  Returns boolean

  true if ready, otherwise false

pause

• pause(): void

  Put the sound in pause

  Returns void

play

• play(time?: number, offset?: number, length?: number): void

  Play the sound

  Parameters

  • Optionaltime: number

    (optional) Start the sound after X seconds. Start immediately (0) by default.

  • Optionaloffset: number

    (optional) Start the sound at a specific time in seconds

  • Optionallength: number

    (optional) Sound duration (in seconds)

  Returns void

serialize

• serialize(): any

  Serializes the Sound in a JSON representation

  Returns any

  the JSON representation of the sound

setAttenuationFunction

• setAttenuationFunction(
      callback: (
          currentVolume: number,
          currentDistance: number,
          maxDistance: number,
          refDistance: number,
          rolloffFactor: number,
      ) => number,
  ): void

  Sets a new custom attenuation function for the sound.

  Parameters

  • callback: (
        currentVolume: number,
        currentDistance: number,
        maxDistance: number,
        refDistance: number,
        rolloffFactor: number,
    ) => number

    Defines the function used for the attenuation

  Returns void

  See

  https://doc.babylonjs.com/legacy/audio#creating-your-own-custom-attenuation-function

setAudioBuffer

• setAudioBuffer(audioBuffer: AudioBuffer): void

  Sets the data of the sound from an audiobuffer

  Parameters

  • audioBuffer: AudioBuffer

    The audioBuffer containing the data

  Returns void

setDirectionalCone

• setDirectionalCone(
      coneInnerAngle: number,
      coneOuterAngle: number,
      coneOuterGain: number,
  ): void

  Transform this sound into a directional source

  Parameters

  • coneInnerAngle: number

    Size of the inner cone in degree

  • coneOuterAngle: number

    Size of the outer cone in degree

  • coneOuterGain: number

    Volume of the sound outside the outer cone (between 0.0 and 1.0)

  Returns void

setLocalDirectionToMesh

• setLocalDirectionToMesh(newLocalDirection: Vector3): void

  Sets the local direction of the emitter if spatial sound is enabled

  Parameters

  • newLocalDirection: Vector3

    Defines the new local direction

  Returns void

setPlaybackRate

• setPlaybackRate(newPlaybackRate: number): void

  Set the sound play back rate

  Parameters

  • newPlaybackRate: number

    Define the playback rate the sound should be played at

  Returns void

setPosition

• setPosition(newPosition: Vector3): void

  Sets the position of the emitter if spatial sound is enabled

  Parameters

  • newPosition: Vector3

    Defines the new position

  Returns void

setVolume

• setVolume(newVolume: number, time?: number): void

  Sets a dedicated volume for this sounds

  Parameters

  • newVolume: number

    Define the new volume of the sound

  • Optionaltime: number

    Define time for gradual change to new volume

  Returns void

stop

• stop(time?: number): void

  Stop the sound

  Parameters

  • Optionaltime: number

    (optional) Stop the sound after X seconds. Stop immediately (0) by default.

  Returns void

switchPanningModelToEqualPower

• switchPanningModelToEqualPower(): void

  Switch the panning model to Equal Power: Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.

  Returns void

  See

  https://doc.babylonjs.com/legacy/audio#creating-a-spatial-3d-sound

switchPanningModelToHRTF

• switchPanningModelToHRTF(): void

  Switch the panning model to HRTF: Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.

  Returns void

  See

  https://doc.babylonjs.com/legacy/audio#creating-a-spatial-3d-sound

updateOptions

• updateOptions(options: ISoundOptions): void

  Updates the current sounds options such as maxdistance, loop...

  Parameters

  • options: ISoundOptions

    A JSON object containing values named as the object properties

  Returns void

StaticParse

• Parse(
      parsedSound: any,
      scene: Scene,
      rootUrl: string,
      sourceSound?: Sound,
  ): Sound

  Parse a JSON representation of a sound to instantiate in a given scene

  Parameters

  • parsedSound: any

    Define the JSON representation of the sound (usually coming from the serialize method)

  • scene: Scene

    Define the scene the new parsed sound should be created in

  • rootUrl: string

    Define the rooturl of the load in case we need to fetch relative dependencies

  • OptionalsourceSound: Sound

    Define a sound place holder if do not need to instantiate a new one

  Returns Sound

  the newly parsed sound