Initialize Tizen 2.3
[framework/multimedia/gst-plugins-base0.10.git] / mobile / docs / plugins / html / gst-plugins-base-plugins-adder.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>adder</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="ch01.html" title="gst-plugins-base Elements">
10 <link rel="next" href="gst-plugins-base-plugins-appsrc.html" title="appsrc">
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="ch01.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-appsrc.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-adder.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-base-plugins-adder.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#gst-plugins-base-plugins-adder.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#gst-plugins-base-plugins-adder.properties" class="shortcut">Properties</a>
31 </td></tr>
32 </table>
33 <div class="refentry">
34 <a name="gst-plugins-base-plugins-adder"></a><div class="titlepage"></div>
35 <div class="refnamediv"><table width="100%"><tr>
36 <td valign="top">
37 <h2><span class="refentrytitle"><a name="gst-plugins-base-plugins-adder.top_of_page"></a>adder</span></h2>
38 <p>adder — Add N audio channels together</p>
39 </td>
40 <td valign="top" align="right"></td>
41 </tr></table></div>
42 <div class="refsynopsisdiv">
43 <a name="gst-plugins-base-plugins-adder.synopsis"></a><h2>Synopsis</h2>
44 <a name="GstAdder"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-base-plugins-adder.html#GstAdder-struct" title="struct GstAdder">GstAdder</a>;
45 </pre>
46 </div>
47 <div class="refsect1">
48 <a name="gst-plugins-base-plugins-adder.object-hierarchy"></a><h2>Object Hierarchy</h2>
49 <pre class="synopsis">
50   <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
51    +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstObject.html">GstObject</a>
52          +----<a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstElement.html">GstElement</a>
53                +----GstAdder
54 </pre>
55 </div>
56 <div class="refsect1">
57 <a name="gst-plugins-base-plugins-adder.properties"></a><h2>Properties</h2>
58 <pre class="synopsis">
59   "<a class="link" href="gst-plugins-base-plugins-adder.html#GstAdder--caps" title='The "caps" property'>caps</a>"                     <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a>*              : Read / Write
60 </pre>
61 </div>
62 <div class="refsect1">
63 <a name="gst-plugins-base-plugins-adder.description"></a><h2>Description</h2>
64 <p>
65 The adder allows to mix several streams into one by adding the data.
66 Mixed data is clamped to the min/max values of the data format.
67 </p>
68 <p>
69 The adder currently mixes all data received on the sinkpads as soon as
70 possible without trying to synchronize the streams.
71 </p>
72 <p>
73 </p>
74 <div class="refsect2">
75 <a name="idm11744"></a><h3>Example launch line</h3>
76 <div class="informalexample">
77   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
78     <tbody>
79       <tr>
80         <td class="listing_lines" align="right"><pre>1</pre></td>
81         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch audiotestsrc freq<span class="gtkdoc opt">=</span><span class="number">100</span> <span class="gtkdoc opt">!</span> adder name<span class="gtkdoc opt">=</span>mix <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> alsasink audiotestsrc freq<span class="gtkdoc opt">=</span><span class="number">500</span> <span class="gtkdoc opt">!</span> mix<span class="gtkdoc opt">.</span></pre></td>
82       </tr>
83     </tbody>
84   </table>
85 </div>
86  This pipeline produces two sine waves mixed together.
87 </div>
88 <p>
89 </p>
90 <p>
91 Last reviewed on 2006-05-09 (0.10.7)
92 </p>
93 <div class="refsynopsisdiv">
94 <h2>Synopsis</h2>
95 <div class="refsect2">
96 <a name="idm14528"></a><h3>Element Information</h3>
97 <div class="variablelist"><table border="0">
98 <col align="left" valign="top">
99 <tbody>
100 <tr>
101 <td><p><span class="term">plugin</span></p></td>
102 <td>
103             <a class="link" href="gst-plugins-base-plugins-plugin-adder.html#plugin-adder">adder</a>
104           </td>
105 </tr>
106 <tr>
107 <td><p><span class="term">author</span></p></td>
108 <td>Thomas Vander Stichele &lt;thomas at apestaart dot org&gt;</td>
109 </tr>
110 <tr>
111 <td><p><span class="term">class</span></p></td>
112 <td>Generic/Audio</td>
113 </tr>
114 </tbody>
115 </table></div>
116 </div>
117 <hr>
118 <div class="refsect2">
119 <a name="idp7769280"></a><h3>Element Pads</h3>
120 <div class="variablelist"><table border="0">
121 <col align="left" valign="top">
122 <tbody>
123 <tr>
124 <td><p><span class="term">name</span></p></td>
125 <td>sink%d</td>
126 </tr>
127 <tr>
128 <td><p><span class="term">direction</span></p></td>
129 <td>sink</td>
130 </tr>
131 <tr>
132 <td><p><span class="term">presence</span></p></td>
133 <td>request</td>
134 </tr>
135 <tr>
136 <td><p><span class="term">details</span></p></td>
137 <td>audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)32, depth=(int)32, signed=(boolean){ true, false }</td>
138 </tr>
139 <tr>
140 <td><p><span class="term"></span></p></td>
141 <td> audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)16, depth=(int)16, signed=(boolean){ true, false }</td>
142 </tr>
143 <tr>
144 <td><p><span class="term"></span></p></td>
145 <td> audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)8, depth=(int)8, signed=(boolean){ true, false }</td>
146 </tr>
147 <tr>
148 <td><p><span class="term"></span></p></td>
149 <td> audio/x-raw-float, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int){ 32, 64 }</td>
150 </tr>
151 </tbody>
152 </table></div>
153 <div class="variablelist"><table border="0">
154 <col align="left" valign="top">
155 <tbody>
156 <tr>
157 <td><p><span class="term">name</span></p></td>
158 <td>src</td>
159 </tr>
160 <tr>
161 <td><p><span class="term">direction</span></p></td>
162 <td>source</td>
163 </tr>
164 <tr>
165 <td><p><span class="term">presence</span></p></td>
166 <td>always</td>
167 </tr>
168 <tr>
169 <td><p><span class="term">details</span></p></td>
170 <td>audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)32, depth=(int)32, signed=(boolean){ true, false }</td>
171 </tr>
172 <tr>
173 <td><p><span class="term"></span></p></td>
174 <td> audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)16, depth=(int)16, signed=(boolean){ true, false }</td>
175 </tr>
176 <tr>
177 <td><p><span class="term"></span></p></td>
178 <td> audio/x-raw-int, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int)8, depth=(int)8, signed=(boolean){ true, false }</td>
179 </tr>
180 <tr>
181 <td><p><span class="term"></span></p></td>
182 <td> audio/x-raw-float, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], endianness=(int)1234, width=(int){ 32, 64 }</td>
183 </tr>
184 </tbody>
185 </table></div>
186 </div>
187 </div>
188 <p>
189 </p>
190 </div>
191 <div class="refsect1">
192 <a name="gst-plugins-base-plugins-adder.details"></a><h2>Details</h2>
193 <div class="refsect2">
194 <a name="GstAdder-struct"></a><h3>struct GstAdder</h3>
195 <pre class="programlisting">struct GstAdder;</pre>
196 <p>
197 The adder object structure.
198 </p>
199 </div>
200 </div>
201 <div class="refsect1">
202 <a name="gst-plugins-base-plugins-adder.property-details"></a><h2>Property Details</h2>
203 <div class="refsect2">
204 <a name="GstAdder--caps"></a><h3>The <code class="literal">"caps"</code> property</h3>
205 <pre class="programlisting">  "caps"                     <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a>*              : Read / Write</pre>
206 <p>Set target format for mixing (NULL means ANY). Setting this property takes a reference to the supplied GstCaps object.</p>
207 <p class="since">Since 0.10.24</p>
208 </div>
209 </div>
210 </div>
211 <div class="footer">
212 <hr>
213           Generated by GTK-Doc V1.18</div>
214 </body>
215 </html>