lovr.audio

The lovr.audio module is responsible for playing sound effects and music. Currently, the only supported audio format is .ogg (Vorbis). Playing a sound involves creating a Source object for the sound and calling Source:play on it.

Sources

Sources are objects that represent a single sound instance.

lovr.audio.newSource	Create a new Source.
lovr.audio.pause	Pause all Sources.
lovr.audio.resume	Resume all Sources.
lovr.audio.rewind	Rewind all Sources.
lovr.audio.stop	Stop all Sources.
lovr.audio.update	Updates the audio system.

Listener

The listener is a virtual object in 3D space that "hears" all the sounds that are playing. The listener can be positioned and oriented in 3D space, which controls how Sources in the world are heard. For example, sounds further away from the listener will be more quiet, and sounds to the left of the listener will be heard from the left speaker. By default, the listener will be synchronized with any connected headset so audio is positioned properly as the headset is moved around and rotated.

lovr.audio.getVelocity	Get the velocity of the audio listener.
lovr.audio.setVelocity	Set the velocity of the audio listener.
lovr.audio.getVolume	Get the master volume.
lovr.audio.setVolume	Set the master volume.
lovr.audio.getDopplerEffect	Get the doppler effect parameters.
lovr.audio.setDopplerEffect	Set the doppler effect parameters.
lovr.audio.getPose	Get the pose of the listener.
lovr.audio.setPose	Set the pose of the listener.
lovr.audio.getPosition	Get the position of the listener.
lovr.audio.setPosition	Set the position of the listener.
lovr.audio.isSpatialized	Check if audio is spatialized.
lovr.audio.getOrientation	Get the orientation of the listener.
lovr.audio.setOrientation	Set the orientation of the listener.

Microphones

Microphones can be used to receive audio input.

lovr.audio.getMicrophoneNames	Get the names of all connected microphones.
lovr.audio.newMicrophone	Create a new Microphone.