API Sound.GetRate

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

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