lovr.audio.newSource

Creates a new Source from an ogg, wav, or mp3 file, a Sound, or an AudioStream.

source = lovr.audio.newSource(file, options)
source = lovr.audio.newSource(sound, options)
source = lovr.audio.newSource(stream, options)

Name	Type	Default	Description
file	string \| Blob		A filename or Blob containing audio data to load.
options	table	nil	Optional options.
.decode	boolean	false	Whether to immediately decode compressed sounds, instead of progressively decoding as the Source plays. Enabling this will use more memory but reduce CPU overhead during playback. Recommended for short sound effects.
.spatial	boolean	false	Whether the Source should use spatial effects. Non-spatial sources will get routed directly to the speakers without further processing.
.pitchable	boolean	true	Whether the pitch of the Source can be changed with `Source:setPitch`. Setting this to false will improve performance slightly.

Name	Type	Description
source	Source	The new Source.

Name	Type	Default	Description
sound	Sound		The Sound containing audio to play.
options	table	nil	Optional options.
.decode	boolean	false	Whether to immediately decode compressed sounds, instead of progressively decoding as the Source plays. Enabling this will use more memory but reduce CPU overhead during playback. Recommended for short sound effects.
.spatial	boolean	false	Whether the Source should use spatial effects. Non-spatial sources will get routed directly to the speakers without further processing.
.pitchable	boolean	true	Whether the pitch of the Source can be changed with `Source:setPitch`. Setting this to false will improve performance slightly.

Name	Type	Description
source	Source	The new Source.

Name	Type	Default	Description
stream	Sound		The AudioStream containing audio to play.
options	table	nil	Optional options.
.decode	boolean	false	Whether to immediately decode compressed sounds, instead of progressively decoding as the Source plays. Enabling this will use more memory but reduce CPU overhead during playback. Recommended for short sound effects.
.spatial	boolean	false	Whether the Source should use spatial effects. Non-spatial sources will get routed directly to the speakers without further processing.
.pitchable	boolean	true	Whether the pitch of the Source can be changed with `Source:setPitch`. Setting this to false will improve performance slightly.

Name	Type	Description
source	Source	The new Source.

Example

function lovr.load()
  sandstorm = lovr.audio.newSource('darude.ogg', { decode = false })
  sandstorm:play()
end