Class WeightedSound
Hierarchy
- WeightedSound
Index
Constructors
Properties
Accessors
Methods
Constructors
constructor
-
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
-
Properties
is
A Sound is currently paused.
is
A Sound is currently playing.
loopSearch playground for loop
When true a Sound will be selected and played when the current playing Sound completes.
Accessors
directional
-
The size of cone in degrees for a directional sound in which there will be no attenuation.
Returns number
-
The size of cone in degrees for a directional sound in which there will be no attenuation.
Parameters
-
value: number
Returns any
-
directional
-
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
-
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 any
-
volume
-
Playback volume.
Returns number
-
Playback volume.
Parameters
-
value: number
Returns any
-
Methods
pauseSearch playground for pause
-
Suspend playback
Returns void
playSearch playground for play
-
Start playback.
Parameters
-
Optional startOffset: number
Position the clip head at a specific time in seconds.
Returns void
-
stopSearch playground for stop
-
Stop playback
Returns void
Wraps one or more Sound objects and selects one with random weight for playback.