1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL21$
** 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 Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/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 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qcamerafeedbackcontrol.h"
#include <private/qmediacontrol_p.h>
/*!
\class QCameraFeedbackControl
\brief The QCameraFeedbackControl class allows controlling feedback (sounds etc) during camera operation
\inmodule QtMultimedia
\ingroup multimedia_control
\since 5.0
When using a camera, there are several times when some form of feedback to
the user is given - for example, when an image is taken, or when recording is started.
You can enable or disable some of this feedback, or adjust what sound might be played
for these actions.
In some cases it may be undesirable to play a sound effect - for example, when initiating
video recording the sound itself may be recorded.
\note In some countries or regions, feedback sounds or other indications (e.g. a red light) are
mandatory during camera operation. In these cases, you can check \c isEventFeedbackLocked to check
if that type of feedback can be modified. Any attempts to change a locked feedback type will be
ignored.
The interface name of QCameraFeedbackControl is \c org.qt-project.qt.camerafeedbackcontrol/5.0 as
defined in QCameraFeedbackControl_iid.
\sa QCamera
*/
/*!
\enum QCameraFeedbackControl::EventType
This enumeration describes certain events that occur during camera usage. You
can associate some form of feedback to be given when the event occurs, or check
whether feedback for this event is enabled or locked so that changes cannot be made.
\value ViewfinderStarted The viewfinder stream was started (even if not visible)
\value ViewfinderStopped The viewfinder stream was stopped
\value ImageCaptured An image was captured but not yet fully processed
\value ImageSaved An image is fully available and saved somewhere.
\value ImageError An error occurred while capturing an image
\value RecordingStarted Video recording has started
\value RecordingInProgress Video recording is in progress
\value RecordingStopped Video recording has stopped
\value AutoFocusInProgress The camera is trying to automatically focus
\value AutoFocusLocked The camera has automatically focused successfully
\value AutoFocusFailed The camera was unable to focus automatically
*/
/*!
\macro QCameraFeedbackControl_iid
\c org.qt-project.qt.camerafeedbackcontrol/5.0
Defines the interface name of the QCameraFeedbackControl class.
\relates QCameraFeedbackControl
*/
/*!
Constructs a camera feedback control object with \a parent.
*/
QCameraFeedbackControl::QCameraFeedbackControl(QObject *parent):
QMediaControl(*new QMediaControlPrivate, parent)
{
}
/*!
Destroys the camera feedback control object.
*/
QCameraFeedbackControl::~QCameraFeedbackControl()
{
}
/*!
\fn bool QCameraFeedbackControl::isEventFeedbackLocked(EventType event) const
Returns true if the feedback setting for \a event is locked. This may be true
because of legal compliance issues, or because configurability of this event's
feedback is not supported.
\since 5.0
*/
/*!
\fn bool QCameraFeedbackControl::isEventFeedbackEnabled(EventType event) const
Returns true if the feedback for \a event is enabled.
\since 5.0
*/
/*!
\fn bool QCameraFeedbackControl::setEventFeedbackEnabled(EventType event, bool enabled)
Turns on feedback for the specific \a event if \a enabled is true, otherwise disables the
feedback. Returns true if the feedback could be modified, or false otherwise (e.g. this feedback
type is locked).
\since 5.0
*/
/*!
\fn void QCameraFeedbackControl::resetEventFeedback(EventType event)
Restores the feedback setting for this \a event to its default setting.
\since 5.0
*/
/*!
\fn bool QCameraFeedbackControl::setEventFeedbackSound(EventType event, const QString &filePath)
When the given \a event occurs, the sound effect referenced by \a filePath
will be played instead of the default sound.
If this feedback type is locked, or if the supplied path is inaccessible,
this function will return false. In addition, some forms of feedback may
be non-auditory (e.g. a red light, or a vibration), and false may be
returned in this case.
The file referenced should be linear PCM (WAV format).
\note In the case that a valid file path to an unsupported file is given, this
function will return true but the feedback will use the original setting.
\since 5.0
*/
|
