Fix a number of doc errors and warnings.
* Document a few missing classes/functions/methods * Fix a number of QML snippets that wouldn't work as standalone snippets * Add files to .pro so they show up in Creator.. Still the mysterious lack of controls dir documentation persists :/ Change-Id: I57162371a4d966e4db5bdb1b71d1baf9c0ca57c3 Reviewed-by: Jonas Rabbe <jonas.rabbe@nokia.com>
This commit is contained in:
Michael Goddard
committed by
Qt by Nokia
Qt by Nokia
parent
9b162f9844
commit
8484b0ff9c
@@ -31,17 +31,14 @@ QT_BEGIN_NAMESPACE
|
||||
|
||||
/*!
|
||||
\namespace QtMultimedia
|
||||
\inheaderfile qtmedianamespace.h
|
||||
\ingroup multimedia
|
||||
\inmodule QtMultimedia
|
||||
|
||||
\ingroup multimedia
|
||||
\ingroup multimedia_core
|
||||
|
||||
\brief The QtMultimedia namespace contains miscellaneous identifiers used throughout the Qt Media services library.
|
||||
|
||||
QtMultimedia is a module containing the low level, low latency,
|
||||
Multimedia APIs which were introduced in Qt 4.6 and also includes the
|
||||
high level QtMultimedia APIs which were introduced in QtMobility 1.0.
|
||||
\brief The QtMultimedia namespace contains miscellaneous identifiers used throughout the Qt Multimedia library.
|
||||
|
||||
*/
|
||||
|
||||
@@ -196,162 +193,172 @@ Q_DEFINE_METADATA(ThumbnailImage);
|
||||
\note Not all identifiers are supported on all platforms. Please consult vendor documentation for specific support
|
||||
on different platforms.
|
||||
|
||||
\table 60%
|
||||
\header \li {3,1}
|
||||
Common attributes
|
||||
\value Title The title of the media. QString.
|
||||
\value SubTitle The sub-title of the media. QString.
|
||||
\value Author The authors of the media. QStringList.
|
||||
\value Comment A user comment about the media. QString.
|
||||
\value Description A description of the media. QString
|
||||
\value Category The category of the media. QStringList.
|
||||
\value Genre The genre of the media. QStringList.
|
||||
\value Year The year of release of the media. int.
|
||||
\value Date The date of the media. QDate.
|
||||
\value UserRating A user rating of the media. int [0..100].
|
||||
\value Keywords A list of keywords describing the media. QStringList.
|
||||
\value Language The language of media, as an ISO 639-2 code.
|
||||
\header \li Value \li Description \li Type
|
||||
\row \li Title \li The title of the media. \li QString
|
||||
\row \li SubTitle \li The sub-title of the media. \li QString
|
||||
\row \li Author \li The authors of the media. \li QStringList
|
||||
\row \li Comment \li A user comment about the media. \li QString
|
||||
\row \li Description \li A description of the media. \li QString
|
||||
\row \li Category \li The category of the media. \li QStringList
|
||||
\row \li Genre \li The genre of the media. \li QStringList
|
||||
\row \li Year \li The year of release of the media. \li int
|
||||
\row \li Date \li The date of the media. \li QDate.
|
||||
\row \li UserRating \li A user rating of the media. \li int [0..100]
|
||||
\row \li Keywords \li A list of keywords describing the media. \li QStringList
|
||||
\row \li Language \li The language of media, as an ISO 639-2 code. \li QString
|
||||
|
||||
\value Publisher The publisher of the media. QString.
|
||||
\value Copyright The media's copyright notice. QString.
|
||||
\value ParentalRating The parental rating of the media. QString.
|
||||
\value RatingOrganization The organization responsible for the parental rating of the media.
|
||||
QString.
|
||||
\row \li Publisher \li The publisher of the media. \li QString
|
||||
\row \li Copyright \li The media's copyright notice. \li QString
|
||||
\row \li ParentalRating \li The parental rating of the media. \li QString
|
||||
\row \li RatingOrganization \li The organization responsible for the parental rating of the media.
|
||||
\li QString
|
||||
|
||||
\header \li {3,1}
|
||||
Media attributes
|
||||
\value Size The size in bytes of the media. qint64
|
||||
\value MediaType The type of the media (audio, video, etc). QString.
|
||||
\value Duration The duration in millseconds of the media. qint64.
|
||||
\row \li Size \li The size in bytes of the media. \li qint64
|
||||
\row \li MediaType \li The type of the media (audio, video, etc). \li QString
|
||||
\row \li Duration \li The duration in millseconds of the media. \li qint64
|
||||
|
||||
\header \li {3,1}
|
||||
Audio attributes
|
||||
\value AudioBitRate The bit rate of the media's audio stream in bits per second. int.
|
||||
\value AudioCodec The codec of the media's audio stream. QString.
|
||||
\value AverageLevel The average volume level of the media. int.
|
||||
\value ChannelCount The number of channels in the media's audio stream. int.
|
||||
\value PeakValue The peak volume of the media's audio stream. int
|
||||
\value SampleRate The sample rate of the media's audio stream in hertz. int
|
||||
\row \li AudioBitRate \li The bit rate of the media's audio stream in bits per second. \li int
|
||||
\row \li AudioCodec \li The codec of the media's audio stream. \li QString
|
||||
\row \li AverageLevel \li The average volume level of the media. \li int
|
||||
\row \li ChannelCount \li The number of channels in the media's audio stream. \li int
|
||||
\row \li PeakValue \li The peak volume of the media's audio stream. \li int
|
||||
\row \li SampleRate \li The sample rate of the media's audio stream in hertz. \li int
|
||||
|
||||
\header \li {3,1}
|
||||
Music attributes
|
||||
\value AlbumTitle The title of the album the media belongs to. QString.
|
||||
\value AlbumArtist The principal artist of the album the media belongs to. QString.
|
||||
\value ContributingArtist The artists contributing to the media. QStringList.
|
||||
\value Composer The composer of the media. QStringList.
|
||||
\value Conductor The conductor of the media. QString.
|
||||
\value Lyrics The lyrics to the media. QString.
|
||||
\value Mood The mood of the media. QString.
|
||||
\value TrackNumber The track number of the media. int.
|
||||
\value TrackCount The number of tracks on the album containing the media. int.
|
||||
\row \li AlbumTitle \li The title of the album the media belongs to. \li QString
|
||||
\row \li AlbumArtist \li The principal artist of the album the media belongs to. \li QString
|
||||
\row \li ContributingArtist \li The artists contributing to the media. \li QStringList
|
||||
\row \li Composer \li The composer of the media. \li QStringList
|
||||
\row \li Conductor \li The conductor of the media. \li QString
|
||||
\row \li Lyrics \li The lyrics to the media. \li QString
|
||||
\row \li Mood \li The mood of the media. \li QString
|
||||
\row \li TrackNumber \li The track number of the media. \li int
|
||||
\row \li TrackCount \li The number of tracks on the album containing the media. \li int
|
||||
|
||||
\value CoverArtUrlSmall The URL of a small cover art image. QUrl.
|
||||
\value CoverArtUrlLarge The URL of a large cover art image. QUrl.
|
||||
\value CoverArtImage An embedded cover art image. QImage.
|
||||
\row \li CoverArtUrlSmall \li The URL of a small cover art image. \li QUrl
|
||||
\row \li CoverArtUrlLarge \li The URL of a large cover art image. \li QUrl
|
||||
\row \li CoverArtImage \li An embedded cover art image. \li QImage
|
||||
|
||||
\header \li {3,1}
|
||||
Image and video attributes
|
||||
\value Resolution The dimensions of an image or video. QSize.
|
||||
\value PixelAspectRatio The pixel aspect ratio of an image or video. QSize.
|
||||
\row \li Resolution \li The dimensions of an image or video. \li QSize
|
||||
\row \li PixelAspectRatio \li The pixel aspect ratio of an image or video. \li QSize
|
||||
|
||||
\header \li {3,1}
|
||||
Video attributes
|
||||
\value VideoFrameRate The frame rate of the media's video stream. qreal.
|
||||
\value VideoBitRate The bit rate of the media's video stream in bits per second. int.
|
||||
\value VideoCodec The codec of the media's video stream. QString.
|
||||
\row \li VideoFrameRate \li The frame rate of the media's video stream. \li qreal
|
||||
\row \li VideoBitRate \li The bit rate of the media's video stream in bits per second. \li int
|
||||
\row \li VideoCodec \li The codec of the media's video stream. \li QString
|
||||
|
||||
\value PosterUrl The URL of a poster image. QUrl.
|
||||
\value PosterImage An embedded poster image. QImage.
|
||||
\row \li PosterUrl \li The URL of a poster image. \li QUrl
|
||||
\row \li PosterImage \li An embedded poster image. \li QImage
|
||||
|
||||
\header \li {3,1}
|
||||
Movie attributes
|
||||
\value ChapterNumber The chapter number of the media. int.
|
||||
\value Director The director of the media. QString.
|
||||
\value LeadPerformer The lead performer in the media. QStringList.
|
||||
\value Writer The writer of the media. QStringList.
|
||||
\row \li ChapterNumber \li The chapter number of the media. \li int
|
||||
\row \li Director \li The director of the media. \li QString
|
||||
\row \li LeadPerformer \li The lead performer in the media. \li QStringList
|
||||
\row \li Writer \li The writer of the media. \li QStringList
|
||||
|
||||
\header \li {3,1}
|
||||
Photo attributes.
|
||||
\value CameraManufacturer The manufacturer of the camera used to capture the media. QString.
|
||||
\value CameraModel The model of the camera used to capture the media. QString.
|
||||
\value Event The event during which the media was captured. QString.
|
||||
\value Subject The subject of the media. QString.
|
||||
\value Orientation Orientation of image.
|
||||
\value ExposureTime Exposure time, given in seconds.
|
||||
\value FNumber The F Number.
|
||||
\value ExposureProgram
|
||||
The class of the program used by the camera to set exposure when the picture is taken.
|
||||
\value ISOSpeedRatings
|
||||
Indicates the ISO Speed and ISO Latitude of the camera or input device as specified in ISO 12232.
|
||||
\value ExposureBiasValue
|
||||
The exposure bias.
|
||||
The unit is the APEX (Additive System of Photographic Exposure) setting.
|
||||
\value DateTimeOriginal The date and time when the original image data was generated.
|
||||
\value DateTimeDigitized The date and time when the image was stored as digital data.
|
||||
\value SubjectDistance The distance to the subject, given in meters.
|
||||
\value MeteringMode The metering mode.
|
||||
\value LightSource
|
||||
The kind of light source.
|
||||
\value Flash
|
||||
Status of flash when the image was shot.
|
||||
\value FocalLength
|
||||
The actual focal length of the lens, in mm.
|
||||
\value ExposureMode
|
||||
Indicates the exposure mode set when the image was shot.
|
||||
\value WhiteBalance
|
||||
Indicates the white balance mode set when the image was shot.
|
||||
\value DigitalZoomRatio
|
||||
Indicates the digital zoom ratio when the image was shot.
|
||||
\value FocalLengthIn35mmFilm
|
||||
Indicates the equivalent focal length assuming a 35mm film camera, in mm.
|
||||
\value SceneCaptureType
|
||||
Indicates the type of scene that was shot.
|
||||
It can also be used to record the mode in which the image was shot.
|
||||
\value GainControl
|
||||
Indicates the degree of overall image gain adjustment.
|
||||
\value Contrast
|
||||
Indicates the direction of contrast processing applied by the camera when the image was shot.
|
||||
\value Saturation
|
||||
Indicates the direction of saturation processing applied by the camera when the image was shot.
|
||||
\value Sharpness
|
||||
Indicates the direction of sharpness processing applied by the camera when the image was shot.
|
||||
\value DeviceSettingDescription
|
||||
Exif tag, indicates information on the picture-taking conditions of a particular camera model. QString
|
||||
\row \li CameraManufacturer \li The manufacturer of the camera used to capture the media. \li QString
|
||||
\row \li CameraModel \li The model of the camera used to capture the media. \li QString
|
||||
\row \li Event \li The event during which the media was captured. \li QString
|
||||
\row \li Subject \li The subject of the media. \li QString
|
||||
\row \li Orientation \li Orientation of image. \li int (degrees)
|
||||
\row \li ExposureTime \li Exposure time, given in seconds. \li qreal
|
||||
\row \li FNumber \li The F Number. \li int
|
||||
\row \li ExposureProgram
|
||||
\li The class of the program used by the camera to set exposure when the picture is taken. \li QString
|
||||
\row \li ISOSpeedRatings
|
||||
\li Indicates the ISO Speed and ISO Latitude of the camera or input device as specified in ISO 12232. \li qreal
|
||||
\row \li ExposureBiasValue
|
||||
\li The exposure bias.
|
||||
The unit is the APEX (Additive System of Photographic Exposure) setting. \li qreal
|
||||
\row \li DateTimeOriginal \li The date and time when the original image data was generated. \li QDateTime
|
||||
\row \li DateTimeDigitized \li The date and time when the image was stored as digital data. \li QDateTime
|
||||
\row \li SubjectDistance \li The distance to the subject, given in meters. \li qreal
|
||||
\row \li MeteringMode \li The metering mode. \li QCameraExposure::MeteringMode
|
||||
\row \li LightSource
|
||||
\li The kind of light source. \li QString
|
||||
\row \li Flash
|
||||
\li Status of flash when the image was shot. \li QCameraExposure::FlashMode
|
||||
\row \li FocalLength
|
||||
\li The actual focal length of the lens, in mm. \li qreal
|
||||
\row \li ExposureMode
|
||||
\li Indicates the exposure mode set when the image was shot. \li QCameraExposure::ExposureMode
|
||||
\row \li WhiteBalance
|
||||
\li Indicates the white balance mode set when the image was shot. \li QCameraImageProcessing::WhiteBalanceMode
|
||||
\row \li DigitalZoomRatio
|
||||
\li Indicates the digital zoom ratio when the image was shot. \li qreal
|
||||
\row \li FocalLengthIn35mmFilm
|
||||
\li Indicates the equivalent focal length assuming a 35mm film camera, in mm. \li qreal
|
||||
\row \li SceneCaptureType
|
||||
\li Indicates the type of scene that was shot.
|
||||
It can also be used to record the mode in which the image was shot. \li QString
|
||||
\row \li GainControl
|
||||
\li Indicates the degree of overall image gain adjustment. \li qreal
|
||||
\row \li Contrast
|
||||
\li Indicates the direction of contrast processing applied by the camera when the image was shot. \li qreal
|
||||
\row \li Saturation
|
||||
\li Indicates the direction of saturation processing applied by the camera when the image was shot. \li qreal
|
||||
\row \li Sharpness
|
||||
\li Indicates the direction of sharpness processing applied by the camera when the image was shot. \li qreal
|
||||
\row \li DeviceSettingDescription
|
||||
\li Exif tag, indicates information on the picture-taking conditions of a particular camera model. \li QString
|
||||
|
||||
\value GPSLatitude
|
||||
Latitude value of the geographical position (decimal degrees).
|
||||
\row \li GPSLatitude
|
||||
\li Latitude value of the geographical position (decimal degrees).
|
||||
A positive latitude indicates the Northern Hemisphere,
|
||||
and a negative latitude indicates the Southern Hemisphere. double.
|
||||
\value GPSLongitude
|
||||
Longitude value of the geographical position (decimal degrees).
|
||||
and a negative latitude indicates the Southern Hemisphere. \li double
|
||||
\row \li GPSLongitude
|
||||
\li Longitude value of the geographical position (decimal degrees).
|
||||
A positive longitude indicates the Eastern Hemisphere,
|
||||
and a negative longitude indicates the Western Hemisphere. double.
|
||||
\value GPSAltitude
|
||||
The value of altitude in meters above sea level. double.
|
||||
\value GPSTimeStamp
|
||||
Time stamp of GPS data. QDateTime.
|
||||
\value GPSSatellites
|
||||
GPS satellites used for measurements. QString.
|
||||
\value GPSStatus
|
||||
Status of GPS receiver at image creation time. QString.
|
||||
\value GPSDOP
|
||||
Degree of precision for GPS data. qreal.
|
||||
\value GPSSpeed
|
||||
Speed of GPS receiver movement in kilometers per hour. qreal.
|
||||
\value GPSTrack
|
||||
Direction of GPS receiver movement. qreal.
|
||||
and a negative longitude indicates the Western Hemisphere. \li double
|
||||
\row \li GPSAltitude
|
||||
\li The value of altitude in meters above sea level. \li double
|
||||
\row \li GPSTimeStamp
|
||||
\li Time stamp of GPS data. \li QDateTime
|
||||
\row \li GPSSatellites
|
||||
\li GPS satellites used for measurements. \li QString
|
||||
\row \li GPSStatus
|
||||
\li Status of GPS receiver at image creation time. \li QString
|
||||
\row \li GPSDOP
|
||||
\li Degree of precision for GPS data. \li qreal
|
||||
\row \li GPSSpeed
|
||||
\li Speed of GPS receiver movement in kilometers per hour. \li qreal
|
||||
\row \li GPSTrack
|
||||
\li Direction of GPS receiver movement.
|
||||
The range of values is [0.0, 360),
|
||||
with 0 direction pointing on either true or magnetic north,
|
||||
depending on GPSTrackRef.
|
||||
\value GPSTrackRef
|
||||
Reference for movement direction. QChar.
|
||||
depending on GPSTrackRef. \li qreal
|
||||
\row \li GPSTrackRef
|
||||
\li Reference for movement direction. \li QChar.
|
||||
'T' means true direction and 'M' is magnetic direction.
|
||||
\value GPSImgDirection
|
||||
Direction of image when captured. qreal.
|
||||
\row \li GPSImgDirection
|
||||
\li Direction of image when captured. \li qreal
|
||||
The range of values is [0.0, 360).
|
||||
\value GPSImgDirectionRef
|
||||
Reference for image direction. QChar.
|
||||
\row \li GPSImgDirectionRef
|
||||
\li Reference for image direction. \li QChar.
|
||||
'T' means true direction and 'M' is magnetic direction.
|
||||
\value GPSMapDatum
|
||||
Geodetic survey data used by the GPS receiver. QString.
|
||||
\value GPSProcessingMethod
|
||||
The name of the method used for location finding. QString.
|
||||
\value GPSAreaInformation
|
||||
The name of the GPS area. QString
|
||||
\row \li GPSMapDatum
|
||||
\li Geodetic survey data used by the GPS receiver. \li QString
|
||||
\row \li GPSProcessingMethod
|
||||
\li The name of the method used for location finding. \li QString
|
||||
\row \li GPSAreaInformation
|
||||
\li The name of the GPS area. \li QString
|
||||
|
||||
|
||||
\value ThumbnailImage An embedded thumbnail image. QImage.
|
||||
\row \li ThumbnailImage \li An embedded thumbnail image. \li QImage
|
||||
\endtable
|
||||
*/
|
||||
|
||||
/*!
|
||||
|
||||
Reference in New Issue
Block a user