KFileMetaData::EmbeddedImageData

Search for usage in LXR

KFileMetaData::EmbeddedImageData Class Reference

#include <KFileMetaData/EmbeddedImageData>

Public Types

enum  ImageType {
  FrontCover = 1 << 0x0, Other = 1 << 0x01, FileIcon = 1 << 0x02, OtherFileIcon = 1 << 0x03,
  BackCover = 1 << 0x04, LeafletPage = 1 << 0x05, Media = 1 << 0x06, LeadArtist = 1 << 0x07,
  Artist = 1 << 0x08, Conductor = 1 << 0x09, Band = 1 << 0x0A, Composer = 1 << 0x0B,
  Lyricist = 1 << 0x0C, RecordingLocation = 1 << 0x0D, DuringRecording = 1 << 0x0E, DuringPerformance = 1 << 0x0F,
  MovieScreenCapture = 1 << 0x10, ColouredFish = 1 << 0x11, Illustration = 1 << 0x12, BandLogo = 1 << 0x13,
  PublisherLogo = 1 << 0x14, Unknown = 1 << 30, AllImages = 0x7fffffff
}
 
typedef QFlags< ImageTypeImageTypes
 

Public Member Functions

QMap< ImageType, QByteArrayimageData (const QString &fileUrl, const EmbeddedImageData::ImageTypes types=FrontCover) const
 
QStringList mimeTypes () const
 
void writeImageData (const QString &fileUrl, QMap< ImageType, QByteArray > &imageData)
 

Detailed Description

EmbeddedImageData defines enums for different image types that can be extracted from the metadata of e.g. music files.

Todo:
KF6 make this an enum only in KF6 similar to properties.h

Definition at line 27 of file embeddedimagedata.h.

Member Typedef Documentation

◆ ImageTypes

Stores a combination of ImageType values.

Definition at line 62 of file embeddedimagedata.h.

Member Enumeration Documentation

◆ ImageType

Member Function Documentation

◆ imageData()

QMap< EmbeddedImageData::ImageType, QByteArray > EmbeddedImageData::imageData ( const QString fileUrl,
const EmbeddedImageData::ImageTypes  types = FrontCover 
) const

Extracts the images stored in the metadata tags from a file.

By default, the front cover is extracted.

Deprecated:
Since 5.91 Use ExtractorCollection and ExtractionResult::imageData() instead.

Definition at line 62 of file embeddedimagedata.cpp.

◆ mimeTypes()

QStringList EmbeddedImageData::mimeTypes ( ) const

Provides a list of mimetypes which are supported for reading of embedded images in e.g.

audio files.

Since
5.52
Deprecated:
Since 5.91 Mimetypes are automatically handled when using the Extractor/WriterCollection.

Definition at line 56 of file embeddedimagedata.cpp.

◆ writeImageData()

void EmbeddedImageData::writeImageData ( const QString fileUrl,
QMap< ImageType, QByteArray > &  imageData 
)

Extracts the images stored in the metadata tags from a file.

By default, the front cover is extracted.

Deprecated:
Since 5.91 Use WriterCollection and WriteData::addImageData() instead.

Definition at line 77 of file embeddedimagedata.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Sun Mar 26 2023 04:16:57 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.