src/multimedia/qtmedianamespace.qdoc
changeset 0 876b1a06bc25
equal deleted inserted replaced
-1:000000000000 0:876b1a06bc25
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the Qt Mobility Components.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    33 **
       
    34 **
       
    35 **
       
    36 **
       
    37 **
       
    38 ** $QT_END_LICENSE$
       
    39 **
       
    40 ****************************************************************************/
       
    41 
       
    42 /*!
       
    43     \namespace QtMultimediaKit
       
    44     \ingroup multimedia
       
    45 
       
    46     \brief The QtMultimediaKit namespace contains miscellaneous identifiers used throughout the Qt Media
       
    47     services library.
       
    48 */
       
    49 
       
    50 /*!
       
    51     \enum QtMultimediaKit::MetaData
       
    52 
       
    53     This enum provides identifiers for meta-data attributes.
       
    54 
       
    55     Common attributes
       
    56     \value Title The title of the media.  QString.
       
    57     \value SubTitle The sub-title of the media. QString.
       
    58     \value Author The authors of the media. QStringList.
       
    59     \value Comment A user comment about the media. QString.
       
    60     \value Description A description of the media.  QString
       
    61     \value Category The category of the media.  QStringList.
       
    62     \value Genre The genre of the media.  QStringList.
       
    63     \value Year The year of release of the media.  int.
       
    64     \value Date The date of the media. QDate.
       
    65     \value UserRating A user rating of the media. int [0..100].
       
    66     \value Keywords A list of keywords describing the media.  QStringList.
       
    67     \value Language The language of media, as an ISO 639-2 code.
       
    68 
       
    69     \value Publisher The publisher of the media.  QString.
       
    70     \value Copyright The media's copyright notice.  QString.
       
    71     \value ParentalRating  The parental rating of the media.  QString.
       
    72     \value RatingOrganisation The organisation responsible for the parental rating of the media.
       
    73     QString.
       
    74 
       
    75     Media attributes
       
    76     \value Size The size in bytes of the media. qint64
       
    77     \value MediaType The type of the media (audio, video, etc).  QString.
       
    78     \value Duration The duration in millseconds of the media.  qint64.
       
    79 
       
    80     Audio attributes
       
    81     \value AudioBitRate The bit rate of the media's audio stream in bits per second.  int.
       
    82     \value AudioCodec The codec of the media's audio stream.  QString.
       
    83     \value AverageLevel The average volume level of the media.  int.
       
    84     \value ChannelCount The number of channels in the media's audio stream. int.
       
    85     \value PeakValue The peak volume of the media's audio stream. int
       
    86     \value SampleRate The sample rate of the media's audio stream in hertz. int
       
    87 
       
    88     Music attributes
       
    89     \value AlbumTitle The title of the album the media belongs to.  QString.
       
    90     \value AlbumArtist The principal artist of the album the media belongs to.  QString.
       
    91     \value ContributingArtist The artists contributing to the media.  QStringList.
       
    92     \value Composer The composer of the media.  QStringList.
       
    93     \value Conductor The conductor of the media. QString.
       
    94     \value Lyrics The lyrics to the media. QString.
       
    95     \value Mood The mood of the media.  QString.
       
    96     \value TrackNumber The track number of the media.  int.
       
    97     \value TrackCount The number of tracks on the album containing the media.  int.
       
    98 
       
    99     \value CoverArtUrlSmall The URL of a small cover art image. QUrl.
       
   100     \value CoverArtUrlLarge The URL of a large cover art image. QUrl.
       
   101     \value CoverArtImage An embedded cover art image. QImage.
       
   102 
       
   103     Image and video attributes
       
   104     \value Resolution The dimensions of an image or video.  QSize.
       
   105     \value PixelAspectRatio The pixel aspect ratio of an image or video.  QSize.
       
   106 
       
   107     Video attributes
       
   108     \value VideoFrameRate The frame rate of the media's video stream.  qreal.
       
   109     \value VideoBitRate The bit rate of the media's video stream in bits per second.  int.
       
   110     \value VideoCodec The codec of the media's video stream.  QString.
       
   111 
       
   112     \value PosterUrl The URL of a poster image.  QUrl.
       
   113     \value PosterImage An embedded poster image.  QImage.
       
   114 
       
   115     Movie attributes
       
   116     \value ChapterNumber The chapter number of the media.  int.
       
   117     \value Director The director of the media.  QString.
       
   118     \value LeadPerformer The lead performer in the media.  QStringList.
       
   119     \value Writer The writer of the media.  QStringList.
       
   120 
       
   121     Photo attributes.
       
   122     \value CameraManufacturer The manufacturer of the camera used to capture the media.  QString.
       
   123     \value CameraModel The model of the camera used to capture the media.  QString.
       
   124     \value Event The event during which the media was captured.  QString.
       
   125     \value Subject The subject of the media.  QString.
       
   126     \value Orientation Orientation of image.
       
   127     \value ExposureTime Exposure time, given in seconds.
       
   128     \value FNumber The F Number.
       
   129     \value ExposureProgram
       
   130         The class of the program used by the camera to set exposure when the picture is taken.
       
   131     \value ISOSpeedRatings
       
   132         Indicates the ISO Speed and ISO Latitude of the camera or input device as specified in ISO 12232.
       
   133     \value ExposureBiasValue
       
   134         The exposure bias.
       
   135         The unit is the APEX (Additive System of Photographic Exposure) setting.
       
   136     \value DateTimeOriginal The date and time when the original image data was generated.
       
   137     \value DateTimeDigitized The date and time when the image was stored as digital data.
       
   138     \value SubjectDistance The distance to the subject, given in meters.
       
   139     \value MeteringMode The metering mode.
       
   140     \value LightSource
       
   141         The kind of light source.
       
   142     \value Flash
       
   143         Status of flash when the image was shot.
       
   144     \value FocalLength
       
   145         The actual focal length of the lens, in mm.
       
   146     \value ExposureMode
       
   147         Indicates the exposure mode set when the image was shot.
       
   148     \value WhiteBalance
       
   149         Indicates the white balance mode set when the image was shot.
       
   150     \value DigitalZoomRatio
       
   151         Indicates the digital zoom ratio when the image was shot.
       
   152     \value FocalLengthIn35mmFilm
       
   153         Indicates the equivalent focal length assuming a 35mm film camera, in mm.
       
   154     \value SceneCaptureType
       
   155         Indicates the type of scene that was shot.
       
   156         It can also be used to record the mode in which the image was shot.
       
   157     \value GainControl
       
   158         Indicates the degree of overall image gain adjustment.
       
   159     \value Contrast
       
   160         Indicates the direction of contrast processing applied by the camera when the image was shot.
       
   161     \value Saturation
       
   162         Indicates the direction of saturation processing applied by the camera when the image was shot.
       
   163     \value Sharpness
       
   164         Indicates the direction of sharpness processing applied by the camera when the image was shot.
       
   165     \value DeviceSettingDescription
       
   166         Exif tag, indicates information on the picture-taking conditions of a particular camera model. QString
       
   167 
       
   168     \value ThumbnailImage An embedded thumbnail image.  QImage.
       
   169 */
       
   170 
       
   171 /*!
       
   172     \enum QtMultimediaKit::SupportEstimate
       
   173 
       
   174     Enumerates the levels of support a media service provider may have for a feature.
       
   175 
       
   176     \value NotSupported The feature is not supported.
       
   177     \value MaybeSupported The feature may be supported.
       
   178     \value ProbablySupported The feature is probably supported.
       
   179     \value PreferredService The service is the preferred provider of a service.
       
   180 */
       
   181 
       
   182 /*!
       
   183     \enum QtMultimediaKit::EncodingQuality
       
   184 
       
   185     Enumerates quality encoding levels.
       
   186 
       
   187     \value VeryLowQuality
       
   188     \value LowQuality
       
   189     \value NormalQuality
       
   190     \value HighQuality
       
   191     \value VeryHighQuality
       
   192 */
       
   193 
       
   194 /*!
       
   195     \enum QtMultimediaKit::EncodingMode
       
   196 
       
   197     Enumerates encoding modes.
       
   198 
       
   199     \value ConstantQualityEncoding
       
   200     \value ConstantBitRateEncoding
       
   201     \value AverageBitRateEncoding
       
   202     \value TwoPassEncoding
       
   203 */
       
   204 
       
   205 /*!
       
   206     \enum QtMultimediaKit::AvailabilityError
       
   207 
       
   208     Enumerates Service status errors.
       
   209 
       
   210     \value NoError The service is operating correctly.
       
   211     \value ServiceMissingError There is no service available to provide the requested functionality.
       
   212     \value ResourceError The service could not allocate resources required to function correctly.
       
   213     \value BusyError The service must wait for access to necessary resources.
       
   214 */