qtmobility/src/multimedia/qvideooutputcontrol.cpp
changeset 14 6fbed849b4f4
parent 11 06b8e2af4411
child 15 1f895d8a5b2b
equal deleted inserted replaced
11:06b8e2af4411 14:6fbed849b4f4
     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 "qvideooutputcontrol.h"
       
    43 
       
    44 QT_BEGIN_NAMESPACE
       
    45 
       
    46 /*!
       
    47     \class QVideoOutputControl
       
    48     \preliminary
       
    49 
       
    50     \brief The QVideoOutputControl class provides a means of selecting the
       
    51     active video output control.
       
    52 
       
    53     \ingroup multimedia-serv
       
    54 
       
    55     There are multiple controls which a QMediaService may use to output
       
    56     video ony one of which may be active at one time, QVideoOutputControl
       
    57     is the means by which this active control is selected.
       
    58 
       
    59     The possible output controls are QVideoRendererControl,
       
    60     QVideoWindowControl, and QVideoWidgetControl.
       
    61 
       
    62     The interface name of QVideoOutputControl is \c com.nokia.Qt.QVideoOutputControl/1.0 as
       
    63     defined in QVideoOutputControl_iid.
       
    64 
       
    65     \sa QMediaService::control(), QVideoWidget, QVideoRendererControl,
       
    66     QVideoWindowControl, QVideoWidgetControl
       
    67 */
       
    68 
       
    69 /*!
       
    70     \macro QVideoOutputControl_iid
       
    71 
       
    72     \c com.nokia.Qt.QVideoOutputControl/1.0
       
    73 
       
    74     Defines the interface name of the QVideoOutputControl class.
       
    75 
       
    76     \relates QVideoOutputControl
       
    77 */
       
    78 
       
    79 /*!
       
    80     \enum QVideoOutputControl::Output
       
    81 
       
    82     Identifies the possible render targets of a video output.
       
    83 
       
    84     \value NoOutput Video is not rendered.
       
    85     \value WindowOutput Video is rendered to the target of a QVideoWindowControl.
       
    86     \value RendererOutput Video is rendered to the target of a QVideoRendererControl.
       
    87     \value WidgetOutput Video is rendered to a QWidget provided by QVideoWidgetControl.
       
    88     \value UserOutput Start value for user defined video targets.
       
    89     \value MaxUserOutput End value for user defined video targets.
       
    90 */
       
    91 
       
    92 /*!
       
    93     Constructs a new video output control with the given \a parent.
       
    94 */
       
    95 QVideoOutputControl::QVideoOutputControl(QObject *parent)
       
    96     : QMediaControl(parent)
       
    97 {
       
    98 }
       
    99 
       
   100 /*!
       
   101     Destroys a video output control.
       
   102 */
       
   103 QVideoOutputControl::~QVideoOutputControl()
       
   104 {
       
   105 }
       
   106 
       
   107 /*!
       
   108     \fn QList<QVideoOutputControl::Output> QVideoOutputControl::availableOutputs() const
       
   109 
       
   110     Returns a list of available video output targets.
       
   111 */
       
   112 
       
   113 /*!
       
   114     \fn QVideoOutputControl::output() const
       
   115 
       
   116     Returns the current video output target.
       
   117 */
       
   118 
       
   119 /*!
       
   120     \fn QVideoOutputControl::setOutput(Output output)
       
   121 
       
   122     Sets the current video \a output target.
       
   123 */
       
   124 
       
   125 /*!
       
   126     \fn QVideoOutputControl::availableOutputsChanged(const QList<QVideoOutputControl::Output>  &outputs)
       
   127 
       
   128     Signals that available set of video \a outputs has changed.
       
   129 */
       
   130 
       
   131 #include "moc_qvideooutputcontrol.cpp"
       
   132 QT_END_NAMESPACE
       
   133