Difference between revisions of "API Sound.LoadWav"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| Line 3: | Line 3: | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
| − | ===Class hierarchy===[[API Sound|Sound]] | + | ====Class hierarchy==== |
| + | [[API Sound|Sound]] | ||
:[[API Sound|LoadWav]] | :[[API Sound|LoadWav]] | ||
</div> | </div> | ||
| Line 9: | Line 10: | ||
==Parameters== | ==Parameters== | ||
| − | + | [[Variable types|STRING]] ''Filename'' | |
:The formatted file to load into memory | :The formatted file to load into memory | ||
| − | + | [[Variable types|BYTE[]]] ''Buffer'' | |
:A buffer to write the wave data to | :A buffer to write the wave data to | ||
| − | + | [[Variable types|UINT]] ''SampleFormat'' | |
:''This parameter is returned back to the caller'' | :''This parameter is returned back to the caller'' | ||
:Variable to receive the format of the samples | :Variable to receive the format of the samples | ||
| − | + | [[Variable types|ULONG]] ''Elements'' | |
:''This parameter is returned back to the caller'' | :''This parameter is returned back to the caller'' | ||
:Variable to receive the number of sample elements to play | :Variable to receive the number of sample elements to play | ||
| − | + | [[Variable types|FLOAT]] ''SampleRate'' | |
:''This parameter is returned back to the caller'' | :''This parameter is returned back to the caller'' | ||
:Variable to receive the wave source sample rate | :Variable to receive the wave source sample rate | ||
| Line 30: | Line 31: | ||
[[Variable types|BOOL]] | [[Variable types|BOOL]] | ||
| − | No additional information | + | ''<span style="color:red;">No additional information</span>'' |
| + | |||
| + | |||
==Detailed description== | ==Detailed description== | ||
| − | ''No additional information'' | + | ''<span style="color:red;">No additional information</span>'' |
| + | |||
==Examples== | ==Examples== | ||
| Line 39: | Line 43: | ||
* Declare a variable 'result' of type BOOL | * Declare a variable 'result' of type BOOL | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.LoadWav("filename", _arraybuffer, return_sampleformat, return_elements, return_samplerate)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.LoadWav("filename", _arraybuffer, return_sampleformat, return_elements, return_samplerate)</pre> | ||
| + | |||
| + | ''<span style="color:red;">No additional information</span>'' | ||
Revision as of 22:09, 11 May 2013
<sidebar>API contents</sidebar> Queues a sound for playing, with the format provided
Contents
Parameters
STRING Filename
- The formatted file to load into memory
BYTE[] Buffer
- A buffer to write the wave data to
UINT SampleFormat
- This parameter is returned back to the caller
- Variable to receive the format of the samples
ULONG Elements
- This parameter is returned back to the caller
- Variable to receive the number of sample elements to play
FLOAT SampleRate
- This parameter is returned back to the caller
- Variable to receive the wave source sample rate
Return value
No additional information
Detailed description
No additional information
Examples
Calling in a calculation
- Declare a variable 'result' of type BOOL
- Add to a calculation icon:
result = ::Sound.LoadWav("filename", _arraybuffer, return_sampleformat, return_elements, return_samplerate)
No additional information
