love.audio.newSource

Creates a new Source from a filepath, File, Decoder or SoundData. Sources created from SoundData are always static.

This function can be slow if it is called repeatedly, such as from love.update or love.draw. If you need to use a specific resource often, create it once and store it somewhere it can be reused!

Function

Available since LÖVE 11.0
This variant is not supported in earlier versions.

Synopsis

source = love.audio.newSource( filename, type )

Arguments

string filename

The filepath to the audio file.

SourceType type

Streaming or static source.

Returns

Source source

A new Source that can play the specified audio.

Function

Available since LÖVE 11.0
This variant is not supported in earlier versions.

Synopsis

source = love.audio.newSource( file, type )

Arguments

File file

A File pointing to an audio file.

SourceType type

Streaming or static source.

Returns

Source source

A new Source that can play the specified audio.

Function

Available since LÖVE 11.0
This variant is not supported in earlier versions.

Synopsis

source = love.audio.newSource( decoder, type )

Arguments

Decoder decoder

The Decoder to create a Source from.

SourceType type

Streaming or static source.

Returns

Source source

A new Source that can play the specified audio.

Function

Available since LÖVE 11.0
This variant is not supported in earlier versions.

Synopsis

source = love.audio.newSource( data, type )

Arguments

FileData data

The FileData to create a Source from.

SourceType type

Streaming or static source.

Returns

Source source

A new Source that can play the specified audio.

Function

Synopsis

source = love.audio.newSource( data )

Arguments

SoundData data

The SoundData to create a Source from.

Returns

Source source

A new Source that can play the specified audio. The SourceType of the returned audio is "static".

Function

Removed in LÖVE 11.0
This variant is not supported in that and later versions.

Synopsis

source = love.audio.newSource( filename, type )

Arguments

string filename

The filepath to the audio file.

SourceType type ("stream")

Streaming or static source.

Returns

Source source

A new Source that can play the specified audio.

Function

Removed in LÖVE 11.0
This variant is not supported in that and later versions.

Synopsis

source = love.audio.newSource( file, type )

Arguments

File file

A File pointing to an audio file.

SourceType type ("stream")

Streaming or static source.

Returns

Source source

A new Source that can play the specified audio.

Function

Removed in LÖVE 11.0
This variant is not supported in that and later versions.

Synopsis

source = love.audio.newSource( decoder, type )

Arguments

Decoder decoder

The Decoder to create a Source from.

SourceType type ("stream")

Streaming or static source.

Returns

Source source

A new Source that can play the specified audio.

Function

Removed in LÖVE 11.0
This variant is not supported in that and later versions.

Synopsis

source = love.audio.newSource( data, type )

Arguments

FileData data

The FileData to create a Source from.

SourceType type ("stream")

Streaming or static source.

Returns

Source source

A new Source that can play the specified audio.

Notes

From 11.0 onwards, if queue is specified as SourceType for this specific constructor, it won't error, and getType will return stream; this is a bug. One should use love.audio.newQueueableSource for that specific source type instead.

Examples

Load background music and play it

bgm = love.audio.newSource("bgm.ogg", "stream")
love.audio.play(bgm)

Load a sound effect and play it

sfx = love.audio.newSource("sfx.wav", "static")
love.audio.play(sfx)

Load SoundData and create a Source

data = love.sound.newSoundData("sfx.wav")
sfx = love.audio.newSource(data)

Load Decoder and create a Source

decoder = love.sound.newDecoder("bgm.ogg")
bgm = love.audio.newSource(decoder, "stream")

See Also

• love.audio
• Source