Classes > RecordedSound class > Methods > RecordedSound.GetFormattedDuration method

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 GetFormattedDuration (

bShowHour as Boolean,

bShowMs as Boolean

) as String

[C#]

public string GetFormattedDuration (

bool bShowHour,

bool bShowMs

);

[C++]

public: string GetFormattedDuration (

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 sound duration