src/multimedia/qmediarecordercontrol.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 "qmediarecordercontrol.h"
       
    43 
       
    44 QT_BEGIN_NAMESPACE
       
    45 
       
    46 
       
    47 /*!
       
    48     \class QMediaRecorderControl
       
    49     \ingroup multimedia
       
    50 
       
    51     \preliminary
       
    52     \brief The QMediaRecorderControl class provides access to the recording
       
    53     functionality of a QMediaService.
       
    54 
       
    55     If a QMediaService can record media it will implement QMediaRecorderControl.
       
    56     This control provides a means to set the \l {outputLocation()}{output location},
       
    57     and \l {record()}{start}, \l {pause()}{pause} and \l {stop()}{stop}
       
    58     recording.  It also provides feedback on the \l {duration()}{duration}
       
    59     of the recording.
       
    60 
       
    61     The functionality provided by this control is exposed to application
       
    62     code through the QMediaRecorder class.
       
    63 
       
    64     The interface name of QMediaRecorderControl is \c com.nokia.Qt.QMediaRecorderControl/1.0 as
       
    65     defined in QMediaRecorderControl_iid.
       
    66 
       
    67     \sa QMediaService::requestControl(), QMediaRecorder
       
    68 
       
    69 */
       
    70 
       
    71 /*!
       
    72     \macro QMediaRecorderControl_iid
       
    73 
       
    74     \c com.nokia.Qt.QMediaRecorderControl/1.0
       
    75 
       
    76     Defines the interface name of the QMediaRecorderControl class.
       
    77 
       
    78     \relates QMediaRecorderControl
       
    79 */
       
    80 
       
    81 /*!
       
    82     Constructs a media recorder control with the given \a parent.
       
    83 */
       
    84 
       
    85 QMediaRecorderControl::QMediaRecorderControl(QObject* parent)
       
    86     : QMediaControl(parent)
       
    87 {
       
    88 }
       
    89 
       
    90 /*!
       
    91     Destroys a media recorder control.
       
    92 */
       
    93 
       
    94 QMediaRecorderControl::~QMediaRecorderControl()
       
    95 {
       
    96 }
       
    97 
       
    98 /*!
       
    99     \fn QUrl QMediaRecorderControl::outputLocation() const
       
   100 
       
   101     Returns the current output location being used.
       
   102 */
       
   103 
       
   104 /*!
       
   105     \fn bool QMediaRecorderControl::setOutputLocation(const QUrl &location)
       
   106 
       
   107     Sets the output \a location and returns if this operation is successful.
       
   108     If file at the output location already exists, it should be overwritten.
       
   109 
       
   110     The \a location can be relative or empty;
       
   111     in this case the service should use the system specific place and file naming scheme.
       
   112     After recording has stated, QMediaRecorderControl::outputLocation() should return the actual output location.
       
   113 */
       
   114 
       
   115 /*!
       
   116     \fn int QMediaRecorderControl::state() const
       
   117 
       
   118     Return the current recording state.
       
   119 */
       
   120 
       
   121 /*!
       
   122     \fn qint64 QMediaRecorderControl::duration() const
       
   123 
       
   124     Return the current duration in milliseconds.
       
   125 */
       
   126 
       
   127 /*!
       
   128     \fn void QMediaRecorderControl::record()
       
   129 
       
   130     Start recording.
       
   131 */
       
   132 
       
   133 /*!
       
   134     \fn void QMediaRecorderControl::pause()
       
   135 
       
   136     Pause recording.
       
   137 */
       
   138 
       
   139 /*!
       
   140     \fn void QMediaRecorderControl::stop()
       
   141 
       
   142     Stop recording.
       
   143 */
       
   144 
       
   145 /*!
       
   146     \fn void QMediaRecorderControl::applySettings()
       
   147 
       
   148     Commits the encoder settings and performs pre-initialization to reduce delays when recording
       
   149     is started.
       
   150 */
       
   151 
       
   152 /*!
       
   153     \fn bool QMediaRecorderControl::isMuted() const
       
   154 
       
   155     Returns true if the recorder is muted, and false if it is not.
       
   156 */
       
   157 
       
   158 /*!
       
   159     \fn void QMediaRecorderControl::setMuted(bool muted)
       
   160 
       
   161     Sets the \a muted state of a media recorder.
       
   162 */
       
   163 
       
   164 
       
   165 /*!
       
   166     \fn void QMediaRecorderControl::stateChanged(QMediaRecorder::State state)
       
   167 
       
   168     Signals that the \a state of a media recorder has changed.
       
   169 */
       
   170 
       
   171 /*!
       
   172     \fn void QMediaRecorderControl::durationChanged(qint64 duration)
       
   173 
       
   174     Signals that the \a duration of the recorded media has changed.
       
   175 
       
   176     This only emitted when there is a discontinuous change in the duration such as being reset to 0.
       
   177 */
       
   178 
       
   179 /*!
       
   180     \fn void QMediaRecorderControl::mutedChanged(bool muted)
       
   181 
       
   182     Signals that the \a muted state of a media recorder has changed.
       
   183 */
       
   184 
       
   185 /*!
       
   186     \fn void QMediaRecorderControl::error(int error, const QString &errorString)
       
   187 
       
   188     Signals that an \a error has occurred.  The \a errorString describes the error.
       
   189 */
       
   190 
       
   191 #include "moc_qmediarecordercontrol.cpp"
       
   192 QT_END_NAMESPACE
       
   193