Copyright © 2008-2013 MultiMedia Soft

TagsEditor.ID3V2_CommercialFramePictureFileGet method

Previous pageReturn to chapter overviewNext page

Remarks

 

Creates a graphic file, of a given graphic format, containing the picture stored inside an ID3V2 commercial frame (COMR).

 

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

nIndex as Int32,

strPathname as String,

nFormat as enumGraphicFormats,

nFormatParameter as Int32

) as enumErrorCodes


 

[C#]

public string ID3V2_CommercialFramePictureFileGet (

Int32 nIndex,

string strPathname,

enumGraphicFormats nFormat,

Int32 nFormatParameter

);


 

[C++]

public: string ID3V2_CommercialFramePictureFileGet (

Int32 nIndex,

string strPathname,

enumGraphicFormats nFormat,

Int32 nFormatParameter

);


 

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

strPathname

String representing the absolute pathname of the output graphic file.

nFormat

Graphic format of the output graphic file.

Supported values are the following:

Mnemonic value

Value

Meaning

GRAPHIC_FORMAT_ORIGINAL

-1

Original format used to store the picture inside the tag.

When this option is selected, the output graphic file will be an exact copy of the contents of the picture frame. You can determine the original graphic format, through its MIME type, by calling the TagsEditor.ID3V2_PictureFrameInfoGet method with the parameter nInfo set to ID3V2_FRAME_INFO_MIME_TYPE; this information can be also useful to determine the file extension to use when composing the strPathname parameter above.

GRAPHIC_FORMAT_BMP

0

The output file will be converted to BMP format

GRAPHIC_FORMAT_JPEG

1

The output file will be converted to JPEG format

GRAPHIC_FORMAT_PNG

2

The output file will be converted to PNG format

GRAPHIC_FORMAT_GIF

3

The output file will be converted to GIF format

GRAPHIC_FORMAT_TIFF

4

The output file will be converted to TIFF format

nFormatParameter

Eventual parameter required by the chosen graphic format.

When the nFormat parameter is set to GRAPHIC_FORMAT_JPEG, this parameter defines the JPEG compression factor whose range can be in the range from 0 (Maximum compression, Lower Quality) to 100 (Minimum compression, Higher Quality).

 

 

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.