|
SoundDurationGet method |
  
|
|
SoundDurationGet method |
|
Remarks
Gets the duration of the song currently loaded.
Due to the format of an MPEG Audio bitstream, it is not possible to know the type and duration of a MP3 file by just looking at a header. Some guesses can be made, but for a precise measurement of the contents of an MPEG Audio file, the entire file has to be scanned: this method performs only a foresight of the sound duration.
A formatted string of the loaded sound duration can be obtained through the SoundDurationStringGet method.
See the How to apply special effects to a playing sound section for further details.
Syntax
[Visual Basic] Public Function SoundDurationGet ( nPlayerIndex as Int16, ByRef fDuration as Double, bKeepCountOfRateChange as Boolean ) as enumErrorCodes |
[C#] public enumErrorCodes SoundDurationGet ( Int16 nPlayerIndex, ref double fDuration, bool bKeepCountOfRateChange ); |
[C++] public: enumErrorCodes SoundDurationGet ( Int16 nPlayerIndex, double __gc *fDuration, bool bKeepCountOfRateChange ); |
Parameter |
Description |
||||||
|
|
||||||
nPlayerIndex |
Number representing the zero-based index of the player whose information must be retrieved |
||||||
fDuration |
Reference that, on return from the method call, will contain the duration of the loaded sound expressed in milliseconds. |
||||||
bKeepCountOfRateChange |
Boolean flag that specifies if the returned duration 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:
|
Return value
Value |
Meaning |
|
|
Negative value |
An error occurred (see the LastError property for further error details) |
enumErrorCodes.NOERROR (0) |
The method call was successful. |
