RecordedSound.PlaybackRateRatioGet method |
|
Remarks
Obtains the current ratio for playback rate.
When playback is performed at normal speed, its ratio is 1.0; after changing the playback speed through the RecordedSound.PlaybackTempSet or RecordedSound.PlaybackRateSet methods, the playback speed is altered and this method allows to know which is the updated rate ratio. For example, if the playback rate should be incremented by 20%, the reported playback rate ratio would be 1.2 while, if the playback rate should be reduced by 30%, the reported playback rate ratio would be 0.7.
For further details about recorded sound methods refer to the RecordedSound class section.
For further details see the How to perform a recording session section.
Syntax
[Visual Basic] Public Function PlaybackRateRatioGet ( ByRef fRatio as Single ) as enumErrorCodes |
[C#] public enumErrorCodes PlaybackRateRatioGet ( ref float fRatio ); |
[C++] public: enumErrorCodes PlaybackRateRatioGet ( float __gc *fRatio ); |
Parameter |
Description |
|
|
fRatio |
Reference that, on return from the method call, will contain the current rate ratio. |
Return value
Value |
Meaning |
|
|
Negative value |
An error occurred (see the LastError property for further error details) |
enumErrorCodes.NOERROR (0) |
The method call was successful. |