|
SoundPositionGet method |
  
|
|
SoundPositionGet method |
|
Remarks
Obtains the current position during a playback session.
A formatted string of the current sound position can be obtained through the SoundPositionStringGet method.
Syntax
[Visual Basic] Public Function SoundPositionGet ( nPlayerIndex as Int16, ByRef fPosition as Double, bKeepCountOfRateChange as Boolean ) as enumErrorCodes |
[C#] public enumErrorCodes SoundPositionGet ( Int16 nPlayerIndex, ref double fPosition, bool bKeepCountOfRateChange ); |
[C++] public: enumErrorCodes SoundPositionGet ( Int16 nPlayerIndex, double __gc *fPosition, bool bKeepCountOfRateChange ); |
Parameter |
Description |
||||||
|
|
||||||
nPlayerIndex |
Number representing the zero-based index of the player whose information must be retrieved |
||||||
fPosition |
Reference that, on return from the method call, will contain the current position. Its effective value depends upon the actual value of the ScaleUnits property. |
||||||
bKeepCountOfRateChange |
Boolean flag that specifies if the returned position must keep count of eventual playback rate changes set through previous calls to the Effects.PlaybackTempSet or Effects.PlaybackRateSet methods. Supported values are the following:
|
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. |
