API Sound.GetRate: Difference between revisions

Latest revision as of 13:17, 13 July 2026

	GetRate
Gets the current sample rate for the sound
- HANDLE	Sounds
The handle of the sound object to read
- ULONG	Return

The base sample is specified in creation through Sound.Create. This may be altered through Sound.SetRate or software conversion can be done through Sound.Queue or Sound.QueueEx.

@@ Line 1: / Line 1: @@
-<sidebar>API Contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Gets the current sample rate for the sound
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-<div style="width:25%; float:right" class="toc">
+| width="90%" class="mtx-class-macrohead" | '''GetRate'''
-====Class hierarchy====
+|-
-[[API Sound|Sound]]
+| colspan="2" | Gets the current sample rate for the sound&nbsp;
-:[[API Sound|GetRate]]
+|-
-</div>
+|-
-__TOC__
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Sounds
-==Parameters==
+|-
-[[Variable Types|HANDLE]] ''Sounds''
+| colspan="2" | The handle of the sound object to read&nbsp;
-:The handle of the sound object to read
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u32-icon.png]] - ULONG
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
-==Return value==
+|}
-[[Variable Types|ULONG]]
-Returns the current sample rate for the sound
@@ Line 28: / Line 25: @@
 * Declare a variable 'result' of type ULONG
 * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.GetRate(sounds)</pre>
-''<span style="color:red;">No additional examples</span>''