Jump to content

API Sound.GetRate: Difference between revisions

From Flowcode Help
JonnyW (talk | contribs)
XML import API changes
JonnyW (talk | contribs)
XML Import to change Variable types into Variable Types
Line 10: Line 10:


==Parameters==
==Parameters==
[[Variable types|HANDLE]] ''Sounds''
[[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 types|ULONG]]
[[Variable Types|ULONG]]


Returns the current sample rate for the sound
Returns the current sample rate for the sound

Revision as of 11:09, 10 June 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

No additional information


Examples

Calling in a calculation

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

No additional information