Copyright © 2005-2019 MultiMedia Soft

TagsReader.ID3V2_SynchLyricsFrameInfoNumGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains numeric information about 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_SynchLyricsFrameInfoNumGet (

nIndex as Int32,

ByRef nLyricsType as enumId3v2SyncLyricsType,

ByRef nTimeStampFormat as enumId3v2TimeStampFormats

) as enumErrorCodes


 

[C#]

public enumErrorCodes ID3V2_SynchLyricsFrameInfoNumGet (

Int32 nIndex,

ref enumId3v2SyncLyricsType nLyricsType,

ref enumId3v2TimeStampFormats nTimeStampFormat

);


 

[C++]

public: enumErrorCodes ID3V2_SynchLyricsFrameInfoNumGet (

Int32 nIndex,

enumId3v2SyncLyricsType __gc *nLyricsType,

enumId3v2TimeStampFormats __gc *nTimeStampFormat

);


 

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".

nLyricsType

Reference that, on return from the method call, will contain the type of lyric contents.

Supported values are the following:

Mnemonic Value

Value

Meaning

ID3V2_SYNC_LYRICS_TYPE_OTHER

0

Other

ID3V2_SYNC_LYRICS_TYPE_LYRICS

1

Lyrics

ID3V2_SYNC_LYRICS_TYPE_TEXT_TRANSCRIPTION

2

Text transcription

ID3V2_SYNC_LYRICS_TYPE_MOVEMENT_PARTNAME

3

Movement/part name

ID3V2_SYNC_LYRICS_TYPE_EVENTS

4

Events

ID3V2_SYNC_LYRICS_TYPE_CHORD

5

Chord

ID3V2_SYNC_LYRICS_TYPE_TRIVIA_POPUP

6

Trivia/pop up information

ID3V2_SYNC_LYRICS_TYPE_URL_TO_WEBPAGE

7

URLs to webpages

ID3V2_SYNC_LYRICS_TYPE_URL_TO_IMAGES

8

URL to images

nTimeStampFormat

Reference that, on return from the method call, will contain the timestamp format.

Supported values are the following:

Mnemonic Value

Value

Meaning

ID3V2_TIMESTAMP_FORMAT_FRAMES

1

MPEG frames

ID3V2_TIMESTAMP_FORMAT_MS

2

Milliseconds

 

 

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.