properties.h File Reference

#include "kfilemetadata_export.h"
#include <QMap>
#include <QVariant>

Include dependency graph for properties.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef QMap< Property::Property, QVariant >	KFileMetaData::PropertyMap
using	KFileMetaData::PropertyMultiMap = QMultiMap< Property::Property, QVariant >

Enumerations
enum	KFileMetaData::Property::Property {   FirstProperty = 0, Empty = 0, KFileMetaData::Property::BitRate, KFileMetaData::Property::Channels,   KFileMetaData::Property::Duration, KFileMetaData::Property::Genre, KFileMetaData::Property::SampleRate, KFileMetaData::Property::TrackNumber,   KFileMetaData::Property::ReleaseYear, KFileMetaData::Property::Comment, KFileMetaData::Property::Artist, KFileMetaData::Property::Album,   KFileMetaData::Property::AlbumArtist, KFileMetaData::Property::Composer, KFileMetaData::Property::Lyricist, KFileMetaData::Property::Author,   KFileMetaData::Property::Title, KFileMetaData::Property::Subject, KFileMetaData::Property::Generator, KFileMetaData::Property::PageCount,   KFileMetaData::Property::WordCount, KFileMetaData::Property::LineCount, KFileMetaData::Property::Language, KFileMetaData::Property::Langauge = Language,   KFileMetaData::Property::Copyright, KFileMetaData::Property::Publisher, KFileMetaData::Property::CreationDate, KFileMetaData::Property::Keywords,   KFileMetaData::Property::Width, KFileMetaData::Property::Height, KFileMetaData::Property::AspectRatio, KFileMetaData::Property::FrameRate,   KFileMetaData::Property::Manufacturer, KFileMetaData::Property::ImageMake = Manufacturer, KFileMetaData::Property::Model, KFileMetaData::Property::ImageModel = Model,   ImageDateTime, ImageOrientation, PhotoFlash, PhotoPixelXDimension,   PhotoPixelYDimension, PhotoDateTimeOriginal, PhotoFocalLength, PhotoFocalLengthIn35mmFilm,   PhotoExposureTime, PhotoFNumber, PhotoApertureValue, PhotoExposureBiasValue,   PhotoWhiteBalance, PhotoMeteringMode, PhotoISOSpeedRatings, PhotoSaturation,   PhotoSharpness, PhotoGpsLatitude, PhotoGpsLongitude, PhotoGpsAltitude,   TranslationUnitsTotal, TranslationUnitsWithTranslation, TranslationUnitsWithDraftTranslation, TranslationLastAuthor,   TranslationLastUpDate, TranslationTemplateDate, KFileMetaData::Property::OriginUrl, KFileMetaData::Property::OriginEmailSubject,   KFileMetaData::Property::OriginEmailSender, KFileMetaData::Property::OriginEmailMessageId, KFileMetaData::Property::DiscNumber, KFileMetaData::Property::Location,   KFileMetaData::Property::Performer, KFileMetaData::Property::Ensemble, KFileMetaData::Property::Arranger, KFileMetaData::Property::Conductor,   KFileMetaData::Property::Opus, KFileMetaData::Property::Label, KFileMetaData::Property::Compilation, KFileMetaData::Property::License,   KFileMetaData::Property::Rating, KFileMetaData::Property::Lyrics, KFileMetaData::Property::ReplayGainAlbumPeak, KFileMetaData::Property::ReplayGainAlbumGain,   KFileMetaData::Property::ReplayGainTrackPeak, KFileMetaData::Property::ReplayGainTrackGain, KFileMetaData::Property::Description, PropertyCount,   LastProperty = PropertyCount-1 }

Detailed Description

<KFileMetaData/Properties>

Definition in file properties.h.

Enumeration Type Documentation

Property

enum KFileMetaData::Property::Property

The Property enum contains all files property types that KFileMetaData manipulates.

Todo:

KF6 remove PropertyCount and LastProperty such that one can easily add new properties

Enumerator
BitRate	The Bit Rate of the Audio in the File. Represented as an integer in kbit/sec
Channels	The number of channels of the Audio in the File. Represented as an integer.
Duration	The duration of the media in the file. Represented as an integer in seconds.
Genre	The Genre of an Audio file. This s represented as a string of genres and not integers. The IDv1 standard provides a list of commonly excepted genres.
SampleRate	The same rate or frequency of the Audio in the file. This is represented as an integer in Hz. So a file with "44.1KHz" will have a frequency of 44100
TrackNumber	Represents the track number in a set. Typically maps to the "TRCK" tag in IDv3
ReleaseYear	Indicates the year a track was released. Represented as an integer. Typically mapped to the "TYE (Year)" tag in IDv1
Comment	Represents a comment stored in the file. This can map to e.g. the "COMM" field from IDv3
Artist	Represents the artist of a media file. This generally corresponds to the IDv1 ARTIST tag. Many extractors often split this string into a number of artists.
Album	Represents the album of a media file. This generally corresponds to the IDv1 ALBUM tag.
AlbumArtist	Represents the album artist of a media file. This generally corresponds to the IDv3 TPE2 ("Band/Orchestra/Accompaniment") tag.
Composer	Represents the Composer of a media file. This generally corresponds to the IDv2 COMPOSER tag.
Lyricist	Represents the Lyricist of a media file. This generally corresponds to the IDv2 "Lyricist/text writer" tag.
Author	The Author field indicated the primary creator of a document. This often corresponds directly to dc:creator
Title	Refers to the Title of the content of the file. This can represented by the IDv1 tag TT2 (Title/songname/content description) or the TITLE in a PDF file or the 'dc:title' tag in DublinCore.
Subject	Refers to the subject of the file. This directly corresponds to the 'dc:subject' tag from DublinCore.
Generator	Refers to the Application used to create this file. In the ODF standard this maps to the 'meta:generator' tag. In PDFs its mapped to the "Producer" tag.
PageCount	The number of pages in a document.
WordCount	The number of words in a document. This is often only provided for documents where the word count is available in the metadata.
LineCount	The number of lines in a document. This is often only provided for documents where the line count is available in the metadata.
Language	The language the document is written in. This directly maps to the 'dc:language' tag from DublinCore. We do NOT employ any language detection schemes on the text. Since 5.50
Langauge	Same as Language. Deprecated: Since 5.50, use Language instead
Copyright	The copyright of the file. Represented as a string.
Publisher	The publisher of the content. Represented as a string.
CreationDate	The date the content of the file was created. This is extracted from the File MetaData and not from the file system. In ODF, it corresponds to "meta:creation-date", in PDF to the "CreationDate" tag, and otherwise the "dcterms:created" tag.
Keywords	The keywords used to represent the document. This is mostly a string list of all the keywords.
Width	Represents the width of the Media in pixels. This is generally only applicable for Images and Videos.
Height	Represents the height of the Media in pixels. This is generally only applicable for Images and Videos.
AspectRatio	The Aspect Ratio of the visual image or video. It is the width of a pixel divided by the height of the pixel.
FrameRate	Number of frames per second.
Manufacturer	The manufacturer of the equipment used for generating the file and metadata. Typically maps to the 'Exif.Image.Make' tag. Since 5.60
ImageMake	Same as Manufacturer. Deprecated: Since 5.60, use Manufacturer instead
Model	The model name of the equipment used for generating the file and metadata. Typically maps to the 'Exif.Image.Model' tag. Since 5.60
ImageModel	Same as Model. Deprecated: Since 5.60, use Model instead
OriginUrl	The URL this file has originally been downloaded from.
OriginEmailSubject	The subject of the email this file was originally attached to.
OriginEmailSender	The sender of the email this file was originally attached to.
OriginEmailMessageId	The message ID of the email this file was originally attached to.
DiscNumber	Represents the disc number in a multi-disc set. Typically maps to the "TPOS" tag for mp3
Location	Represents the location where an audio file was recorded.
Performer	Represents the (lead) performer of an audio file.
Ensemble	Represents the ensemble of an audio file.
Arranger	Represents the arranger of an audio file.
Conductor	Represents the conductor of an audio file.
Opus	Represents the opus of an audio file mostly used for classical music.
Label	Represents the label of the content.
Compilation	Contains the name of the compilation of an audio file.
License	Contains the license information of the file.
Rating	For ratings stored in Metadata tags.
Lyrics	Contains the lyrics of a song embedded in the file.
ReplayGainAlbumPeak	Contains ReplayGain information for audio files.
ReplayGainAlbumGain	Contains ReplayGain information for audio files The album gain is given in "dB".
ReplayGainTrackPeak	Contains ReplayGain information for audio files.
ReplayGainTrackGain	Contains ReplayGain information for audio files The track gain is given in "dB".
Description	Represents the description stored in the file. This maps to the 'dc:description' tag from DublinCore

Definition at line 25 of file properties.h.