API Sound.Create: Difference between revisions

Latest revision as of 13:17, 13 July 2026

	Create
Creates a sound object that data can be played through
- ULONG	SampleRate
The number of samples per second
- BYTE	SampleBits
The number of bits per sample - either 8 or 16
- BOOL	Stereo
True to treat each pair of samples as a stereo sample
- HANDLE	Return

Detailed description

Sounds can only be played directly through the Sound.Play call or through a handle to a sound channel. Sounds played through a handle can be queued and played in sequence, allowing multiple sounds to be played seamlessly.

Sounds can be queued on an event, Sound.Complete, which is a notification that any sound played through this mechanism has finished.

The parameters used here will define the basics of the sound and are used to define the underlying system. Any sounds played have their values adjusted by Flowcode to conform to these values - a sound played which has a native sample rate and details matching the parameters of this call will in general be more efficient and clearer than a sound where the sample rate has to be adjusted to fit.

Examples

Calling in a calculation

Declare a variable 'result' of type HANDLE

Add to a calculation icon:

result = ::Sound.Create(samplerate, samplebits, false)

@@ Line 1: / Line 1: @@
+{| class="mtx-class-macrotable wikitable"
+|-
-<sidebar>API contents</sidebar>
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-Creates a sound object that data can be played through
+| width="90%" class="mtx-class-macrohead" | '''Create'''
+|-
-<div style="width:25%; float:right" class="toc">
+| colspan="2" | Creates a sound object that data can be played through&nbsp;
-====Class hierarchy====
+|-
-[[API Sound|Sound]]
+|-
-:[[API Sound|Create]]
+| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
-</div>
+| width="90%" | SampleRate
-__TOC__
+|-
+| colspan="2" | The number of samples per second&nbsp;
-==Parameters==
+|-
-[[Variable Types|ULONG]] ''SampleRate''
+| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
-:The number of samples per second
+| width="90%" | SampleBits
-:''The default value for this parameter is: '''''44100'''
+|-
+| colspan="2" | The number of bits per sample - either 8 or 16&nbsp;
-[[Variable Types|BYTE]] ''SampleBits''
+|-
-:The number of bits per sample - either 8 or 16
+| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
-:''The default value for this parameter is: '''''8'''
+| width="90%" | Stereo
+|-
-[[Variable Types|BOOL]] ''Stereo''
+| colspan="2" | True to treat each pair of samples as a stereo sample&nbsp;
-:True to treat each pair of samples as a stereo sample
+|-
-:''The default value for this parameter is: '''''0'''
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-==Return value==
-[[Variable Types|HANDLE]]
-A handle to an object suitable for playing sounds through
@@ Line 45: / Line 41: @@
 * Declare a variable 'result' of type HANDLE
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.Create(samplerate, samplebits, false)</pre>
-''<span style="color:red;">No additional examples</span>''

SteveT (talk | contribs)

Latest revision as of 13:17, 13 July 2026

Detailed description

Examples

Calling in a calculation