Difference between revisions of "API Sound.LoadWav"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
 
(XML import API auto-gen)
Line 1: Line 1:
 
wiki page name
 
wiki page name
==SoundLoadWav==
+
Queues a sound for playing, with the format provided
  
Queues a sound for playing, with the format provided
 
----
 
  
 
===Parameters===
 
===Parameters===
Line 33: Line 31:
  
 
===Examples===
 
===Examples===
====Calling in a calculation:====
+
====Calling in a calculation====
 
* Declare a variable 'result' of type BOOL
 
* Declare a variable 'result' of type BOOL
 
* Add to a calculation icon: result = ::Sound.LoadWav("filename", _arraybuffer, return_sampleformat, return_elements, return_samplerate)
 
* Add to a calculation icon: result = ::Sound.LoadWav("filename", _arraybuffer, return_sampleformat, return_elements, return_samplerate)

Revision as of 15:34, 10 May 2013

wiki page name Queues a sound for playing, with the format provided


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)