Difference between revisions of "love.audio.newSource"

m (Noted in description that you can also use SoundData and Decoder.)
Line 5: Line 5:
 
=== Synopsis ===
 
=== Synopsis ===
 
<source lang="lua">
 
<source lang="lua">
source = love.audio.newSource( file, type )
+
source = love.audio.newSource( filename, type )
 
</source>
 
</source>
 
=== Arguments ===
 
=== Arguments ===
{{param|string|file|The file to create a Source from.}}
+
{{param|string|filename|The file to create a Source from.}}
 
{{param|SourceType|type|Streaming or static source.}}
 
{{param|SourceType|type|Streaming or static source.}}
 
=== Returns ===
 
=== Returns ===

Revision as of 16:53, 4 October 2012

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

O.png 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

Synopsis

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

Arguments

string filename
The file 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

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.

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)

See Also


Other Languages