Sound object

Property Description Access Type
Sound.position Get/set the sound position in the world readwrite table
Sound.direction Get/set the sound direction in the world readwrite table
Sound.cone Get/set the sound cone readwrite table
Sound.velocity Get/set the sound velocity readwrite number
Sound.rolloff Get/set the sound rolloff readwrite number
Sound.maxdistance Get/set the sound maximum distance for attenuation calculation readwrite number
Sound.mindistance Get/set the sound minimum distance for attenuation calculation readwrite number
Sound.doppler Get/set the sound doppler factor readwrite number
Sound.maxgain Get/set the sound maximum gain from spatialization readwrite number
Sound.mingain Get/set the sound minimum gain from spatialization readwrite number
Sound.volume Get/set the sound volume readwrite number
Sound.loop Get/set the sound looping mode readwrite boolean
Sound.pan Get/set the sound pan readwrite number
Sound.pitch Get/set the sound pitch readwrite number
Sound.cursor Get/set the current sound cursor position readwrite number
Sound.ended Check if the sound has ended readonly boolean
Sound.playing Check if the sound is playing readonly number
Sound.duration Get the sound length in seconds readonly number
Method Description Return value
Sound.constructor() Sound object constructor Sound
Sound.play() Play the sound -
Sound.stop() Stop playing the sound -
Sound.seek() Seek sound to time position -
Sound.fade() Fade the sound -
Sound.echo() Apply an echo effect to the sound -
Sound.reverb() Apply a reverb effect to the sound -