qtmobility/src/multimedia/qvideorenderercontrol.cpp
changeset 1 2b40d63a9c3d
child 4 90517678cc4f
equal deleted inserted replaced
0:cfcbf08528c4 1:2b40d63a9c3d
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 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 <qvideorenderercontrol.h>
       
    43 
       
    44 #include <qmediacontrol_p.h>
       
    45 
       
    46 QTM_BEGIN_NAMESPACE
       
    47 
       
    48 /*!
       
    49     \class QVideoRendererControl
       
    50     \preliminary
       
    51 
       
    52     \brief The QVideoRendererControl class provides a control for rendering
       
    53     to a video surface.
       
    54 
       
    55     \ingroup multimedia-serv
       
    56 
       
    57     Using the surface() property of QVideoRendererControl a QAbstractVideoSurface
       
    58     may be set as the video render target of a QMediaService.
       
    59 
       
    60     \code
       
    61     QVideoRendererControl *rendererControl = mediaService->control<QVideoRendererControl *>();
       
    62     rendererControl->setSurface(myVideoSurface);
       
    63     \endcode
       
    64 
       
    65     QVideoRendererControl is one of number of possible video output controls,
       
    66     in order to receive video it must be made the active video output
       
    67     control by setting the output property of QVideoOutputControl to
       
    68     \l {QVideoOutputControl::RendererOutput}{RendererOutput}. Consequently any
       
    69     QMediaService that implements QVideoRendererControl must also implement
       
    70     QVideoOutputControl.
       
    71 
       
    72     \code
       
    73     QVideoOutputControl *outputControl = mediaService->control<QVideoOutputControl *>();
       
    74     outputControl->setOutput(QVideoOutputControl::RendererOutput);
       
    75     \endcode
       
    76 
       
    77     The interface name of QVideoRendererControl is \c com.nokia.Qt.QVideoRendererControl/1.0 as
       
    78     defined in QVideoRendererControl_iid.
       
    79 
       
    80     \sa QMediaService::control(), QVideoOutputControl, QVideoWidget
       
    81 */
       
    82 
       
    83 /*!
       
    84     \macro QVideoRendererControl_iid
       
    85 
       
    86     \c com.nokia.Qt.QVideoRendererControl/1.0
       
    87 
       
    88     Defines the interface name of the QVideoRendererControl class.
       
    89 
       
    90     \relates QVideoRendererControl
       
    91 */
       
    92 
       
    93 /*!
       
    94     Constructs a new video renderer media end point with the given \a parent.
       
    95 */
       
    96 QVideoRendererControl::QVideoRendererControl(QObject *parent)
       
    97     : QMediaControl(parent)
       
    98 {
       
    99 }
       
   100 
       
   101 /*!
       
   102     Destroys a video renderer media end point.
       
   103 */
       
   104 QVideoRendererControl::~QVideoRendererControl()
       
   105 {
       
   106 }
       
   107 
       
   108 /*!
       
   109     \fn QVideoRendererControl::surface() const
       
   110 
       
   111     Returns the surface a video producer renders to.
       
   112 */
       
   113 
       
   114 /*!
       
   115     \fn QVideoRendererControl::setSurface(QAbstractVideoSurface *surface)
       
   116 
       
   117     Sets the \a surface a video producer renders to.
       
   118 */
       
   119 
       
   120 #include "moc_qvideorenderercontrol.cpp"
       
   121 QTM_END_NAMESPACE
       
   122