Remarks
Retrieves a string containing the formatted duration of the last recorded sound using the following format [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 milliseconds. For example [04:34:200] indicates a song during 0 hours (the hours number is automatically omitted if 0), 4 minutes, 34 seconds and 200 milliseconds.
The song duration in milliseconds can be obtained using the RecordedSound.GetDuration method.
For further details about recorded sound methods refer to the RecordedSound class section.
For further details see the How to perform a recording session section.
Syntax
[Visual Basic]
Public Function DurationStringGet (
bShowHour as Boolean,
bShowMs as Boolean,
strHourSeparator as String,
strMsSeparator as String,
nNumberOfMsDigits as Int32
) as String
|
|
[C#]
public string DurationStringGet (
bool bShowHour,
bool bShowMs,
string strHourSeparator,
string strMsSeparator,
Int32 nNumberOfMsDigits
);
|
|
[C++]
public: string DurationStringGet (
bool bShowHour,
bool bShowMs,
string strHourSeparator,
string strMsSeparator,
Int32 nNumberOfMsDigits
);
|
|
Parameter
|
Description
|
|
|
bShowHour
|
Boolean value that specifies the player to avoid displaying the 'hour' position field.
Supported values are the following:
Value
|
Meaning
|
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:
Value
|
Meaning
|
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.
|
Return value
Value
|
Meaning
|
|
|
Empty string
|
An error occurred (see the LastError property for further error details)
|
Valid string
|
The formatted sound duration
|
|
