Difference between revisions of "API Sound.GetRate"
From Flowcode Help
Jump to navigationJump to search (XML Import to change Variable types into Variable Types) |
|||
| (7 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | |
| − | + | |- | |
| − | + | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | |
| − | + | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetRate''' | |
| − | === | + | |- |
| − | [[ | + | | colspan="2" | Gets the current sample rate for the sound |
| − | : | + | |- |
| − | + | |- | |
| − | + | | width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE | |
| − | + | | width="90%" | Sounds | |
| − | == | + | |- |
| − | [[ | + | | colspan="2" | 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'' | |
| − | == | + | |} |
| − | [[ | ||
| − | |||
| − | |||
==Detailed description== | ==Detailed description== | ||
| − | + | The base sample is specified in creation through [[API Sound.Create|Sound.Create]]. This may be altered through [[API Sound.SetRate|Sound.SetRate]] or software conversion can be done through [[API Sound.Queue|Sound.Queue]] or [[API Sound.QueueEx|Sound.QueueEx]]. | |
| Line 28: | Line 25: | ||
* Declare a variable 'result' of type ULONG | * Declare a variable 'result' of type ULONG | ||
* Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.GetRate(sounds)</pre> | * Add to a calculation icon: <pre class="brush:[cpp]">result = ::Sound.GetRate(sounds)</pre> | ||
| − | |||
| − | |||
Latest revision as of 11:55, 16 January 2023
|
GetRate |
| Gets the current sample rate for the sound | |
 - HANDLE
|
Sounds |
| The handle of the sound object to read | |
 - ULONG
|
Return |
Detailed description
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.
Examples
Calling in a calculation
- Declare a variable 'result' of type ULONG
- Add to a calculation icon:
result = ::Sound.GetRate(sounds)
