qtmobility/src/multimedia/qmediastreamscontrol.cpp
changeset 1 2b40d63a9c3d
child 5 453da2cfceef
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 "qmediastreamscontrol.h"
       
    43 #include "qmediacontrol_p.h"
       
    44 
       
    45 QTM_BEGIN_NAMESPACE
       
    46 
       
    47 /*!
       
    48     \class QMediaStreamsControl
       
    49     \preliminary
       
    50     \ingroup multimedia-serv
       
    51     \brief The QMediaStreamsControl class provides a media stream selection control.
       
    52 
       
    53     \ingroup multimedia
       
    54 
       
    55     The QMediaStreamsControl class provides descriptions of the available media streams
       
    56     and allows individual streams to be activated and deactivated.
       
    57 
       
    58     The interface name of QMediaStreamsControl is \c com.nokia.Qt.MediaStreamsControl as
       
    59     defined in QMediaStreamsControl_iid.
       
    60 
       
    61     \sa QMediaService::control()
       
    62 */
       
    63 
       
    64 /*!
       
    65     \macro QMediaStreamsControl_iid
       
    66 
       
    67     \c com.nokia.Qt.MediaStreamsControl
       
    68 
       
    69     Defines the interface name of the QMediaStreamsControl class.
       
    70 
       
    71     \relates QMediaStreamsControl
       
    72 */
       
    73 
       
    74 /*!
       
    75     Constructs a new media streams control with the given \a parent.
       
    76 */
       
    77 QMediaStreamsControl::QMediaStreamsControl(QObject *parent)
       
    78     :QMediaControl(*new QMediaControlPrivate, parent)
       
    79 {
       
    80 }
       
    81 
       
    82 /*!
       
    83     Destroys a media streams control.
       
    84 */
       
    85 QMediaStreamsControl::~QMediaStreamsControl()
       
    86 {
       
    87 }
       
    88 
       
    89 /*!
       
    90   \enum QMediaStreamsControl::StreamType
       
    91 
       
    92   Media stream type.
       
    93 
       
    94   \value AudioStream Audio stream.
       
    95   \value VideoStream Video stream.
       
    96   \value SubPictureStream Subpicture or teletext stream.
       
    97   \value UnknownStream The stream type is unknown.
       
    98   \value DataStream
       
    99 */
       
   100 
       
   101 /*!
       
   102     \fn QMediaStreamsControl::streamCount()
       
   103 
       
   104     Returns the number of media streams.
       
   105 */
       
   106 
       
   107 /*!
       
   108     \fn QMediaStreamsControl::streamType(int stream)
       
   109 
       
   110     Return the type of a media \a stream.
       
   111 */
       
   112 
       
   113 /*!
       
   114     \fn QMediaStreamsControl::metaData(int stream, QtMedia::MetaData key)
       
   115 
       
   116     Returns the meta-data value of \a key for a given \a stream.
       
   117 
       
   118     Useful metadata keya are QtMedia::Title, QtMedia::Description and QtMedia::Language.
       
   119 */
       
   120 
       
   121 /*!
       
   122     \fn QMediaStreamsControl::isActive(int stream)
       
   123 
       
   124     Returns true if the media \a stream is active.
       
   125 */
       
   126 
       
   127 /*!
       
   128     \fn QMediaStreamsControl::setActive(int stream, bool state)
       
   129 
       
   130     Sets the active \a state of a media \a stream.
       
   131 
       
   132     Setting the active state of a media stream to true will activate it.  If any other stream
       
   133     of the same type was previously active it will be deactivated. Setting the active state fo a
       
   134     media stream to false will deactivate it.
       
   135 */
       
   136 
       
   137 /*!
       
   138     \fn QMediaStreamsControl::streamsChanged()
       
   139 
       
   140     The signal is emited when the available streams list is changed.
       
   141 */
       
   142 
       
   143 /*!
       
   144     \fn QMediaStreamsControl::activeStreamsChanged()
       
   145 
       
   146     The signal is emited when the active streams list is changed.
       
   147 */
       
   148 
       
   149 #include "moc_qmediastreamscontrol.cpp"
       
   150 QTM_END_NAMESPACE
       
   151