Copyright © 2011-2019 MultiMedia Soft

TagsEditor.ID3V2_PictureFrameAddFromFile method

Previous pageReturn to chapter overviewNext page

Remarks

 

Adds to the ID3V2 tag a new picture frame (APIC) taken from the picture contained inside a graphical file. If a picture frame having the same description and picture type already exists, it will be replaced by the new one.

The modification only happens in memory and not directly into the original sound file: in order to store modifications inside the file you need to call the TagsEditor.ID3V2_SaveChanges method.

 

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

strPathname as String,

strDescription as String,

nPictureType as enumId3v2PictureType

) as enumErrorCodes


 

[C#]

public string ID3V2_PictureFrameAddFromFile (

string strPathname,

string strDescription,

enumId3v2PictureType nPictureType

);


 

[C++]

public: string ID3V2_PictureFrameAddFromFile (

string strPathname,

string strDescription,

enumId3v2PictureType nPictureType

);


 

Parameter

Description

 

 

strPathname

String representing the absolute pathname of the graphical file

strDescription

String representing the picture description

nPictureType

Value representing the type of picture.

Supported values are the following:

Mnemonic Value

Value

Meaning

ID3V2_PICTURE_OTHER

0

Other

ID3V2_PICTURE_ICON_32x32

1

32x32 icon

ID3V2_PICTURE_ICON_OTHER

2

Other icon

ID3V2_PICTURE_COVER_FRONT

3

Front cover

ID3V2_PICTURE_COVER_BACK

4

Back cover

ID3V2_PICTURE_LEAFLET_PAGE

5

Leaflet page

ID3V2_PICTURE_MEDIA

6

Media (e.g. label side of CD)

ID3V2_PICTURE_LEAD_ARTIST_PERFORMER_SOLOIST

7

Lead artist/lead performer/soloist

ID3V2_PICTURE_ARTIST_PERFORMER

8

Artist/performer

ID3V2_PICTURE_CONDUCTOR

9

Conductor

ID3V2_PICTURE_BAND_ORCHESTRA

10

Band/Orchestra

ID3V2_PICTURE_COMPOSER

11

Composer

ID3V2_PICTURE_LYRICIST_TEXT_WRITER

12

Lyricist/text writer

ID3V2_PICTURE_RECORDING_LOCATION

13

Recording Location

ID3V2_PICTURE_DURING_RECORDING

14

During recording

ID3V2_PICTURE_DURING_PERFORMANCE

15

During performance

ID3V2_PICTURE_MOVIE_VIDEO_SCREEN_CAPTURE

16

Movie/video screen capture

ID3V2_PICTURE_BRIGHT_FISH

17

A bright coloured fish

ID3V2_PICTURE_ILLUSTRATION

18

Illustration

ID3V2_PICTURE_BAND_ARTIST_LOGO

19

Band/artist logotype

ID3V2_PICTURE_PUBLISHER_STUDIO_LOGO

20

Publisher/Studio logotype

 

 

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.