docs/plugins/html/gst-plugins-base-plugins-volume.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
   2 <html>
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
   5 <title>volume</title>
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
   7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 Plugins Reference Manual">
   8 <link rel="up" href="ch01.html" title="gst-plugins-base Elements">
   9 <link rel="prev" href="gst-plugins-base-plugins-videotestsrc.html" title="videotestsrc">
  10 <link rel="next" href="gst-plugins-base-plugins-vorbisdec.html" title="vorbisdec">
  11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
  12 <link rel="stylesheet" href="style.css" type="text/css">
  13 </head>
  14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
  16 <tr valign="middle">
  17 <td><a accesskey="p" href="gst-plugins-base-plugins-videotestsrc.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
  18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
  19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
  20 <th width="100%" align="center">GStreamer Base Plugins 0.10 Plugins Reference Manual</th>
  21 <td><a accesskey="n" href="gst-plugins-base-plugins-vorbisdec.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
  22 </tr>
  23 <tr><td colspan="5" class="shortcuts">
  24 <a href="#gst-plugins-base-plugins-volume.synopsis" class="shortcut">Top</a>
  25                    |
  26                   <a href="#gst-plugins-base-plugins-volume.description" class="shortcut">Description</a>
  27                    |
  28                   <a href="#gst-plugins-base-plugins-volume.object-hierarchy" class="shortcut">Object Hierarchy</a>
  29                    |
  30                   <a href="#gst-plugins-base-plugins-volume.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
  31                    |
  32                   <a href="#gst-plugins-base-plugins-volume.properties" class="shortcut">Properties</a>
  33 </td></tr>
  34 </table>
  35 <div class="refentry">
  36 <a name="gst-plugins-base-plugins-volume"></a><div class="titlepage"></div>
  37 <div class="refnamediv"><table width="100%"><tr>
  38 <td valign="top">
  39 <h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-volume.top_of_page"></a>volume</span></h2>
  40 <p>volume — Set volume on audio/raw streams</p>
  41 </td>
  42 <td valign="top" align="right"></td>
  43 </tr></table></div>
  44 <div class="refsynopsisdiv">
  45 <a name="gst-plugins-base-plugins-volume.synopsis"></a><h2>Synopsis</h2>
  46 <a name="GstVolume"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-base-plugins-volume.html#GstVolume-struct" title="struct GstVolume">GstVolume</a>;
  47 </pre>
  48 </div>
  49 <div class="refsect1">
  50 <a name="gst-plugins-base-plugins-volume.object-hierarchy"></a><h2>Object Hierarchy</h2>
  51 <pre class="synopsis">
  52   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
  53    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
  54          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
  55                +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-libs/html/GstBaseTransform.html">GstBaseTransform</a>
  56                      +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstaudiofilter.html#GstAudioFilter">GstAudioFilter</a>
  57                            +----GstVolume
  58 </pre>
  59 </div>
  60 <div class="refsect1">
  61 <a name="gst-plugins-base-plugins-volume.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
  62 <p>
  63 GstVolume implements
  64  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstImplementsInterface.html">GstImplementsInterface</a>,  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gstmixer.html#GstMixer">GstMixer</a> and  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gst-plugins-base-libs/html/gst-plugins-base-libs-gststreamvolume.html#GstStreamVolume">GstStreamVolume</a>.</p>
  65 </div>
  66 <div class="refsect1">
  67 <a name="gst-plugins-base-plugins-volume.properties"></a><h2>Properties</h2>
  68 <pre class="synopsis">
  69   "<a class="link" href="gst-plugins-base-plugins-volume.html#GstVolume--mute" title='The "mute" property'>mute</a>"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
  70   "<a class="link" href="gst-plugins-base-plugins-volume.html#GstVolume--volume" title='The "volume" property'>volume</a>"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write
  71 </pre>
  72 </div>
  73 <div class="refsect1">
  74 <a name="gst-plugins-base-plugins-volume.description"></a><h2>Description</h2>
  75 <p>
  76 The volume element changes the volume of the audio data.
  77 </p>
  78 <p>
  79 </p>
  80 <div class="refsect2">
  81 <a name="idp5784592"></a><h3>Example launch line</h3>
  82 <div class="informalexample">
  83   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
  84     <tbody>
  85       <tr>
  86         <td class="listing_lines" align="right"><pre>1</pre></td>
  87         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v <span class="gtkdoc opt">-</span>m audiotestsrc <span class="gtkdoc opt">!</span> volume volume<span class="gtkdoc opt">=</span><span class="number">0.5</span> <span class="gtkdoc opt">!</span> level <span class="gtkdoc opt">!</span> fakesink silent<span class="gtkdoc opt">=</span>TRUE</pre></td>
  88       </tr>
  89     </tbody>
  90   </table>
  91 </div>
  92  This pipeline shows that the level of audiotestsrc has been halved
  93 (peak values are around -6 dB and RMS around -9 dB) compared to
  94 the same pipeline without the volume element.
  95 </div>
  96 <p>
  97 </p>
  98 <div class="refsynopsisdiv">
  99 <h2>Synopsis</h2>
 100 <div class="refsect2">
 101 <a name="idp6771392"></a><h3>Element Information</h3>
 102 <div class="variablelist"><table border="0">
 103 <col align="left" valign="top">
 104 <tbody>
 105 <tr>
 106 <td><p><span class="term">plugin</span></p></td>
 107 <td>
 108             <a class="link" href="gst-plugins-base-plugins-plugin-volume.html#plugin-volume">volume</a>
 109           </td>
 110 </tr>
 111 <tr>
 112 <td><p><span class="term">author</span></p></td>
 113 <td>Andy Wingo &lt;wingo@pobox.com&gt;</td>
 114 </tr>
 115 <tr>
 116 <td><p><span class="term">class</span></p></td>
 117 <td>Filter/Effect/Audio</td>
 118 </tr>
 119 </tbody>
 120 </table></div>
 121 </div>
 122 <hr>
 123 <div class="refsect2">
 124 <a name="idp9320000"></a><h3>Element Pads</h3>
 125 <div class="variablelist"><table border="0">
 126 <col align="left" valign="top">
 127 <tbody>
 128 <tr>
 129 <td><p><span class="term">name</span></p></td>
 130 <td>sink</td>
 131 </tr>
 132 <tr>
 133 <td><p><span class="term">direction</span></p></td>
 134 <td>sink</td>
 135 </tr>
 136 <tr>
 137 <td><p><span class="term">presence</span></p></td>
 138 <td>always</td>
 139 </tr>
 140 <tr>
 141 <td><p><span class="term">details</span></p></td>
 142 <td>audio/x-raw-float, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int){ 32, 64 }</td>
 143 </tr>
 144 <tr>
 145 <td><p><span class="term"></span></p></td>
 146 <td> audio/x-raw-int, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)8, depth=(int)8, signed=(boolean)true</td>
 147 </tr>
 148 <tr>
 149 <td><p><span class="term"></span></p></td>
 150 <td> audio/x-raw-int, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)16, depth=(int)16, signed=(boolean)true</td>
 151 </tr>
 152 <tr>
 153 <td><p><span class="term"></span></p></td>
 154 <td> audio/x-raw-int, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)24, depth=(int)24, signed=(boolean)true</td>
 155 </tr>
 156 <tr>
 157 <td><p><span class="term"></span></p></td>
 158 <td> audio/x-raw-int, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)32, depth=(int)32, signed=(boolean)true</td>
 159 </tr>
 160 </tbody>
 161 </table></div>
 162 <div class="variablelist"><table border="0">
 163 <col align="left" valign="top">
 164 <tbody>
 165 <tr>
 166 <td><p><span class="term">name</span></p></td>
 167 <td>src</td>
 168 </tr>
 169 <tr>
 170 <td><p><span class="term">direction</span></p></td>
 171 <td>source</td>
 172 </tr>
 173 <tr>
 174 <td><p><span class="term">presence</span></p></td>
 175 <td>always</td>
 176 </tr>
 177 <tr>
 178 <td><p><span class="term">details</span></p></td>
 179 <td>audio/x-raw-float, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int){ 32, 64 }</td>
 180 </tr>
 181 <tr>
 182 <td><p><span class="term"></span></p></td>
 183 <td> audio/x-raw-int, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)8, depth=(int)8, signed=(boolean)true</td>
 184 </tr>
 185 <tr>
 186 <td><p><span class="term"></span></p></td>
 187 <td> audio/x-raw-int, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)16, depth=(int)16, signed=(boolean)true</td>
 188 </tr>
 189 <tr>
 190 <td><p><span class="term"></span></p></td>
 191 <td> audio/x-raw-int, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)24, depth=(int)24, signed=(boolean)true</td>
 192 </tr>
 193 <tr>
 194 <td><p><span class="term"></span></p></td>
 195 <td> audio/x-raw-int, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)32, depth=(int)32, signed=(boolean)true</td>
 196 </tr>
 197 </tbody>
 198 </table></div>
 199 </div>
 200 </div>
 201 <p>
 202 </p>
 203 </div>
 204 <div class="refsect1">
 205 <a name="gst-plugins-base-plugins-volume.details"></a><h2>Details</h2>
 206 <div class="refsect2">
 207 <a name="GstVolume-struct"></a><h3>struct GstVolume</h3>
 208 <pre class="programlisting">struct GstVolume;</pre>
 209 <p>
 210 Opaque data structure.
 211 </p>
 212 </div>
 213 </div>
 214 <div class="refsect1">
 215 <a name="gst-plugins-base-plugins-volume.property-details"></a><h2>Property Details</h2>
 216 <div class="refsect2">
 217 <a name="GstVolume--mute"></a><h3>The <code class="literal">"mute"</code> property</h3>
 218 <pre class="programlisting">  "mute"                     <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 219 <p>mute channel.</p>
 220 <p>Default value: FALSE</p>
 221 </div>
 222 <hr>
 223 <div class="refsect2">
 224 <a name="GstVolume--volume"></a><h3>The <code class="literal">"volume"</code> property</h3>
 225 <pre class="programlisting">  "volume"                   <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gdouble"><span class="type">gdouble</span></a>               : Read / Write</pre>
 226 <p>volume factor, 1.0=100%.</p>
 227 <p>Allowed values: [0,10]</p>
 228 <p>Default value: 1</p>
 229 </div>
 230 </div>
 231 </div>
 232 <div class="footer">
 233 <hr>
 234           Generated by GTK-Doc V1.18</div>
 235 </body>
 236 </html>