|
SoundPositionStringGet method |
  
|
|
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] control.SoundPositionStringGet ( nPlayer as Integer, bShowHour as enumBoolean, bShowMs as enumBoolean, strHourSeparator as String, strMsSeparator as String, nNumberOfMsDigits as Integer, bKeepCountOfRateChange as enumBoolean, ) as String |
[C++] LPCTSTR control.SoundPositionStringGet ( short nPlayer, short bShowHour, short bShowMs, BSTR strHourSeparator, BSTR strMsSeparator, short nNumberOfMsDigits, short bKeepCountOfRateChange, ); |
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. Supported values are the following:
|
|||||||||
bShowMs |
Boolean value that specifies the player to avoid displaying the 'milliseconds' position field. Supported values are the following:
|
|||||||||
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.PlaybackTempoSet or Effects.PlaybackRateSet methods. Supported values are the following:
|
Return value
Value |
Meaning |
|
|
Empty string |
An error occurred (see the LastError property for further error details) |
Valid string |
The formatted sound position |
