slapin/qtmultimedia
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix documentation for QML metaData property.

Browse Source 
For Audio, Video, MediaPlayer and Camera types.
Group the sub properties as a \qmlproperty group, which makes
the doc much clearer.

Change-Id: Id990d7b14a4c3f86768c6b3b4990845f84839944
Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
This commit is contained in:
Yoann Lopes
2015-08-10 16:40:38 +02:00
parent 6df6cacbb0
commit 68a09d3093
3 changed files with 139 additions and 1231 deletions
Download Patch File Download Diff File Expand all files Collapse all files

547
src/imports/multimedia/Video.qml
View File

@@ -236,7 +236,15 @@ Item {
*/
property alias hasVideo: player.hasVideo
/* documented below due to length of metaData documentation */
/*!
\qmlproperty object Video::metaData
This property holds the meta data for the current media.
See \l{MediaPlayer::metaData}{MediaPlayer.metaData} for details about each meta data key.
\sa {QMediaMetaData}
*/
property alias metaData: player.metaData
/*!
@@ -400,540 +408,3 @@ Item {
}
}
// ***************************************
// Documentation for meta-data properties.
// ***************************************
/*!
\qmlproperty variant Video::metaData
This property holds a collection of all the meta-data for the media.
You can access individual properties like \l {Video::metaData.title}{metaData.title}
or \l {Video::metaData.trackNumber} {metaData.trackNumber}.
*/
/*!
\qmlproperty variant Video::metaData.title
This property holds the title of the media.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.subTitle
This property holds the sub-title of the media.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.author
This property holds the author of the media.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.comment
This property holds a user comment about the media.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.description
This property holds a description of the media.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.category
This property holds the category of the media
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.genre
This property holds the genre of the media.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.year
This property holds the year of release of the media.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.date
This property holds the date of the media.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.userRating
This property holds a user rating of the media in the range of 0 to 100.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.keywords
This property holds a list of keywords describing the media.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.language
This property holds the language of the media, as an ISO 639-2 code.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.publisher
This property holds the publisher of the media.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.copyright
This property holds the media's copyright notice.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.parentalRating
This property holds the parental rating of the media.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.ratingOrganization
This property holds the name of the rating organization responsible for the
parental rating of the media.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.size
This property property holds the size of the media in bytes.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.mediaType
This property holds the type of the media.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.audioBitRate
This property holds the bit rate of the media's audio stream in bits per
second.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.audioCodec
This property holds the encoding of the media audio stream.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.averageLevel
This property holds the average volume level of the media.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.channelCount
This property holds the number of channels in the media's audio stream.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.peakValue
This property holds the peak volume of the media's audio stream.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.sampleRate
This property holds the sample rate of the media's audio stream in Hertz.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.albumTitle
This property holds the title of the album the media belongs to.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.albumArtist
This property holds the name of the principal artist of the album the media
belongs to.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.contributingArtist
This property holds the names of artists contributing to the media.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.composer
This property holds the composer of the media.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.conductor
This property holds the conductor of the media.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.lyrics
This property holds the lyrics to the media.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.mood
This property holds the mood of the media.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.trackNumber
This property holds the track number of the media.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.trackCount
This property holds the number of track on the album containing the media.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.coverArtUrlSmall
This property holds the URL of a small cover art image.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.coverArtUrlLarge
This property holds the URL of a large cover art image.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.resolution
This property holds the dimension of an image or video.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.pixelAspectRatio
This property holds the pixel aspect ratio of an image or video.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.videoFrameRate
This property holds the frame rate of the media's video stream.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.videoBitRate
This property holds the bit rate of the media's video stream in bits per
second.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.videoCodec
This property holds the encoding of the media's video stream.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.posterUrl
This property holds the URL of a poster image.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.chapterNumber
This property holds the chapter number of the media.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.director
This property holds the director of the media.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.leadPerformer
This property holds the lead performer in the media.
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.writer
This property holds the writer of the media.
\sa {QMediaMetaData}
*/
// The remaining properties are related to photos, and are technically
// available but will certainly never have values.
/*!
\qmlproperty variant Video::metaData.cameraManufacturer
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.cameraModel
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.event
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.subject
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.orientation
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.exposureTime
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.fNumber
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.exposureProgram
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.isoSpeedRatings
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.exposureBiasValue
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.dateTimeDigitized
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.subjectDistance
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.meteringMode
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.lightSource
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.flash
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.focalLength
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.exposureMode
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.whiteBalance
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.DigitalZoomRatio
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.focalLengthIn35mmFilm
\sa {QMediaMetaData::FocalLengthIn35mmFile}
*/
/*!
\qmlproperty variant Video::metaData.sceneCaptureType
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.gainControl
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.contrast
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.saturation
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.sharpness
\sa {QMediaMetaData}
*/
/*!
\qmlproperty variant Video::metaData.deviceSettingDescription
\sa {QMediaMetaData}
*/