Difference between revisions of "API Sound.GetRate"
From Flowcode Help
Jump to navigationJump to search (XML import) |
(XML import) |
||
| (10 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | <sidebar>API | + | <sidebar>API Contents</sidebar> |
Gets the current sample rate for the sound | Gets the current sample rate for the sound | ||
<div style="width:25%; float:right" class="toc"> | <div style="width:25%; float:right" class="toc"> | ||
| − | ===Class hierarchy===[[API Sound|Sound]] | + | ====Class hierarchy==== |
| + | [[API Sound|Sound]] | ||
:[[API Sound|GetRate]] | :[[API Sound|GetRate]] | ||
</div> | </div> | ||
| Line 9: | Line 10: | ||
==Parameters== | ==Parameters== | ||
| − | + | [[Variable Types|HANDLE]] ''Sounds'' | |
:The handle of the sound object to read | :The handle of the sound object to read | ||
| + | |||
==Return value== | ==Return value== | ||
| − | [[Variable | + | [[Variable Types|ULONG]] |
Returns the current sample rate for the sound | Returns the current sample rate for the sound | ||
| + | |||
==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]]. | |
| + | |||
==Examples== | ==Examples== | ||
| Line 24: | Line 28: | ||
* 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> | ||
| + | |||
| + | ''<span style="color:red;">No additional examples</span>'' | ||
Latest revision as of 15:57, 16 January 2014
<sidebar>API Contents</sidebar> Gets the current sample rate for the sound
Contents
Parameters
HANDLE Sounds
- The handle of the sound object to read
Return value
Returns the current sample rate for the sound
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)
No additional examples
