Copyright © 2005-2018 MultiMedia Soft

TagsReader.ID3V2_SynchLyricsFrameGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the lyrics text stored inside the given ID3V2 synchronized lyrics frame (SYLT).

 

For further details about methods related to tags reading refer to the TagsReaderMan class.

For details about the reading of tags see the How to read TAG information in sound files tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function ID3V2_SynchLyricsFrameGet (

nIndex as Int32

) as String


 

[C#]

public string ID3V2_SynchLyricsFrameGet (

Int32 nIndex

);


 

[C++]

public: string ID3V2_SynchLyricsFrameGet (

Int32 nIndex

);


 

Parameter

Description

 

 

nIndex

Zero-based index of the synchronized lyrics frame. The total number of synchronized lyrics frames available inside the ID3V2 tag can be obtained through a call to the TagsReader.ID3V2_FrameCountGet method with the strFrameId parameter set to "SYLT".

 

 

Return value

 

Value

Meaning

 

 

Empty string

The information is not available or an error occurred (see the LastError property for further error details)

Valid string

String with the requested information.

The string is made up of multiple lines, each terminated by the CR+LF sequence. Each line starts with the timestamp which indicates the position within the sound file where the line is located during playback using the format below:

 

[xxxxxxxx] line1

[xxxxxxxx] line2

[xxxxxxxx] line3

etc.

 

where xxxxxxxx, enclosed within [ ] characters (square brackets), represents the timestamp value which may be expressed in MPEG frames or in milliseconds: you can know the timestamp format by calling the TagsReader.ID3V2_SynchLyricsFrameInfoNumGet method and by checking the value of the nTimeStampFormat parameter.

 

In the example below the timestamp has been expressed in milliseconds:

 

[00015030]Tale

[00015070]as

[00016020]old

[00016070]as

[00017020]time

 

The equivalent string in C++ would result like this:

 

"[00015030]Tale \r\n[00015070]as \r\n[00016020]old \r\n[00016070]as \r\n[00017020]time \r\n"

 

while in VB6 would result like this:

 

"[00015030]Tale " & vbCrLf & "[00015070]as " & vbCrLf & "[00016020]old " & vbCrLf & "[00016070]as " & vbCrLf & "[00017020]time " & vbCrLf