\inmodule QtMultimedia More...

#include <qmediametadata.h>

Inheritance diagram for QMediaMetaData:

Collaboration diagram for QMediaMetaData:

Public Types
enum	Key { Title , Author , Comment , Description , Genre , Date , Language , Publisher , Copyright , Url , Duration , MediaType , FileFormat , AudioBitRate , AudioCodec , VideoBitRate , VideoCodec , VideoFrameRate , AlbumTitle , AlbumArtist , ContributingArtist , TrackNumber , Composer , LeadPerformer , ThumbnailImage , CoverArtImage , Orientation , Resolution , HasHdrContent }
	Provides meta-data for media files. More...

Public Member Functions
Q_INVOKABLE QVariant	value (Key k) const
	\variable QMediaMetaData::NumMetaData
Q_INVOKABLE void	insert (Key k, const QVariant &value)
	\qmlmethod void QtMultimedia::mediaMetaData::insert(Key k, variant value) Inserts a value into a Key: {k}.
Q_INVOKABLE void	remove (Key k)
	\qmlmethod void QtMultimedia::mediaMetaData::remove(Key k) Removes meta data from a Key: {k}.
Q_INVOKABLE QList< Key >	keys () const
	\qmlmethod list<Key> QtMultimedia::mediaMetaData::keys() Returns a list of MediaMetaData.Keys.
QVariant &	operator[] (Key k)
	Returns data stored at the Key {k}.
Q_INVOKABLE void	clear ()
	\qmlmethod void QtMultimedia::mediaMetaData::clear() Removes all data from the MediaMetaData object.
Q_INVOKABLE bool	isEmpty () const
	\qmlmethod bool QtMultimedia::mediaMetaData::isEmpty() Returns `true` if the meta data contains no items: otherwise returns {false}.
Q_INVOKABLE QString	stringValue (Key k) const
	\qmlmethod string QtMultimedia::mediaMetaData::stringValue(Key key) Returns the meta data for key key as a QString.
QT_POST_CXX17_API_IN_EXPORTED_CLASS auto	asKeyValueRange () const
	\variable QMediaMetaData::data

Static Public Member Functions
static Q_INVOKABLE QString	metaDataKeyToString (Key k)
	\qmlmethod string QtMultimedia::mediaMetaData::metaDataKeyToString(Key key) returns a string representation of key that can be used when presenting meta data to users.

Static Public Attributes
static constexpr int	NumMetaData = HasHdrContent + 1

Static Protected Member Functions
static QMetaType	keyType (Key key)
	Returns the meta type used to store data for Key key.

Protected Attributes
QHash< Key, QVariant >	data

Friends
Q_MULTIMEDIA_EXPORT friend QDebug	operator<< (QDebug dbg, const QMediaMetaData &metaData)
bool	operator== (const QMediaMetaData &a, const QMediaMetaData &b)
	Compares two meta data objects a and b, and returns `true` if they are identical or `false` if they differ.
bool	operator!= (const QMediaMetaData &a, const QMediaMetaData &b)
	Compares two meta data objects a and b, and returns `false` if they are identical or `true` if they differ.

Detailed Description

\inmodule QtMultimedia

Provides meta-data for media files.

Note: Not all identifiers are supported on all platforms.

\table 60% \header

{3,1} Common attributes \header
Value
Description
Type \row
Title
The title of the media.
QString \row
Author
The authors of the media.
QStringList \row
Comment
A user comment about the media.
QString \row
Description
A description of the media.
QString \row
Genre
The genre of the media.
QStringList \row
Date
The date of the media.
QDateTime. \row
Language
The language of media.
QLocale::Language

\row

Publisher
The publisher of the media.
QString \row
Copyright
The media's copyright notice.
QString \row
Url
A Url pointing to the origin of the media.
QUrl

\header

{3,1} Media attributes \row
MediaType
The type of the media (audio, video, etc).
QString \row
FileFormat
The file format of the media.
QMediaFormat::FileFormat \row
Duration
The duration in milliseconds of the media.
qint64

\header

{3,1} Audio attributes \row
AudioBitRate
The bit rate of the media's audio stream in bits per second.
int \row
AudioCodec
The codec of the media's audio stream.
QMediaFormat::AudioCodec

\header

{3,1} Video attributes \row
VideoFrameRate
The frame rate of the media's video stream.
qreal \row
VideoBitRate
The bit rate of the media's video stream in bits per second.
int \row
VideoCodec
The codec of the media's video stream.
QMediaFormat::VideoCodec \row
HasHdrContent
True if video is intended for HDR display (FFmpeg and Darwin media backends only).
bool

\header

{3,1} Music attributes \row
AlbumTitle
The title of the album the media belongs to.
QString \row
AlbumArtist
The principal artist of the album the media belongs to.
QString \row
ContributingArtist
The artists contributing to the media.
QStringList \row
TrackNumber
The track number of the media.
int \row
Composer
The composer of the media.
QStringList \row
LeadPerformer
The lead performer in the media.
QStringList

\row

ThumbnailImage
An embedded thumbnail image if present in metadata.
QImage \row
CoverArtImage
An embedded cover art image.
QImage

\header

{3,1} Image and video attributes \row
Orientation
The rotation angle of an image or video.
int \row
Resolution
The dimensions of an image or video.
QSize

\endtable

Definition at line 18 of file qmediametadata.h.

Member Enumeration Documentation

◆ Key

enum QMediaMetaData::Key

Provides meta-data for media files.

\qmlvaluetype mediaMetaData
\ingroup qmlvaluetypes
\inqmlmodule QtMultimedia
\since 6.2

! \nativetype QMediaMetaData

Meta-data is supplementary data describing media. See QMediaMetaData for available meta data attributes.

The following meta data keys can be used:

\value Title Media title \value Author Media author \value Comment Comment \value Description Brief desripttion \value Genre Genre the media belongs to \value Date Creation date \value Language Media language \value Publisher Media publisher info. \value Copyright Media copyright info. \value Url Publisher's website URL \value Duration Media playback duration \value MediaType Type of the media \value FileFormat File format \value AudioBitRate \value AudioCodec \value VideoBitRate \value VideoCodec \value VideoFrameRate \value AlbumTitle Album's title \value AlbumArtist Artist's info. \value ContributingArtist \value TrackNumber \value Composer Media composer's info. \value LeadPerformer \value ThumbnailImage Media thumbnail image (if embedded in metadata) \value CoverArtImage Media cover art \value Orientation \value Resolution \value [since 6.8] HasHdrContent Video may have HDR content (read only, FFmpeg and Darwin media backends only)

Enumerator
Title
Author
Comment
Description
Genre
Date
Language
Publisher
Copyright
Url
Duration
MediaType
FileFormat
AudioBitRate
AudioCodec
VideoBitRate
VideoCodec
VideoFrameRate
AlbumTitle
AlbumArtist
ContributingArtist
TrackNumber
Composer
LeadPerformer
ThumbnailImage
CoverArtImage
Orientation
Resolution
HasHdrContent

Definition at line 22 of file qmediametadata.h.

Member Function Documentation

◆ asKeyValueRange()

QT_POST_CXX17_API_IN_EXPORTED_CLASS auto QMediaMetaData::asKeyValueRange ( ) const

inline

\variable QMediaMetaData::data

the meta data.

Note: this is a protected member of its class.

Since: 6.9

Returns a range object that allows iteration over this hash as key/value pairs.

Definition at line 79 of file qmediametadata.h.

◆ clear()

Q_INVOKABLE void QMediaMetaData::clear ( )

inline

\qmlmethod void QtMultimedia::mediaMetaData::clear() Removes all data from the MediaMetaData object.

Removes all data from the meta data object.

Definition at line 71 of file qmediametadata.h.

◆ insert()

Q_INVOKABLE void QMediaMetaData::insert	(	QMediaMetaData::Key	k,
		const QVariant &	value )

inline

\qmlmethod void QtMultimedia::mediaMetaData::insert(Key k, variant value) Inserts a value into a Key: {k}.

Inserts a value into a Key: {k}.

Definition at line 66 of file qmediametadata.h.

◆ isEmpty()

Q_INVOKABLE bool QMediaMetaData::isEmpty ( ) const

inline

\qmlmethod bool QtMultimedia::mediaMetaData::isEmpty() Returns true if the meta data contains no items: otherwise returns {false}.

Returns true if the meta data contains no items: otherwise returns {false}.

Definition at line 73 of file qmediametadata.h.

◆ keys()

Q_INVOKABLE QList< Key > QMediaMetaData::keys ( ) const

inline

\qmlmethod list<Key> QtMultimedia::mediaMetaData::keys() Returns a list of MediaMetaData.Keys.

Returns a QList of QMediaMetaData::Keys.

Definition at line 68 of file qmediametadata.h.

◆ keyType()

QMetaType QMediaMetaData::keyType ( Key key )

staticprotected

Returns the meta type used to store data for Key key.

Definition at line 83 of file qmediametadata.cpp.

◆ metaDataKeyToString()

QString QMediaMetaData::metaDataKeyToString ( QMediaMetaData::Key key )

static

\qmlmethod string QtMultimedia::mediaMetaData::metaDataKeyToString(Key key) returns a string representation of key that can be used when presenting meta data to users.

returns a string representation of key that can be used when presenting meta data to users.

Definition at line 431 of file qmediametadata.cpp.

◆ operator[]()

QVariant & QMediaMetaData::operator[] ( QMediaMetaData::Key k )

inline

Returns data stored at the Key {k}.

QMediaMetaData rockBallad1;

rockBalad[QMediaMetaData::Genre]="Rock"

QMediaMetaData

\inmodule QtMultimedia

Definition qmediametadata.h:19

QMediaMetaData::Genre

@ Genre

Definition qmediametadata.h:27

Definition at line 70 of file qmediametadata.h.

◆ remove()

Q_INVOKABLE void QMediaMetaData::remove ( QMediaMetaData::Key k )

inline

\qmlmethod void QtMultimedia::mediaMetaData::remove(Key k) Removes meta data from a Key: {k}.

Removes meta data from a Key: {k}.

Definition at line 67 of file qmediametadata.h.

◆ stringValue()

QString QMediaMetaData::stringValue ( QMediaMetaData::Key key ) const

\qmlmethod string QtMultimedia::mediaMetaData::stringValue(Key key) Returns the meta data for key key as a QString.

This is mainly meant to simplify presenting the meta data to a user.

Returns the meta data for key key as a QString.

This is mainly meant to simplify presenting the meta data to a user.

Definition at line 367 of file qmediametadata.cpp.

◆ value()

Q_INVOKABLE QVariant QMediaMetaData::value ( QMediaMetaData::Key key ) const

inline

\variable QMediaMetaData::NumMetaData

\qmlmethod variant QtMultimedia::mediaMetaData::value(Key key)

Returns the meta data value for Key key, or a null QVariant if no meta-data for the key is available.

Returns the meta data value for Key key, or a null QVariant if no meta data for the key is available.

Definition at line 65 of file qmediametadata.h.

◆ operator!=

bool operator!=	(	const QMediaMetaData &	a,
		const QMediaMetaData &	b )

friend

Compares two meta data objects a and b, and returns false if they are identical or true if they differ.

Definition at line 86 of file qmediametadata.h.

◆ operator<<

Q_MULTIMEDIA_EXPORT friend QDebug operator<<	(	QDebug	dbg,
		const QMediaMetaData &	metaData )

friend

Definition at line 496 of file qmediametadata.cpp.

◆ operator==

bool operator==	(	const QMediaMetaData &	a,
		const QMediaMetaData &	b )

friend

Compares two meta data objects a and b, and returns true if they are identical or false if they differ.

Definition at line 84 of file qmediametadata.h.

Member Data Documentation

◆ data

QHash<Key, QVariant> QMediaMetaData::data

protected

Definition at line 91 of file qmediametadata.h.

◆ NumMetaData

int QMediaMetaData::NumMetaData = HasHdrContent + 1

staticconstexpr

Definition at line 62 of file qmediametadata.h.

The documentation for this class was generated from the following files:

qtmultimedia/src/multimedia/qmediametadata.h (b3a89f7196dd054118e16786e5a88dd83e61c25a)
qtmultimedia/src/multimedia/qmediametadata.cpp (1f8ab55f55f705e4f86e8ff575e0c8a547263969)

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Static Protected Member Functions

Protected Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ Key

Member Function Documentation

◆ asKeyValueRange()

◆ clear()

◆ insert()

◆ isEmpty()

◆ keys()

◆ keyType()

◆ metaDataKeyToString()

◆ operator[]()

◆ remove()

◆ stringValue()

◆ value()

Friends And Related Symbol Documentation

◆ operator!=

◆ operator<<

◆ operator==

Member Data Documentation

◆ data

◆ NumMetaData