TagsReader.WMA_PictureFrameFileGet method |
|
Remarks
Creates a graphic file, of a given graphic format, containing the picture stored inside a WMA picture frame.
For further details about methods related to tags reading refer to the TagsReaderMan class.
For details about the reading of tags see the How to read TAG information in sound files tutorial.
Syntax
[Visual Basic] Public Function WMA_PictureFrameFileGet ( nIndex as Int32, strPathname as String, nFormat as enumGraphicFormats, nFormatParameter as Int32 ) as enumErrorCodes |
[C#] public string WMA_PictureFrameFileGet ( Int32 nIndex, string strPathname, enumGraphicFormats nFormat, Int32 nFormatParameter ); |
[C++] public: string WMA_PictureFrameFileGet ( Int32 nIndex, string strPathname, enumGraphicFormats nFormat, Int32 nFormatParameter ); |
Parameter |
Description |
|||||||||||||||||||||
|
|
|||||||||||||||||||||
nIndex |
Zero-based index of the picture frame. The total number of picture frames available inside the WMA tag can be obtained through a call to the TagsReader.WMA_PictureFrameCountGet method. |
|||||||||||||||||||||
strPathname |
String representing the absolute pathname of the output graphic file. |
|||||||||||||||||||||
nFormat |
Graphic format of the output graphic file. 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.NOERROR (0) |
The method call was successful. |