Difference between revisions of "love.audio.newSource"
(add type argument to FileData variant) |
(reflect changes in love 11.0) |
||
| Line 4: | Line 4: | ||
== Function == | == Function == | ||
| + | {{newin|[[0.10.0]]|100|type=variant}} | ||
=== Synopsis === | === Synopsis === | ||
<source lang="lua"> | <source lang="lua"> | ||
| Line 10: | Line 11: | ||
=== Arguments === | === Arguments === | ||
{{param|string|filename|The filepath to the audio file.}} | {{param|string|filename|The filepath to the audio file.}} | ||
| − | {{param|SourceType|type | + | {{param|SourceType|type|Streaming or static source.}} |
=== Returns === | === Returns === | ||
{{param|Source|source|A new Source that can play the specified audio.}} | {{param|Source|source|A new Source that can play the specified audio.}} | ||
| + | |||
== Function == | == Function == | ||
| + | {{newin|[[0.10.0]]|100|type=variant}} | ||
=== Synopsis === | === Synopsis === | ||
<source lang="lua"> | <source lang="lua"> | ||
| Line 20: | Line 23: | ||
=== Arguments === | === Arguments === | ||
{{param|File|file|A File pointing to an audio file.}} | {{param|File|file|A File pointing to an audio file.}} | ||
| − | {{param|SourceType|type | + | {{param|SourceType|type|Streaming or static source.}} |
=== Returns === | === Returns === | ||
{{param|Source|source|A new Source that can play the specified audio.}} | {{param|Source|source|A new Source that can play the specified audio.}} | ||
| + | |||
== Function == | == Function == | ||
| + | {{newin|[[0.10.0]]|100|type=variant}} | ||
=== Synopsis === | === Synopsis === | ||
<source lang="lua"> | <source lang="lua"> | ||
| Line 30: | Line 35: | ||
=== Arguments === | === Arguments === | ||
{{param|Decoder|decoder|The Decoder to create a Source from.}} | {{param|Decoder|decoder|The Decoder to create a Source from.}} | ||
| − | {{param|SourceType|type | + | {{param|SourceType|type|Streaming or static source.}} |
| + | === Returns === | ||
| + | {{param|Source|source|A new Source that can play the specified audio.}} | ||
| + | |||
| + | == Function == | ||
| + | {{newin|[[0.10.0]]|100|type=variant}} | ||
| + | === Synopsis === | ||
| + | <source lang="lua"> | ||
| + | source = love.audio.newSource( data, type ) | ||
| + | </source> | ||
| + | === Arguments === | ||
| + | {{param|FileData|data|The FileData to create a Source from.}} | ||
| + | {{param|SourceType|type|Streaming or static source.}} | ||
=== Returns === | === Returns === | ||
{{param|Source|source|A new Source that can play the specified audio.}} | {{param|Source|source|A new Source that can play the specified audio.}} | ||
| + | |||
== Function == | == Function == | ||
=== Synopsis === | === Synopsis === | ||
| Line 42: | Line 60: | ||
=== 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 == | ||
| + | {{oldin|[[0.10.0]]|100|type=variant}} | ||
| + | === Synopsis === | ||
| + | <source lang="lua"> | ||
| + | source = love.audio.newSource( filename, type ) | ||
| + | </source> | ||
| + | === Arguments === | ||
| + | {{param|string|filename|The filepath to the audio file.}} | ||
| + | {{param|SourceType|type ("stream")|Streaming or static source.}} | ||
| + | === Returns === | ||
| + | {{param|Source|source|A new Source that can play the specified audio.}} | ||
| + | |||
| + | == Function == | ||
| + | {{oldin|[[0.10.0]]|100|type=variant}} | ||
| + | === 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 ("stream")|Streaming or static source.}} | ||
| + | === Returns === | ||
| + | {{param|Source|source|A new Source that can play the specified audio.}} | ||
| + | |||
| + | == Function == | ||
| + | {{oldin|[[0.10.0]]|100|type=variant}} | ||
| + | === Synopsis === | ||
| + | <source lang="lua"> | ||
| + | source = love.audio.newSource( decoder, type ) | ||
| + | </source> | ||
| + | === Arguments === | ||
| + | {{param|Decoder|decoder|The Decoder to create a Source from.}} | ||
| + | {{param|SourceType|type ("stream")|Streaming or static source.}} | ||
| + | === Returns === | ||
| + | {{param|Source|source|A new Source that can play the specified audio.}} | ||
| + | |||
== Function == | == Function == | ||
| + | {{oldin|[[0.10.0]]|100|type=variant}} | ||
=== Synopsis === | === Synopsis === | ||
<source lang="lua"> | <source lang="lua"> | ||
| Line 72: | Line 128: | ||
<source lang="lua"> | <source lang="lua"> | ||
decoder = love.sound.newDecoder("bgm.ogg") | decoder = love.sound.newDecoder("bgm.ogg") | ||
| − | bgm = love.audio.newSource(decoder) | + | bgm = love.audio.newSource(decoder, "stream") |
</source> | </source> | ||
== See Also == | == See Also == | ||
Revision as of 05:06, 2 April 2018
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! |
Contents
Function
| Available since LÖVE 0.10.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 0.10.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 0.10.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 0.10.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 0.10.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 0.10.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 0.10.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 0.10.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.
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
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
