Difference between revisions of "love.audio.newSource"

m (1 revision: Imported docs from potato.)
Line 1: Line 1:
  
 
+
Creates a new Source from a file.
 +
Sources created from SoundData are always static.
 
== Function ==
 
== Function ==
 
=== Synopsis ===
 
=== Synopsis ===
Line 54: Line 55:
 
* [[parent::love.audio]]
 
* [[parent::love.audio]]
 
[[Category:Functions]]
 
[[Category:Functions]]
{{#set:Description=}}
+
{{#set:Description=Creates a new Source from a file.
 +
}}

Revision as of 16:17, 14 February 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.

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