API
API|
@babylonjs/core|
WeightedSound

Class WeightedSound

Wraps one or more Sound objects and selects one with random weight for playback.

Index
constructor
isPaused isPlaying loop
directionalConeInnerAngle directionalConeOuterAngle volume
pause play stop

  • Creates a new WeightedSound from the list of sounds given.

    Parameters

    • loop: boolean

      When true a Sound will be selected and played when the current playing Sound completes.

    • sounds: Sound[]

      Array of Sounds that will be selected from.

    • weights: number[]

      Array of number values for selection weights; length must equal sounds, values will be normalized to 1

    Returns WeightedSound

isPaused: boolean = false

A Sound is currently paused.

isPlaying: boolean = false

A Sound is currently playing.

loop: boolean = false

When true a Sound will be selected and played when the current playing Sound completes.

  • get directionalConeOuterAngle(): number

    Size of cone in degrees for a directional sound outside of which there will be no sound. Listener angles between innerAngle and outerAngle will falloff linearly.

    Returns number

  • set directionalConeOuterAngle(value: number): void

    Size of cone in degrees for a directional sound outside of which there will be no sound. Listener angles between innerAngle and outerAngle will falloff linearly.

    Parameters

    • value: number

    Returns void