1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
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">
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">
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>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#gst-plugins-base-plugins-volume.synopsis" class="shortcut">Top</a>
26 <a href="#gst-plugins-base-plugins-volume.description" class="shortcut">Description</a>
28 <a href="#gst-plugins-base-plugins-volume.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#gst-plugins-base-plugins-volume.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
32 <a href="#gst-plugins-base-plugins-volume.properties" class="shortcut">Properties</a>
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>
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>
42 <td valign="top" align="right"></td>
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>;
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>
60 <div class="refsect1">
61 <a name="gst-plugins-base-plugins-volume.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
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>
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
73 <div class="refsect1">
74 <a name="gst-plugins-base-plugins-volume.description"></a><h2>Description</h2>
76 The volume element changes the volume of the audio data.
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">
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>
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.
98 <div class="refsynopsisdiv">
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">
106 <td><p><span class="term">plugin</span></p></td>
108 <a class="link" href="gst-plugins-base-plugins-plugin-volume.html#plugin-volume">volume</a>
112 <td><p><span class="term">author</span></p></td>
113 <td>Andy Wingo <wingo@pobox.com></td>
116 <td><p><span class="term">class</span></p></td>
117 <td>Filter/Effect/Audio</td>
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">
129 <td><p><span class="term">name</span></p></td>
133 <td><p><span class="term">direction</span></p></td>
137 <td><p><span class="term">presence</span></p></td>
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>
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>
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>
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>
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>
162 <div class="variablelist"><table border="0">
163 <col align="left" valign="top">
166 <td><p><span class="term">name</span></p></td>
170 <td><p><span class="term">direction</span></p></td>
174 <td><p><span class="term">presence</span></p></td>
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>
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>
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>
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>
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>
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>
210 Opaque data structure.
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>
220 <p>Default value: FALSE</p>
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>
234 Generated by GTK-Doc V1.18</div>