Methods > Players and stream mixers > GetCurrentPosString method

Remarks

Gets a formatted string representing the current time position during a playback session.

The current position is calculated respect to the original sound duration and could not represent the effective playback time if a previous playback rate change, performed through a call to SetTempoPerc and SetRatePerc methods, should occur. If you should need to obtain the effective position in terms of playback time you could use the GetPlaybackTimeString method.

The string is formatted as hh:mm:ss:ms(3) in which hh is for hours, mm is for minutes, ss is for seconds and ms(3) are three characters representing the milliseconds. For example [04:34:200] indicates that the playing sound has performed, till now, for 4 minutes, 34 seconds and 200 milliseconds.

Syntax

[Visual Basic]

control.GetCurrentPosString (

nPlayer as Integer,

bShowHour as enumBoolean,

bShowMs as enumBoolean

) as String

[C++]

long control.GetCurrentPosString (

short nPlayer,

short bShowHour,

short bShowMs

);

Parameter

Description

nPlayer

Number representing the zero-based index of the player whose information must be retrieved

bShowHour

Boolean value that specifies the player to avoid displaying the 'hour' position field

Mnemonic constant	Value	Meaning
BOOL_FALSE	0	Doesn't show hour value
BOOL_TRUE	1	Shows hour value

bShowMs

Boolean value that specifies the player to avoid displaying the 'milliseconds' position field

Mnemonic constant	Value	Meaning
BOOL_FALSE	0	Doesn't show milliseconds value
BOOL_TRUE	1	Shows milliseconds value

Return value

Value	Meaning

Empty string	An error occurred (see the LastError property for further error details)
Valid string	The formatted sound position