1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#include <qcameraflashcontrol.h>
41#include "qmediacontrol_p.h"
42
43QT_BEGIN_NAMESPACE
44
45/*!
46 \class QCameraFlashControl
47 \obsolete
48
49 \brief The QCameraFlashControl class allows controlling a camera's flash.
50
51 \inmodule QtMultimedia
52
53
54 \ingroup multimedia_control
55
56 You can set the type of flash effect used when an image is captured, and test to see
57 if the flash hardware is ready to fire.
58
59 You can retrieve this control from the camera object in the usual way:
60
61 Some camera devices may not have flash hardware, or may not be configurable. In that
62 case, there will be no QCameraFlashControl available.
63
64 The interface name of QCameraFlashControl is \c org.qt-project.qt.cameraflashcontrol/5.0 as
65 defined in QCameraFlashControl_iid.
66
67 \sa QCamera
68*/
69
70/*!
71 \macro QCameraFlashControl_iid
72
73 \c org.qt-project.qt.cameraflashcontrol/5.0
74
75 Defines the interface name of the QCameraFlashControl class.
76
77 \relates QCameraFlashControl
78*/
79
80/*!
81 Constructs a camera flash control object with \a parent.
82*/
83QCameraFlashControl::QCameraFlashControl(QObject *parent):
84 QMediaControl(*new QMediaControlPrivate, parent)
85{
86}
87
88/*!
89 Destroys the camera control object.
90*/
91QCameraFlashControl::~QCameraFlashControl()
92{
93}
94
95/*!
96 \fn QCamera::FlashModes QCameraFlashControl::flashMode() const
97
98 Returns the current flash mode.
99*/
100
101/*!
102 \fn void QCameraFlashControl::setFlashMode(QCameraExposure::FlashModes mode)
103
104 Set the current flash \a mode.
105
106 Usually a single QCameraExposure::FlashMode flag is used,
107 but some non conflicting flags combination are also allowed,
108 like QCameraExposure::FlashManual | QCameraExposure::FlashSlowSyncRearCurtain.
109*/
110
111
112/*!
113 \fn QCameraFlashControl::isFlashModeSupported(QCameraExposure::FlashModes mode) const
114
115 Return true if the reqested flash \a mode is supported.
116 Some QCameraExposure::FlashMode values can be combined,
117 for example QCameraExposure::FlashManual | QCameraExposure::FlashSlowSyncRearCurtain
118*/
119
120/*!
121 \fn bool QCameraFlashControl::isFlashReady() const
122
123 Returns true if flash is charged.
124*/
125
126/*!
127 \fn void QCameraFlashControl::flashReady(bool ready)
128
129 Signal emitted when flash state changes to \a ready.
130*/
131
132QT_END_NAMESPACE
133
134#include "moc_qcameraflashcontrol.cpp"
135

source code of qtmultimedia/src/multimedia/controls/qcameraflashcontrol.cpp