Difference between revisions of "love.audio.newSource"
| Line 1: | Line 1: | ||
| − | Creates a new [[Source]] from a file, [[SoundData]], or [[Decoder]]. | + | Creates a new [[Source]] from a filepath, file, [[SoundData]], or [[Decoder]]. |
Sources created from SoundData are always static. | Sources created from SoundData are always static. | ||
{{newobjectnotice}} | {{newobjectnotice}} | ||
| Line 8: | Line 8: | ||
</source> | </source> | ||
=== Arguments === | === Arguments === | ||
| − | {{param|string|filename|The file to | + | {{param|string|filename|The filepath to the audio file.}} |
| + | {{param|SourceType|type|Streaming or static source.}} | ||
| + | === Returns === | ||
| + | {{param|Source|source|A new Source that can play the specified audio.}} | ||
| + | == Function == | ||
| + | === Synopsis === | ||
| + | <source lang="lua"> | ||
| + | source = love.audio.newSource( file, type ) | ||
| + | </source> | ||
| + | === Arguments === | ||
| + | {{param|File|file|A File pointing to an audio file.}} | ||
{{param|SourceType|type|Streaming or static source.}} | {{param|SourceType|type|Streaming or static source.}} | ||
=== Returns === | === Returns === | ||
| Line 21: | Line 31: | ||
=== Returns === | === Returns === | ||
{{param|Source|source|A new Source that can play the specified audio. The [[SourceType]] of the returned audio is "static".}} | {{param|Source|source|A new Source that can play the specified audio. The [[SourceType]] of the returned audio is "static".}} | ||
| − | |||
== Function == | == Function == | ||
=== Synopsis === | === Synopsis === | ||
Revision as of 17:05, 4 October 2012
Creates a new Source from a filepath, file, SoundData, or Decoder. 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
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
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
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
Dansk –
Deutsch –
English –
Español –
Français –
Indonesia –
Italiano –
Lietuviškai –
Magyar –
Nederlands –
Polski –
Português –
Română –
Slovenský –
Suomi –
Svenska –
Türkçe –
Česky –
Ελληνικά –
Български –
Русский –
Српски –
Українська –
עברית –
ไทย –
日本語 –
正體中文 –
简体中文 –
Tiếng Việt –
한국어
More info
