/usr/share/gtk-doc/html/buzztard-edit/GtkVUMeter.html is in libbuzztard-dev 0.6.0-1.1.
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 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkVUMeter</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Buzztard Bt-Edit Reference Manual">
<link rel="up" href="ch04.html" title="Widget Class Reference">
<link rel="prev" href="BtWaveformViewer.html" title="BtWaveformViewer">
<link rel="next" href="uibteditopts.html" title="User Application Command Line Reference">
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="BtWaveformViewer.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch04.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Buzztard Bt-Edit Reference Manual</th>
<td><a accesskey="n" href="uibteditopts.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GtkVUMeter.synopsis" class="shortcut">Top</a>
|
<a href="#GtkVUMeter.description" class="shortcut">Description</a>
|
<a href="#GtkVUMeter.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GtkVUMeter.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
</td></tr>
</table>
<div class="refentry">
<a name="GtkVUMeter"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkVUMeter.top_of_page"></a>GtkVUMeter</span></h2>
<p>GtkVUMeter — vu meter widget</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GtkVUMeter.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include "bt-edit.h"
struct <a class="link" href="GtkVUMeter.html#GtkVUMeter-struct" title="struct GtkVUMeter">GtkVUMeter</a>;
<span class="returnvalue">GtkWidget</span> * <a class="link" href="BtRuler.html#gtk-vumeter-new" title="gtk_vumeter_new ()">gtk_vumeter_new</a> (<em class="parameter"><code><span class="type">gboolean</span> vertical</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GtkVUMeter.html#gtk-vumeter-set-min-max" title="gtk_vumeter_set_min_max ()">gtk_vumeter_set_min_max</a> (<em class="parameter"><code><a class="link" href="GtkVUMeter.html" title="GtkVUMeter"><span class="type">GtkVUMeter</span></a> *vumeter</code></em>,
<em class="parameter"><code><span class="type">gint</span> min</code></em>,
<em class="parameter"><code><span class="type">gint</span> max</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GtkVUMeter.html#gtk-vumeter-set-levels" title="gtk_vumeter_set_levels ()">gtk_vumeter_set_levels</a> (<em class="parameter"><code><a class="link" href="GtkVUMeter.html" title="GtkVUMeter"><span class="type">GtkVUMeter</span></a> *vumeter</code></em>,
<em class="parameter"><code><span class="type">gint</span> rms</code></em>,
<em class="parameter"><code><span class="type">gint</span> peak</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GtkVUMeter.html#gtk-vumeter-set-scale" title="gtk_vumeter_set_scale ()">gtk_vumeter_set_scale</a> (<em class="parameter"><code><a class="link" href="GtkVUMeter.html" title="GtkVUMeter"><span class="type">GtkVUMeter</span></a> *vumeter</code></em>,
<em class="parameter"><code><span class="type">gint</span> scale</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GtkVUMeter.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GObject
+----GInitiallyUnowned
+----GtkObject
+----GtkWidget
+----GtkVUMeter
</pre>
</div>
<div class="refsect1">
<a name="GtkVUMeter.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkVUMeter implements
AtkImplementorIface and GtkBuildable.</p>
</div>
<div class="refsect1">
<a name="GtkVUMeter.description"></a><h2>Description</h2>
<p>
Shows a vertical or horizontal gauge with a colorized bar to signal volume
level.
</p>
</div>
<div class="refsect1">
<a name="GtkVUMeter.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GtkVUMeter-struct"></a><h3>struct GtkVUMeter</h3>
<pre class="programlisting">struct GtkVUMeter;</pre>
<p>
a volume meter widget
</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-vumeter-new"></a><h3>gtk_vumeter_new ()</h3>
<pre class="programlisting"><span class="returnvalue">GtkWidget</span> * gtk_vumeter_new (<em class="parameter"><code><span class="type">gboolean</span> vertical</code></em>);</pre>
<p>
Creates a new VUMeter widget.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>vertical</code></em> :</span></p></td>
<td>
<code class="literal">TRUE</code> for a vertical VUMeter, <code class="literal">FALSE</code> for horizontal VUMeter.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the new <span class="type">GtkWidget</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-vumeter-set-min-max"></a><h3>gtk_vumeter_set_min_max ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gtk_vumeter_set_min_max (<em class="parameter"><code><a class="link" href="GtkVUMeter.html" title="GtkVUMeter"><span class="type">GtkVUMeter</span></a> *vumeter</code></em>,
<em class="parameter"><code><span class="type">gint</span> min</code></em>,
<em class="parameter"><code><span class="type">gint</span> max</code></em>);</pre>
<p>
Sets the minimum and maximum of the VU Meters scale.
The positions are irrelevant as the widget will rearrange them.
It will also increment max by one if min == max.
And finally it will clamp the current level into the min,max range.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>vumeter</code></em> :</span></p></td>
<td>the vumeter widget to change the level bounds</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>min</code></em> :</span></p></td>
<td>the new minimum level shown (level that is 0%)</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>max</code></em> :</span></p></td>
<td>the new maximum level shown (level that is 100%)</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-vumeter-set-levels"></a><h3>gtk_vumeter_set_levels ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gtk_vumeter_set_levels (<em class="parameter"><code><a class="link" href="GtkVUMeter.html" title="GtkVUMeter"><span class="type">GtkVUMeter</span></a> *vumeter</code></em>,
<em class="parameter"><code><span class="type">gint</span> rms</code></em>,
<em class="parameter"><code><span class="type">gint</span> peak</code></em>);</pre>
<p>
Sets new level values for the level display.
They are clamped to the min max range.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>vumeter</code></em> :</span></p></td>
<td>the vumeter widget to change the current level</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rms</code></em> :</span></p></td>
<td>the new rms level shown</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>peak</code></em> :</span></p></td>
<td>the new peak level shown</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-vumeter-set-scale"></a><h3>gtk_vumeter_set_scale ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gtk_vumeter_set_scale (<em class="parameter"><code><a class="link" href="GtkVUMeter.html" title="GtkVUMeter"><span class="type">GtkVUMeter</span></a> *vumeter</code></em>,
<em class="parameter"><code><span class="type">gint</span> scale</code></em>);</pre>
<p>
Sets the scale of the VU Meter.
It is either log or linear and defaults to linear.
No matter which scale you set the input should always be linear, <a class="link" href="GtkVUMeter.html" title="GtkVUMeter"><span class="type">GtkVUMeter</span></a>
does the log calculation. 0db is red. -6db is yellow. -18db is green.
Whatever min turns into is dark green.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>vumeter</code></em> :</span></p></td>
<td>the vumeter widget to change the scaling type</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>scale</code></em> :</span></p></td>
<td>the scale type, either GTK_VUMETER_SCALE_LINEAR or GTK_VUMETER_SCALE_LOG</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.19</div>
</body>
</html>
|