API Sound.GetRate

From Flowcode Help
Revision as of 14:27, 9 August 2013 by JonnyW (talk | contribs) (XML import of API documentation)
Jump to navigationJump to search


<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