blob: 7f72c620e02aae618a393b8c4aafdad1a4a99366 [file] [log] [blame]
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qvideowidgetcontrol.h"
#include "private/qmediacontrol_p.h"
QT_BEGIN_NAMESPACE
/*!
\class QVideoWidgetControl
\brief The QVideoWidgetControl class provides a media control which
implements a video widget.
\inmodule QtMultimediaWidgets
\ingroup multimedia-serv
The videoWidget() property of QVideoWidgetControl provides a pointer to a
video widget implemented by the control's media service. This widget is
owned by the media service and so care should be taken not to delete it.
\snippet multimedia-snippets/video.cpp Video widget control
QVideoWidgetControl is one of number of possible video output controls.
The interface name of QVideoWidgetControl is \c org.qt-project.qt.videowidgetcontrol/5.0 as
defined in QVideoWidgetControl_iid.
\sa QMediaService::requestControl(), QVideoWidget
*/
/*!
\macro QVideoWidgetControl_iid
\c org.qt-project.qt.videowidgetcontrol/5.0
Defines the interface name of the QVideoWidgetControl class.
\relates QVideoWidgetControl
*/
/*!
Constructs a new video widget control with the given \a parent.
*/
QVideoWidgetControl::QVideoWidgetControl(QObject *parent)
:QMediaControl(parent)
{
}
/*!
Destroys a video widget control.
*/
QVideoWidgetControl::~QVideoWidgetControl()
{
}
/*!
\fn QVideoWidgetControl::isFullScreen() const
Returns true if the video is shown using the complete screen.
*/
/*!
\fn QVideoWidgetControl::setFullScreen(bool fullScreen)
Sets whether a video widget is in \a fullScreen mode.
*/
/*!
\fn QVideoWidgetControl::fullScreenChanged(bool fullScreen)
Signals that the \a fullScreen state of a video widget has changed.
*/
/*!
\fn QVideoWidgetControl::aspectRatioMode() const
Returns how video is scaled to fit the widget with respect to its aspect ratio.
*/
/*!
\fn QVideoWidgetControl::setAspectRatioMode(Qt::AspectRatioMode mode)
Sets the aspect ratio \a mode which determines how video is scaled to the fit the widget with
respect to its aspect ratio.
*/
/*!
\fn QVideoWidgetControl::brightness() const
Returns the brightness adjustment applied to a video.
Valid brightness values range between -100 and 100, the default is 0.
*/
/*!
\fn QVideoWidgetControl::setBrightness(int brightness)
Sets a \a brightness adjustment for a video.
Valid brightness values range between -100 and 100, the default is 0.
*/
/*!
\fn QVideoWidgetControl::brightnessChanged(int brightness)
Signals that a video widget's \a brightness adjustment has changed.
*/
/*!
\fn QVideoWidgetControl::contrast() const
Returns the contrast adjustment applied to a video.
Valid contrast values range between -100 and 100, the default is 0.
*/
/*!
\fn QVideoWidgetControl::setContrast(int contrast)
Sets the contrast adjustment for a video widget to \a contrast.
Valid contrast values range between -100 and 100, the default is 0.
*/
/*!
\fn QVideoWidgetControl::contrastChanged(int contrast)
Signals that a video widget's \a contrast adjustment has changed.
*/
/*!
\fn QVideoWidgetControl::hue() const
Returns the hue adjustment applied to a video widget.
Value hue values range between -100 and 100, the default is 0.
*/
/*!
\fn QVideoWidgetControl::setHue(int hue)
Sets a \a hue adjustment for a video widget.
Valid hue values range between -100 and 100, the default is 0.
*/
/*!
\fn QVideoWidgetControl::hueChanged(int hue)
Signals that a video widget's \a hue adjustment has changed.
*/
/*!
\fn QVideoWidgetControl::saturation() const
Returns the saturation adjustment applied to a video widget.
Value saturation values range between -100 and 100, the default is 0.
*/
/*!
\fn QVideoWidgetControl::setSaturation(int saturation)
Sets a \a saturation adjustment for a video widget.
Valid saturation values range between -100 and 100, the default is 0.
*/
/*!
\fn QVideoWidgetControl::saturationChanged(int saturation)
Signals that a video widget's \a saturation adjustment has changed.
*/
/*!
\fn QVideoWidgetControl::videoWidget()
Returns the QWidget.
*/
QT_END_NAMESPACE
#include "moc_qvideowidgetcontrol.cpp"