Methods > Players and stream mixers > SoundPositionStringGet method

Remarks

Obtains a formatted string representing the current position during a playback session.

The string is formatted as hh:mm:ss:ms in which hh is for hours, mm is for minutes, ss is for seconds and ms is for milliseconds. For example [04:34:200] indicates that the playing sound has performed 4 minutes, 34 seconds and 200 milliseconds.

The numerical song position can be obtained using the SoundPositionGet method.

Syntax

[Visual Basic]

Public Function SoundPositionStringGet (

nPlayerIndex as Int16,

bShowHour as Boolean,

bShowMs as Boolean,

strHourSeparator as String,

strMsSeparator as String,

nNumberOfMsDigits as Int32,

bKeepCountOfRateChange as Boolean

) as String

[C#]

public string SoundPositionStringGet (

Int16 nPlayerIndex,

bool bShowHour,

bool bShowMs,

string strHourSeparator,

string strMsSeparator,

Int32 nNumberOfMsDigits,

bool bKeepCountOfRateChange

);

[C++]

public: string SoundPositionStringGet (

Int16 nPlayerIndex,

bool bShowHour,

bool bShowMs,

string strHourSeparator,

string strMsSeparator,

Int32 nNumberOfMsDigits,

bool bKeepCountOfRateChange

);

Parameter

Description

nPlayerIndex

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.

Supported values are the following:

false	Doesn't show hour value
true	Shows hour value

bShowMs

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

Supported values are the following:

false	Doesn't show milliseconds value
true	Shows milliseconds value

strHourSeparator

Character used to separate hours, minutes and seconds, typically this should be set to ":"

strMsSeparator

Character used to separate seconds and milliseconds, typically this should be set to "."

nNumberOfMsDigits

Number of characters used to represent milliseconds digits, can be in the range from 1 to 3; values outside this range will be automatically set to 3.

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:

Mnemonic constant	Meaning
false	Doesn't keep count of playback rate changes
true	Keeps count of playback rate changes

Return value

Value	Meaning

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