Difference between revisions of "API Sound.Create"

From Flowcode Help
Jump to navigationJump to search
(XML import of API auto-gen)
(XML import)
Line 2: Line 2:
 
Creates a sound object that data can be played through
 
Creates a sound object that data can be played through
  
 +
<div style="width:25%; float:right" class="toc">
 +
===Class hierarchy===
 +
:Sound
 +
::Create
 +
</div>
 +
__TOC__
  
===Parameters===
+
==Parameters==
 
''[[Variable types|ULONG]] SampleRate''
 
''[[Variable types|ULONG]] SampleRate''
 
:The number of samples per second
 
:The number of samples per second
Line 16: Line 22:
 
:''The default value for this parameter is: '''''0'''
 
:''The default value for this parameter is: '''''0'''
  
===Return value===
+
==Return value==
 
[[Variable types|HANDLE]]
 
[[Variable types|HANDLE]]
  
 
No additional information
 
No additional information
  
===Detailed description===
+
==Detailed description==
 
''No additional information''
 
''No additional information''
  
===Examples===
+
==Examples==
====Calling in a calculation====
+
===Calling in a calculation===
 
* Declare a variable 'result' of type HANDLE
 
* Declare a variable 'result' of type HANDLE
* Add to a calculation icon: <pre class="brush:[C]">result = ::Sound.Create(samplerate, samplebits, false)</pre>
+
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.Create(samplerate, samplebits, false)</pre>

Revision as of 16:47, 11 May 2013

<sidebar>API contents</sidebar> Creates a sound object that data can be played through

Class hierarchy

Sound
Create

Parameters

ULONG SampleRate

The number of samples per second
The default value for this parameter is: 44100

BYTE SampleBits

The number of bits per sample - either 8 or 16
The default value for this parameter is: 8

BOOL Stereo

True to treat each pair of samples as a stereo sample
The default value for this parameter is: 0

Return value

HANDLE

No additional information

Detailed description

No additional information

Examples

Calling in a calculation

  • Declare a variable 'result' of type HANDLE
  • Add to a calculation icon:
    result = ::Sound.Create(samplerate, samplebits, false)