Difference between revisions of "API Sound.GetBits"

Latest revision as of 11:55, 16 January 2023

	GetBits
Gets the number of bits per sample for the sound
- HANDLE	Sounds
The handle of the sound object to read
- BYTE	Return

The bits per sample is specified in creation through Sound.Create.

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
-Gets the number of bits per sample for the sound
+|-
+| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetBits'''
+|-
+| colspan="2" | Gets the number of bits per sample for the sound&nbsp;
+|-
+|-
+| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
+| width="90%" | Sounds
+|-
+| colspan="2" | The handle of the sound object to read&nbsp;
+|-
+| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-===Parameters===
+==Detailed description==
-''[[Variable types|HANDLE]] Sounds''
+The bits per sample is specified in creation through [[API Sound.Create|Sound.Create]].
-:The handle of the sound object to read
-===Return value===
-[[Variable types|BYTE]]
-Returns the number of bits per sample for the sound
+==Examples==
+===Calling in a calculation===
-===Detailed description===
-''No additional information''
-===Examples===
-====Calling in a calculation====
 * Declare a variable 'result' of type BYTE
-* Add to a calculation icon: <pre class="brush:[C]">result = ::Sound.GetBits(sounds)</pre>
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.GetBits(sounds)</pre>