This file is indexed.

/usr/share/qt5/doc/qtmultimedia/qvideoencodersettingscontrol.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
<?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" />
<!-- qvideoencodersettingscontrol.cpp -->
  <title>QVideoEncoderSettingsControl 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>QVideoEncoderSettingsControl</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-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">QVideoEncoderSettingsControl Class</h1>
<!-- $$$QVideoEncoderSettingsControl-brief -->
<p>The QVideoEncoderSettingsControl class provides access to the settings of a media service that performs video encoding. <a href="#details">More...</a></p>
<!-- @@@QVideoEncoderSettingsControl -->
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> Header:</td><td class="memItemRight bottomAlign"> </b><tt><span class="preprocessor">#include &lt;QVideoEncoderSettingsControl&gt;</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"> Inherits:</td><td class="memItemRight bottomAlign"> <a href="qmediacontrol.html">QMediaControl</a>.</td></tr></table><ul>
<li><a href="qvideoencodersettingscontrol-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> virtual </td><td class="memItemRight bottomAlign"><b><a href="qvideoencodersettingscontrol.html#dtor.QVideoEncoderSettingsControl">~QVideoEncoderSettingsControl</a></b>()</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual void </td><td class="memItemRight bottomAlign"><b><a href="qvideoencodersettingscontrol.html#setVideoSettings">setVideoSettings</a></b>(const QVideoEncoderSettings &amp;<i> settings</i>) = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QList&lt;qreal&gt; </td><td class="memItemRight bottomAlign"><b><a href="qvideoencodersettingscontrol.html#supportedFrameRates">supportedFrameRates</a></b>(const QVideoEncoderSettings &amp;<i> settings</i>, bool *<i> continuous</i> = 0) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QList&lt;QSize&gt; </td><td class="memItemRight bottomAlign"><b><a href="qvideoencodersettingscontrol.html#supportedResolutions">supportedResolutions</a></b>(const QVideoEncoderSettings &amp;<i> settings</i>, bool *<i> continuous</i> = 0) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QStringList </td><td class="memItemRight bottomAlign"><b><a href="qvideoencodersettingscontrol.html#supportedVideoCodecs">supportedVideoCodecs</a></b>() const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QString </td><td class="memItemRight bottomAlign"><b><a href="qvideoencodersettingscontrol.html#videoCodecDescription">videoCodecDescription</a></b>(const QString &amp;<i> codec</i>) const = 0</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> virtual QVideoEncoderSettings </td><td class="memItemRight bottomAlign"><b><a href="qvideoencodersettingscontrol.html#videoSettings">videoSettings</a></b>() const = 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="qvideoencodersettingscontrol.html#QVideoEncoderSettingsControl">QVideoEncoderSettingsControl</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="qvideoencodersettingscontrol.html#QVideoEncoderSettingsControl_iid">QVideoEncoderSettingsControl_iid</a></b></td></tr>
</table>
<a name="details"></a>
<!-- $$$QVideoEncoderSettingsControl-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QVideoEncoderSettingsControl class provides access to the settings of a media service that performs video encoding.</p>
<p>If a <a href="qmediaservice.html">QMediaService</a> supports encoding video data it will implement QVideoEncoderSettingsControl. This control provides information about the limits of restricted video encoder options and allows the selection of a set of video encoder settings as specified in a <a href="qvideoencodersettings.html">QVideoEncoderSettings</a> object.</p>
<p>The functionality provided by this control is exposed to application code through the <a href="qmediarecorder.html">QMediaRecorder</a> class.</p>
<p>The interface name of QVideoEncoderSettingsControl is <tt>org.qt-project.qt.videoencodersettingscontrol/5.0</tt> as defined in <a href="qvideoencodersettingscontrol.html#QVideoEncoderSettingsControl_iid">QVideoEncoderSettingsControl_iid</a>.</p>
</div>
<p><b>See also </b><a href="qmediarecorder.html">QMediaRecorder</a>, <a href="qvideoencodersettings.html">QVideoEncoderSettings</a>, and <a href="qmediaservice.html#requestControl">QMediaService::requestControl</a>().</p>
<!-- @@@QVideoEncoderSettingsControl -->
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QVideoEncoderSettingsControl[overload1]$$$QVideoEncoderSettingsControlQObject* -->
<h3 class="fn"><a name="QVideoEncoderSettingsControl"></a>QVideoEncoderSettingsControl::<span class="name">QVideoEncoderSettingsControl</span>(<span class="type">QObject</span> *<i> parent</i> = 0)<tt> [protected]</tt></h3>
<p>Create a new video encoder settings control object with the given <i>parent</i>.</p>
<!-- @@@QVideoEncoderSettingsControl -->
<!-- $$$~QVideoEncoderSettingsControl[overload1]$$$~QVideoEncoderSettingsControl -->
<h3 class="fn"><a name="dtor.QVideoEncoderSettingsControl"></a>QVideoEncoderSettingsControl::<span class="name">~QVideoEncoderSettingsControl</span>()<tt> [virtual]</tt></h3>
<p>Destroys a video encoder settings control.</p>
<!-- @@@~QVideoEncoderSettingsControl -->
<!-- $$$setVideoSettings[overload1]$$$setVideoSettingsconstQVideoEncoderSettings& -->
<h3 class="fn"><a name="setVideoSettings"></a><span class="type">void</span> QVideoEncoderSettingsControl::<span class="name">setVideoSettings</span>(const <span class="type"><a href="qvideoencodersettings.html">QVideoEncoderSettings</a></span> &amp;<i> settings</i>)<tt> [pure virtual]</tt></h3>
<p>Sets the selected video encoder <i>settings</i>.</p>
<p><b>See also </b><a href="qvideoencodersettingscontrol.html#videoSettings">videoSettings</a>().</p>
<!-- @@@setVideoSettings -->
<!-- $$$supportedFrameRates[overload1]$$$supportedFrameRatesconstQVideoEncoderSettings&bool* -->
<h3 class="fn"><a name="supportedFrameRates"></a><span class="type">QList</span>&lt;<span class="type">qreal</span>&gt; QVideoEncoderSettingsControl::<span class="name">supportedFrameRates</span>(const <span class="type"><a href="qvideoencodersettings.html">QVideoEncoderSettings</a></span> &amp;<i> settings</i>, <span class="type">bool</span> *<i> continuous</i> = 0) const<tt> [pure virtual]</tt></h3>
<p>Returns a list of supported frame rates.</p>
<p>If non null video <i>settings</i> parameter is passed, the returned list is reduced to frame rates supported with partial settings like <a href="qvideoencodersettings.html#setCodec">video codec</a> or <a href="qvideoencodersettings.html#setResolution">video resolution</a> applied.</p>
<p>If the encoder supports arbitrary frame rates within the supported range, *<i>continuous</i> is set to true, otherwise *<i>continuous</i> is set to false.</p>
<p><b>See also </b><a href="qvideoencodersettings.html#frameRate">QVideoEncoderSettings::frameRate</a>().</p>
<!-- @@@supportedFrameRates -->
<!-- $$$supportedResolutions[overload1]$$$supportedResolutionsconstQVideoEncoderSettings&bool* -->
<h3 class="fn"><a name="supportedResolutions"></a><span class="type">QList</span>&lt;<span class="type">QSize</span>&gt; QVideoEncoderSettingsControl::<span class="name">supportedResolutions</span>(const <span class="type"><a href="qvideoencodersettings.html">QVideoEncoderSettings</a></span> &amp;<i> settings</i>, <span class="type">bool</span> *<i> continuous</i> = 0) const<tt> [pure virtual]</tt></h3>
<p>Returns a list of supported resolutions.</p>
<p>If non null video <i>settings</i> parameter is passed, the returned list is reduced to resolution supported with partial settings like <a href="qvideoencodersettings.html#setCodec">video codec</a> or <a href="qvideoencodersettings.html#setFrameRate">frame rate</a> applied.</p>
<p>If the encoder supports arbitrary resolutions within the supported resolutions range, *<i>continuous</i> is set to true, otherwise *<i>continuous</i> is set to false.</p>
<p><b>See also </b><a href="qvideoencodersettings.html#resolution">QVideoEncoderSettings::resolution</a>().</p>
<!-- @@@supportedResolutions -->
<!-- $$$supportedVideoCodecs[overload1]$$$supportedVideoCodecs -->
<h3 class="fn"><a name="supportedVideoCodecs"></a><span class="type">QStringList</span> QVideoEncoderSettingsControl::<span class="name">supportedVideoCodecs</span>() const<tt> [pure virtual]</tt></h3>
<p>Returns the list of supported video codecs.</p>
<!-- @@@supportedVideoCodecs -->
<!-- $$$videoCodecDescription[overload1]$$$videoCodecDescriptionconstQString& -->
<h3 class="fn"><a name="videoCodecDescription"></a><span class="type">QString</span> QVideoEncoderSettingsControl::<span class="name">videoCodecDescription</span>(const <span class="type">QString</span> &amp;<i> codec</i>) const<tt> [pure virtual]</tt></h3>
<p>Returns a description of a video <i>codec</i>.</p>
<!-- @@@videoCodecDescription -->
<!-- $$$videoSettings[overload1]$$$videoSettings -->
<h3 class="fn"><a name="videoSettings"></a><span class="type"><a href="qvideoencodersettings.html">QVideoEncoderSettings</a></span> QVideoEncoderSettingsControl::<span class="name">videoSettings</span>() const<tt> [pure virtual]</tt></h3>
<p>Returns the video encoder settings.</p>
<p>The returned value may be different tha passed to <a href="qvideoencodersettingscontrol.html#setVideoSettings">QVideoEncoderSettingsControl::setVideoSettings</a>() if the settings contains the default or undefined parameters. In this case if the undefined parameters are already resolved, they should be returned.</p>
<p><b>See also </b><a href="qvideoencodersettingscontrol.html#setVideoSettings">setVideoSettings</a>().</p>
<!-- @@@videoSettings -->
</div>
<div class="macros">
<h2>Macro Documentation</h2>
<!-- $$$QVideoEncoderSettingsControl_iid[overload1]$$$QVideoEncoderSettingsControl_iid -->
<h3 class="fn"><a name="QVideoEncoderSettingsControl_iid"></a><span class="name">QVideoEncoderSettingsControl_iid</span></h3>
<p><tt>org.qt-project.qt.videoencodersettingscontrol/5.0</tt></p>
<p>Defines the interface name of the <a href="qvideoencodersettingscontrol.html">QVideoEncoderSettingsControl</a> class.</p>
<!-- @@@QVideoEncoderSettingsControl_iid -->
</div>
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</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>