|
Effects.PlaybackRateRatioGet method |
  
|
|
Effects.PlaybackRateRatioGet method |
|
Remarks
Obtains the current ratio for playback rate of the given player.
When playback is performed at normal speed, its ratio is 1.0; after changing the playback speed through the Effects.PlaybackTempSet or Effects.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.
Syntax
[Visual Basic] Public Function PlaybackRateRatioGet ( nPlayerIndex as Int16, ByRef fRatio as Single ) as enumErrorCodes |
[C#] public enumErrorCodes PlaybackRateRatioGet ( Int16 nPlayerIndex, ref float fRatio ); |
[C++] public: enumErrorCodes PlaybackRateRatioGet ( Int16 nPlayerIndex, float __gc *fRatio ); |
Parameter |
Description |
|
|
nPlayerIndex |
Number representing the zero-based index of the player whose information must be retrieved |
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. |
