Jump to content

API Sound.GetRate: Difference between revisions

From Flowcode Help
JonnyW (talk | contribs)
XML import of updated API docs
JonnyW (talk | contribs)
No edit summary
Line 23: Line 23:


==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]], however the conversion between rates will be done by software.





Revision as of 16:26, 7 August 2013


<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 API Sound.SetRate, however the conversion between rates will be done by software.


Examples

Calling in a calculation

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

No additional examples