|
TagsEditor.ID3V2_PictureFrameAddFromBitmap method |
  
|
|
TagsEditor.ID3V2_PictureFrameAddFromBitmap method |
|
Remarks
Adds to the ID3V2 tag a new picture frame (APIC) taken from a memory bitmap. 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_PictureFrameAddFromBitmap ( hBitmap as IntPtr, strDescription as String, nPictureType as enumId3v2PictureType, nFormat as enumGraphicFormats, nFormatParameter as Int32 ) as enumErrorCodes |
[C#] public string ID3V2_PictureFrameAddFromBitmap ( IntPtr hBitmap, string strDescription, enumId3v2PictureType nPictureType, enumGraphicFormats nFormat, Int32 nFormatParameter ); |
[C++] public: string ID3V2_PictureFrameAddFromBitmap ( IntPtr hBitmap, string strDescription, enumId3v2PictureType nPictureType, enumGraphicFormats nFormat, Int32 nFormatParameter ); |
Parameter |
Description |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
hBitmap |
Handle of the memory bitmap (HBITMAP) to use in order to create the picture frame. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
strDescription |
String representing the picture description |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nPictureType |
Value representing the type of picture. Supported values are the following:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nFormat |
Graphic format used to save the bitmap inside the APIC frame of the ID3V2 tag. Supported values are the following:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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. |
