Difference between revisions of "love.audio.newSource"

(Returns)
m (actually I'm pretty sure that creating a Source from SoundData is actually "static": see src/scripts/audio.lua)
Line 19: Line 19:
 
{{param|SoundData|data|The SoundData to create a Source from.}}
 
{{param|SoundData|data|The SoundData to create a Source from.}}
 
=== Returns ===
 
=== Returns ===
{{param|Source|source|A new Source that can play the specified audio. The SourceType of the returned audio is "stream".}}
+
{{param|Source|source|A new Source that can play the specified audio. The [[SourceType]] of the returned audio is "static".}}
  
 
== Function ==
 
== Function ==

Revision as of 01:47, 2 March 2010

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

Function

Synopsis

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

Arguments

string file
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 SoundData and create a Source

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

See Also