SoundOptions

Index

Properties

• bustCache
• duration
• loop
• paths
• playbackRate
• position
• volume

Properties

optionalbustCache

bustCache?: boolean

Optionally bust the cache on load

Default is false

optionalduration

duration?: number

Seconds?

By default unset, will play the natural length of the clip

optionalloop

loop?: boolean

Loop infinitely

paths

paths: string[]

@param

A list of audio sources (clip.wav, clip.mp3, clip.ogg) for this audio clip. This is done for browser compatibility.

optionalplaybackRate

playbackRate?: number

Multiplyer

By default 1

optionalposition

position?: number

Advance to a position in the audio clip

optionalvolume

volume?: number

[0-1] 0% to 100%

By default 1 (100%)