Copyright © 2008-2015 MultiMedia Soft

TagsEditor.ID3V2_CommercialFrameReceivedAsGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Obtains the type of "Received as" field of the given commercial frame (COMR) of the ID3V2 tag.

 

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

nIndex as Int32,

ByRef nReceivedAs as enumId3v2ReceivedAsType

) as enumErrorCodes


 

[C#]

public enumErrorCodes ID3V2_CommercialFrameReceivedAsGet (

Int32 nIndex,

ref enumId3v2ReceivedAsType nReceivedAs

);


 

[C++]

public: enumErrorCodes ID3V2_CommercialFrameReceivedAsGet (

Int32 nIndex,

enumId3v2ReceivedAsType __gc *nReceivedAs

);


 

Parameter

Description

 

 

nIndex

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

nReceivedAs

Reference that, on return from the method call, will contain the type of "Received as" field.

Supported values are the following:

Mnemonic value

Value

Meaning

ID3V2_COMMERCIAL_RECAS_Other

0

Other

ID3V2_COMMERCIAL_RECAS_Standard_CD

1

Standard CD album with other songs

ID3V2_COMMERCIAL_RECAS_Compressed

2

Compressed audio on CD

ID3V2_COMMERCIAL_RECAS_File_Internet

3

File over the Internet

ID3V2_COMMERCIAL_RECAS_Stream_Internet

4

Stream over the Internet

ID3V2_COMMERCIAL_RECAS_Note_sheets

5

As note sheets

ID3V2_COMMERCIAL_RECAS_Note_sheets_book

6

As note sheets in a book with other sheets

ID3V2_COMMERCIAL_RECAS_Music

7

Music on other media

ID3V2_COMMERCIAL_RECAS_Merchandise

8

Non-musical merchandise

 

 

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.