API Sound.GetPending: Difference between revisions

Latest revision as of 13:17, 13 July 2026

	GetPending
Gets the number of sample blocks queued or playing for the sound
- HANDLE	Sounds
The handle of the sound object to read
- ULONG	Return

Detailed description

The number of pending sounds includes those currently playing. This call can be used to sequence smooth sound where a certain number of samples need to be continuously queued to achieve a smooth effect.

Examples

Calling in a calculation

Declare a variable 'result' of type ULONG
Add to a calculation icon:
```
result = ::Sound.GetPending(sounds)
```

@@ Line 1: / Line 1: @@
-<sidebar>API contents</sidebar>
+{| class="mtx-class-macrotable wikitable"
-Gets the number of sample blocks queued or playing for the sound
+|-
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
+| width="90%" class="mtx-class-macrohead" | '''GetPending'''
+|-
+| colspan="2" | Gets the number of sample blocks queued or playing 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-u32-icon.png]] - ULONG
+| width="90%" style="border-top: 2px solid #000;" | ''Return''
+|}
-===Parameters===
+==Detailed description==
-''[[Variable types|HANDLE]] Sounds''
+The number of pending sounds includes those currently playing. This call can be used to sequence smooth sound where a certain number of samples need to be continuously queued to achieve a smooth effect.
-:The handle of the sound object to read
-===Return value===
-[[Variable types|ULONG]]
-Returns the number of sample blocks queued or playing for the sound
+==Examples==
+===Calling in a calculation===
-===Detailed description===
-''No additional information''
-===Examples===
-====Calling in a calculation====
 * Declare a variable 'result' of type ULONG
-* Add to a calculation icon: <pre class="brush:[C]">result = ::Sound.GetPending(sounds)</pre>
+* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.GetPending(sounds)</pre>

SteveT (talk | contribs)

Latest revision as of 13:17, 13 July 2026

Detailed description

Examples

Calling in a calculation