Difference between revisions of "API Sound.GetRate"

From Flowcode Help
Jump to navigationJump to search
(XML import of updated API docs)
(XML import)
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
+
<sidebar>API Contents</sidebar>
 
 
<sidebar>API contents</sidebar>
 
 
Gets the current sample rate for the sound
 
Gets the current sample rate for the sound
  
Line 23: Line 21:
  
 
==Detailed description==
 
==Detailed description==
''<span style="color:red;">No additional information</span>''
+
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]].
  
  

Latest revision as of 15:57, 16 January 2014

<sidebar>API Contents</sidebar> Gets the current sample rate for the sound

Class hierarchy

Sound

GetRate

Parameters

HANDLE Sounds

The handle of the sound object to read


Return value

ULONG

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