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===
+
===Class hierarchy===[[API |API ]]
:Sound
+
:[[API Sound|Sound]]
 
::LoadWav
 
::LoadWav
 
</div>
 
</div>

Revision as of 21:17, 11 May 2013

<sidebar>API contents</sidebar> Queues a sound for playing, with the format provided

===Class hierarchy===API

Sound
LoadWav

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

BOOL

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)