Methods > Init and info > GetFormattedPlaybackPosition method

Remarks

Retrieves a formatted string representing the current time position during a playback session. 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.

The playback position in milliseconds can be obtained using the GetPlaybackPosition method.

Syntax

[Visual Basic]

Public Function GetFormattedPlaybackPosition (

bShowHour as Boolean,

bShowMs as Boolean

) as String

[C#]

public string GetFormattedPlaybackPosition (

bool bShowHour,

bool bShowMs

);

[C++]

public: string GetFormattedPlaybackPosition (

bool bShowHour,

bool bShowMs

);

Parameter

Description

bShowHour

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

false	Doesn't show hour value
true	Shows hour value

bShowMs

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

false	Doesn't show milliseconds value
true	Shows milliseconds value

Return value

Value	Meaning

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