src/multimedia/qimageencodercontrol.cpp
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 #include "qimageencodercontrol.h"
       
    43 #include <QtCore/qstringlist.h>
       
    44 
       
    45 QT_BEGIN_NAMESPACE
       
    46 
       
    47 /*!
       
    48     \class QImageEncoderControl
       
    49     \preliminary
       
    50     \ingroup multimedia
       
    51 
       
    52     \brief The QImageEncoderControl class provides access to the settings of a media service that
       
    53     performs image encoding.
       
    54 
       
    55     If a QMediaService supports encoding image data it will implement QImageEncoderControl.
       
    56     This control allows to \l {setImageSettings()}{set image encoding settings} and
       
    57     provides functions for quering supported image \l {supportedImageCodecs()}{codecs} and
       
    58     \l {supportedResolutions()}{resolutions}.
       
    59 
       
    60     The interface name of QImageEncoderControl is \c com.nokia.Qt.QImageEncoderControl/1.0 as
       
    61     defined in QImageEncoderControl_iid.
       
    62 
       
    63     \sa QImageEncoderSettings, QMediaService::requestControl()
       
    64 */
       
    65 
       
    66 /*!
       
    67     \macro QImageEncoderControl_iid
       
    68 
       
    69     \c com.nokia.Qt.QImageEncoderControl/1.0
       
    70 
       
    71     Defines the interface name of the QImageEncoderControl class.
       
    72 
       
    73     \relates QImageEncoderControl
       
    74 */
       
    75 
       
    76 /*!
       
    77     Constructs a new image encoder control object with the given \a parent
       
    78 */
       
    79 QImageEncoderControl::QImageEncoderControl(QObject *parent)
       
    80     :QMediaControl(parent)
       
    81 {
       
    82 }
       
    83 
       
    84 /*!
       
    85     Destroys the image encoder control.
       
    86 */
       
    87 QImageEncoderControl::~QImageEncoderControl()
       
    88 {
       
    89 }
       
    90 
       
    91 /*!
       
    92     \fn QImageEncoderControl::supportedResolutions(const QImageEncoderSettings &settings = QImageEncoderSettings(),
       
    93                                                    bool *continuous = 0) const
       
    94 
       
    95     Returns a list of supported resolutions.
       
    96 
       
    97     If non null image \a settings parameter is passed,
       
    98     the returned list is reduced to resolutions supported with partial settings applied.
       
    99     It can be used to query the list of resolutions, supported by specific image codec.
       
   100 
       
   101     If the encoder supports arbitrary resolutions within the supported resolutions range,
       
   102     *\a continuous is set to true, otherwise *\a continuous is set to false.
       
   103 */
       
   104 
       
   105 /*!
       
   106     \fn QImageEncoderControl::supportedImageCodecs() const
       
   107 
       
   108     Returns a list of supported image codecs.
       
   109 */
       
   110 
       
   111 /*!
       
   112     \fn QImageEncoderControl::imageCodecDescription(const QString &codec) const
       
   113 
       
   114     Returns a description of an image \a codec.
       
   115 */
       
   116 
       
   117 /*!
       
   118     \fn QImageEncoderControl::imageSettings() const
       
   119 
       
   120     Returns the currently used image encoder settings.
       
   121 */
       
   122 
       
   123 /*!
       
   124     \fn QImageEncoderControl::setImageSettings(const QImageEncoderSettings &settings)
       
   125 
       
   126     Sets the selected image encoder \a settings.
       
   127 */
       
   128 
       
   129 #include "moc_qimageencodercontrol.cpp"
       
   130 QT_END_NAMESPACE
       
   131