Difference between revisions of "love.sound.newSoundData"
m |
|||
| Line 1: | Line 1: | ||
| − | Creates new SoundData from a [[Decoder]] | + | Creates new SoundData from a filepath, [[File]], or [[Decoder]]. It's also possible to create SoundData with a custom sample rate, channel and bit depth. |
The sound data will be decoded to the memory in a raw format. It is recommended to create only short sounds like effects, as a 3 minute song uses 30 MB of memory this way. | The sound data will be decoded to the memory in a raw format. It is recommended to create only short sounds like effects, as a 3 minute song uses 30 MB of memory this way. | ||
| Line 5: | Line 5: | ||
=== Synopsis === | === Synopsis === | ||
<source lang="lua"> | <source lang="lua"> | ||
| − | soundData = love.sound.newSoundData( | + | soundData = love.sound.newSoundData( filename ) |
| + | </source> | ||
| + | === Arguments === | ||
| + | {{param|string|filename|The file name of the file to load.}} | ||
| + | === Returns === | ||
| + | {{param|SoundData|soundData|A new SoundData object.}} | ||
| + | == Function == | ||
| + | === Synopsis === | ||
| + | <source lang="lua"> | ||
| + | soundData = love.sound.newSoundData( file ) | ||
</source> | </source> | ||
=== Arguments === | === Arguments === | ||
| − | {{param| | + | {{param|File|file|A File pointing to an audio file.}} |
=== Returns === | === Returns === | ||
{{param|SoundData|soundData|A new SoundData object.}} | {{param|SoundData|soundData|A new SoundData object.}} | ||
| Line 14: | Line 23: | ||
=== Synopsis === | === Synopsis === | ||
<source lang="lua"> | <source lang="lua"> | ||
| − | soundData = love.sound.newSoundData( | + | soundData = love.sound.newSoundData( decoder ) |
</source> | </source> | ||
=== Arguments === | === Arguments === | ||
| − | {{param| | + | {{param|Decoder|decoder|Decode data from this Decoder until EOF.}} |
=== Returns === | === Returns === | ||
{{param|SoundData|soundData|A new SoundData object.}} | {{param|SoundData|soundData|A new SoundData object.}} | ||
Revision as of 17:15, 4 October 2012
Creates new SoundData from a filepath, File, or Decoder. It's also possible to create SoundData with a custom sample rate, channel and bit depth.
The sound data will be decoded to the memory in a raw format. It is recommended to create only short sounds like effects, as a 3 minute song uses 30 MB of memory this way.
Contents
Function
Synopsis
soundData = love.sound.newSoundData( filename )
Arguments
string filename- The file name of the file to load.
Returns
SoundData soundData- A new SoundData object.
Function
Synopsis
soundData = love.sound.newSoundData( file )
Arguments
File file- A File pointing to an audio file.
Returns
SoundData soundData- A new SoundData object.
Function
Synopsis
soundData = love.sound.newSoundData( decoder )
Arguments
Decoder decoder- Decode data from this Decoder until EOF.
Returns
SoundData soundData- A new SoundData object.
Function
Synopsis
soundData = love.sound.newSoundData( samples, rate, bits, channels )
Arguments
number samples- Total number of samples.
number rate (44100)- Number of samples per second
number bits (16)- Bits per sample (8 or 16).
number channels (2)- Either 1 for mono or 2 for stereo.
Returns
SoundData soundData- A new SoundData object.
Examples
Loading SoundData from files
wav = love.sound.newSoundData("doom.wav")
-- Beware: if doom.mp3 is a huge file, it will take
-- ages to decode.
mp3 = love.sound.newSoundData("doom.mp3")
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
