Difference between revisions of "API Sound.Create"

From Flowcode Help
Jump to navigationJump to search
(XML import API changes)
(XML Import to change Variable types into Variable Types)
Line 10: 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 24:
  
 
==Return value==
 
==Return value==
[[Variable types|HANDLE]]
+
[[Variable Types|HANDLE]]
  
 
''<span style="color:red;">No additional information</span>''
 
''<span style="color:red;">No additional information</span>''

Revision as of 11:09, 10 June 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