Difference between revisions of "API Sound.Create"

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|Create]]
 
:[[API Sound|Create]]
 
</div>
 
</div>
Line 9: Line 10:
  
 
==Parameters==
 
==Parameters==
''[[Variable types|ULONG]] SampleRate''
+
[[Variable types|ULONG]] ''SampleRate''
 
:The number of samples per second
 
:The number of samples per second
 
:''The default value for this parameter is: '''''44100'''
 
:''The default value for this parameter is: '''''44100'''
  
''[[Variable types|BYTE]] SampleBits''
+
[[Variable types|BYTE]] ''SampleBits''
 
:The number of bits per sample - either 8 or 16
 
:The number of bits per sample - either 8 or 16
 
:''The default value for this parameter is: '''''8'''
 
:''The default value for this parameter is: '''''8'''
  
''[[Variable types|BOOL]] Stereo''
+
[[Variable types|BOOL]] ''Stereo''
 
:True to treat each pair of samples as a stereo sample
 
:True to treat each pair of samples as a stereo sample
 
:''The default value for this parameter is: '''''0'''
 
:''The default value for this parameter is: '''''0'''
Line 24: Line 25:
 
[[Variable types|HANDLE]]
 
[[Variable types|HANDLE]]
  
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 33: Line 37:
 
* Declare a variable 'result' of type HANDLE
 
* Declare a variable 'result' of type HANDLE
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.Create(samplerate, samplebits, false)</pre>
 
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.Create(samplerate, samplebits, false)</pre>
 +
 +
''<span style="color:red;">No additional information</span>''

Revision as of 22:09, 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)

No additional information