Copyright © 2008-2018 MultiMedia Soft

TagsEditor.ID3V2_PopularimeterFrameRatingGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the rating of the given ID3V2 popularimeter frame (POPM).

 

For further details about methods related to tags editing refer to the TagsEditorMan class.

For details about the editing of tags see the How to edit tag info in sound files tutorial.

 

 

Syntax

 

[Visual Basic]

Public Function ID3V2_PopularimeterFrameRatingGet (

nIndex as Int32,

ByRef nRating as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes ID3V2_PopularimeterFrameRatingGet (

Int32 nIndex,

ref Int32 nRating

);


 

[C++]

public: enumErrorCodes ID3V2_PopularimeterFrameRatingGet (

Int32 nIndex,

Int32 __gc *nRating

);


 

Parameter

Description

 

 

nIndex

Zero-based index of the popularimeter frame. The total number of popularimeter available inside the ID3V2 tag can be obtained through a call to the TagsEditor.ID3V2_FrameCountGet method with the strFrameId parameter set to "POPM".

nRating

Reference that, on return from the method call, will contain the song rating: can be a value in the range from 1 (worst) to 255 (best), 0 means that no rating is assigned.

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.ERR_NOERROR (0)

The method call was successful.