/usr/share/qt5/doc/qtmultimedia/qcamerafeedbackcontrol.html is in qtmultimedia5-doc-html 5.2.1-0ubuntu5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qcamerafeedbackcontrol.cpp -->
<title>QCameraFeedbackControl Class | QtMultimedia 5.2</title>
<link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
<div class="main">
<div class="main-rounded">
<div class="navigationbar">
<ul>
<li>Qt 5.2</li>
<li><a href="qtmultimedia-index.html">Qt Multimedia</a></li>
<li><a href="qtmultimedia-module.html">C++ Classes</a></li>
<li>QCameraFeedbackControl</li>
<li id="buildversion">
Qt 5.2.1 Reference Documentation</li>
</ul>
</div>
</div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#protected-functions">Protected Functions</a></li>
<li class="level1"><a href="#macros">Macros</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QCameraFeedbackControl Class</h1>
<!-- $$$QCameraFeedbackControl-brief -->
<p>The QCameraFeedbackControl class allows controlling feedback (sounds etc) during camera operation <a href="#details">More...</a></p>
<!-- @@@QCameraFeedbackControl -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include <QCameraFeedbackControl></span>
</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> qmake:</td><td class="memItemRight bottomAlign"> <tt>QT += multimedia</tt></td></tr><tr><td class="memItemLeft rightAlign topAlign"> Since:</td><td class="memItemRight bottomAlign"> Qt 5.0</td></tr><tr><td class="memItemLeft rightAlign topAlign"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qmediacontrol.html">QMediaControl</a>.</td></tr></table><ul>
<li><a href="qcamerafeedbackcontrol-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qcamerafeedbackcontrol.html#EventType-enum">EventType</a></b> { ViewfinderStarted, ViewfinderStopped, ImageCaptured, ImageSaved, ..., AutoFocusFailed }</td></tr>
</table>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcamerafeedbackcontrol.html#dtor.QCameraFeedbackControl">~QCameraFeedbackControl</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qcamerafeedbackcontrol.html#isEventFeedbackEnabled">isEventFeedbackEnabled</a></b>(EventType<i> event</i>) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qcamerafeedbackcontrol.html#isEventFeedbackLocked">isEventFeedbackLocked</a></b>(EventType<i> event</i>) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qcamerafeedbackcontrol.html#resetEventFeedback">resetEventFeedback</a></b>(EventType<i> event</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qcamerafeedbackcontrol.html#setEventFeedbackEnabled">setEventFeedbackEnabled</a></b>(EventType<i> event</i>, bool<i> enabled</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual bool </td><td class="memItemRight bottomAlign"><b><a href="qcamerafeedbackcontrol.html#setEventFeedbackSound">setEventFeedbackSound</a></b>(EventType<i> event</i>, const QString &<i> filePath</i>) = 0</td></tr>
</table>
<a name="protected-functions"></a>
<h2>Protected Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcamerafeedbackcontrol.html#QCameraFeedbackControl">QCameraFeedbackControl</a></b>(QObject *<i> parent</i> = 0)</td></tr>
</table>
<a name="macros"></a>
<h2>Macros</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcamerafeedbackcontrol.html#QCameraFeedbackControl_iid">QCameraFeedbackControl_iid</a></b></td></tr>
</table>
<a name="details"></a>
<!-- $$$QCameraFeedbackControl-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QCameraFeedbackControl class allows controlling feedback (sounds etc) during camera operation</p>
<p>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.</p>
<p>In some cases it may be undesirable to play a sound effect - for example, when initiating video recording the sound itself may be recorded.</p>
<p><b>Note: </b>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 <tt>isEventFeedbackLocked</tt> to check if that type of feedback can be modified. Any attempts to change a locked feedback type will be ignored.</p><p>The interface name of QCameraFeedbackControl is <tt>org.qt-project.qt.camerafeedbackcontrol/5.0</tt> as defined in <a href="qcamerafeedbackcontrol.html#QCameraFeedbackControl_iid">QCameraFeedbackControl_iid</a>.</p>
</div>
<p><b>See also </b><a href="qcamera.html">QCamera</a>.</p>
<!-- @@@QCameraFeedbackControl -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$EventType$$$ViewfinderStarted$$$ViewfinderStopped$$$ImageCaptured$$$ImageSaved$$$ImageError$$$RecordingStarted$$$RecordingInProgress$$$RecordingStopped$$$AutoFocusInProgress$$$AutoFocusLocked$$$AutoFocusFailed -->
<h3 class="fn"><a name="EventType-enum"></a>enum QCameraFeedbackControl::<span class="name">EventType</span></h3>
<p>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.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QCameraFeedbackControl::ViewfinderStarted</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The viewfinder stream was started (even if not visible)</td></tr>
<tr><td class="topAlign"><tt>QCameraFeedbackControl::ViewfinderStopped</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">The viewfinder stream was stopped</td></tr>
<tr><td class="topAlign"><tt>QCameraFeedbackControl::ImageCaptured</tt></td><td class="topAlign"><tt>3</tt></td><td class="topAlign">An image was captured but not yet fully processed</td></tr>
<tr><td class="topAlign"><tt>QCameraFeedbackControl::ImageSaved</tt></td><td class="topAlign"><tt>4</tt></td><td class="topAlign">An image is fully available and saved somewhere.</td></tr>
<tr><td class="topAlign"><tt>QCameraFeedbackControl::ImageError</tt></td><td class="topAlign"><tt>5</tt></td><td class="topAlign">An error occurred while capturing an image</td></tr>
<tr><td class="topAlign"><tt>QCameraFeedbackControl::RecordingStarted</tt></td><td class="topAlign"><tt>6</tt></td><td class="topAlign">Video recording has started</td></tr>
<tr><td class="topAlign"><tt>QCameraFeedbackControl::RecordingInProgress</tt></td><td class="topAlign"><tt>7</tt></td><td class="topAlign">Video recording is in progress</td></tr>
<tr><td class="topAlign"><tt>QCameraFeedbackControl::RecordingStopped</tt></td><td class="topAlign"><tt>8</tt></td><td class="topAlign">Video recording has stopped</td></tr>
<tr><td class="topAlign"><tt>QCameraFeedbackControl::AutoFocusInProgress</tt></td><td class="topAlign"><tt>9</tt></td><td class="topAlign">The camera is trying to automatically focus</td></tr>
<tr><td class="topAlign"><tt>QCameraFeedbackControl::AutoFocusLocked</tt></td><td class="topAlign"><tt>10</tt></td><td class="topAlign">The camera has automatically focused successfully</td></tr>
<tr><td class="topAlign"><tt>QCameraFeedbackControl::AutoFocusFailed</tt></td><td class="topAlign"><tt>11</tt></td><td class="topAlign">The camera was unable to focus automatically</td></tr>
</table>
<!-- @@@EventType -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QCameraFeedbackControl[overload1]$$$QCameraFeedbackControlQObject* -->
<h3 class="fn"><a name="QCameraFeedbackControl"></a>QCameraFeedbackControl::<span class="name">QCameraFeedbackControl</span>(<span class="type">QObject</span> *<i> parent</i> = 0)<tt> [protected]</tt></h3>
<p>Constructs a camera feedback control object with <i>parent</i>.</p>
<!-- @@@QCameraFeedbackControl -->
<!-- $$$~QCameraFeedbackControl[overload1]$$$~QCameraFeedbackControl -->
<h3 class="fn"><a name="dtor.QCameraFeedbackControl"></a>QCameraFeedbackControl::<span class="name">~QCameraFeedbackControl</span>()</h3>
<p>Destroys the camera feedback control object.</p>
<!-- @@@~QCameraFeedbackControl -->
<!-- $$$isEventFeedbackEnabled[overload1]$$$isEventFeedbackEnabledEventType -->
<h3 class="fn"><a name="isEventFeedbackEnabled"></a><span class="type">bool</span> QCameraFeedbackControl::<span class="name">isEventFeedbackEnabled</span>(<span class="type"><a href="qcamerafeedbackcontrol.html#EventType-enum">EventType</a></span><i> event</i>) const<tt> [pure virtual]</tt></h3>
<p>Returns true if the feedback for <i>event</i> is enabled.</p>
<p>This function was introduced in Qt 5.0.</p>
<!-- @@@isEventFeedbackEnabled -->
<!-- $$$isEventFeedbackLocked[overload1]$$$isEventFeedbackLockedEventType -->
<h3 class="fn"><a name="isEventFeedbackLocked"></a><span class="type">bool</span> QCameraFeedbackControl::<span class="name">isEventFeedbackLocked</span>(<span class="type"><a href="qcamerafeedbackcontrol.html#EventType-enum">EventType</a></span><i> event</i>) const<tt> [pure virtual]</tt></h3>
<p>Returns true if the feedback setting for <i>event</i> is locked. This may be true because of legal compliance issues, or because configurability of this event's feedback is not supported.</p>
<p>This function was introduced in Qt 5.0.</p>
<!-- @@@isEventFeedbackLocked -->
<!-- $$$resetEventFeedback[overload1]$$$resetEventFeedbackEventType -->
<h3 class="fn"><a name="resetEventFeedback"></a><span class="type">void</span> QCameraFeedbackControl::<span class="name">resetEventFeedback</span>(<span class="type"><a href="qcamerafeedbackcontrol.html#EventType-enum">EventType</a></span><i> event</i>)<tt> [pure virtual]</tt></h3>
<p>Restores the feedback setting for this <i>event</i> to its default setting.</p>
<p>This function was introduced in Qt 5.0.</p>
<!-- @@@resetEventFeedback -->
<!-- $$$setEventFeedbackEnabled[overload1]$$$setEventFeedbackEnabledEventTypebool -->
<h3 class="fn"><a name="setEventFeedbackEnabled"></a><span class="type">bool</span> QCameraFeedbackControl::<span class="name">setEventFeedbackEnabled</span>(<span class="type"><a href="qcamerafeedbackcontrol.html#EventType-enum">EventType</a></span><i> event</i>, <span class="type">bool</span><i> enabled</i>)<tt> [pure virtual]</tt></h3>
<p>Turns on feedback for the specific <i>event</i> if <i>enabled</i> is true, otherwise disables the feedback. Returns true if the feedback could be modified, or false otherwise (e.g. this feedback type is locked).</p>
<p>This function was introduced in Qt 5.0.</p>
<p><b>See also </b><a href="qcamerafeedbackcontrol.html#isEventFeedbackEnabled">isEventFeedbackEnabled</a>().</p>
<!-- @@@setEventFeedbackEnabled -->
<!-- $$$setEventFeedbackSound[overload1]$$$setEventFeedbackSoundEventTypeconstQString& -->
<h3 class="fn"><a name="setEventFeedbackSound"></a><span class="type">bool</span> QCameraFeedbackControl::<span class="name">setEventFeedbackSound</span>(<span class="type"><a href="qcamerafeedbackcontrol.html#EventType-enum">EventType</a></span><i> event</i>, const <span class="type">QString</span> &<i> filePath</i>)<tt> [pure virtual]</tt></h3>
<p>When the given <i>event</i> occurs, the sound effect referenced by <i>filePath</i> will be played instead of the default sound.</p>
<p>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.</p>
<p>The file referenced should be linear PCM (WAV format).</p>
<p><b>Note: </b>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.</p><p>This function was introduced in Qt 5.0.</p>
<!-- @@@setEventFeedbackSound -->
</div>
<div class="macros">
<h2>Macro Documentation</h2>
<!-- $$$QCameraFeedbackControl_iid[overload1]$$$QCameraFeedbackControl_iid -->
<h3 class="fn"><a name="QCameraFeedbackControl_iid"></a><span class="name">QCameraFeedbackControl_iid</span></h3>
<p><tt>org.qt-project.qt.camerafeedbackcontrol/5.0</tt></p>
<p>Defines the interface name of the <a href="qcamerafeedbackcontrol.html">QCameraFeedbackControl</a> class.</p>
<!-- @@@QCameraFeedbackControl_iid -->
</div>
</div>
</div>
</div>
</div>
</div>
<div class="footer">
<p>
<acronym title="Copyright">©</acronym> 2013 Digia Plc and/or its
subsidiaries. Documentation contributions included herein are the copyrights of
their respective owners.<br> The documentation provided herein is licensed under the terms of the <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation License version 1.3</a> as published by the Free Software Foundation.<br> Digia, Qt and their respective logos are trademarks of Digia Plc in Finland and/or other countries worldwide. All other trademarks are property
of their respective owners. </p>
</div>
</body>
</html>
|