audio module

Core framework Console Desktop

The audio module plays and records audio using any audio device

Property Description Access Type
audio.channels Get the current device number of channels readonly number
audio.cone Get/set the listener cone readwrite table
audio.devices Get the list of detected audio devices readonly table
audio.direction Get/set the listener direction in the world readwrite table
audio.gain Get/set the master gain readwrite number
audio.playdevice Get/set the current audio playing device readwrite string
audio.position Get/set the listener position in the world readwrite table
audio.recdevice Get/set the current audio recording device readwrite string
audio.samplerate Get the current device sample rate readonly number
audio.velocity Get/set the listener velocity readwrite table
audio.volume Get/set the master volume readwrite number
audio.worldup Get/set the listener worldup direction readwrite table
Functions Description Return value
audio.play() Play a sound boolean
audio.record.start() Start audio recording session boolean
audio.record.stop() Stop current audio recording session -
Object Description
Sound Object representation of a sound