• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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>audioparse: GStreamer Bad Plugins 1.0 Plugins Reference Manual</title>
6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
7<link rel="home" href="index.html" title="GStreamer Bad Plugins 1.0 Plugins Reference Manual">
8<link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
9<link rel="prev" href="gst-plugins-bad-plugins-audiomixmatrix.html" title="audiomixmatrix">
10<link rel="next" href="gst-plugins-bad-plugins-audiosegmentclip.html" title="audiosegmentclip">
11<meta name="generator" content="GTK-Doc V1.28 (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="5"><tr valign="middle">
16<td width="100%" align="left" class="shortcuts">
17<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span18                  <a href="#gst-plugins-bad-plugins-audioparse.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span19                  <a href="#gst-plugins-bad-plugins-audioparse.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces">  <span class="dim">|</span20                  <a href="#gst-plugins-bad-plugins-audioparse.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties">  <span class="dim">|</span21                  <a href="#gst-plugins-bad-plugins-audioparse.properties" class="shortcut">Properties</a></span>
22</td>
23<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
24<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
25<td><a accesskey="p" href="gst-plugins-bad-plugins-audiomixmatrix.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
26<td><a accesskey="n" href="gst-plugins-bad-plugins-audiosegmentclip.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
27</tr></table>
28<div class="refentry">
29<a name="gst-plugins-bad-plugins-audioparse"></a><div class="titlepage"></div>
30<div class="refnamediv"><table width="100%"><tr>
31<td valign="top">
32<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-audioparse.top_of_page"></a>audioparse</span></h2>
33<p>audioparse</p>
34</td>
35<td class="gallery_image" valign="top" align="right"></td>
36</tr></table></div>
37<div class="refsect1">
38<a name="gst-plugins-bad-plugins-audioparse.properties"></a><h2>Properties</h2>
39<div class="informaltable"><table class="informaltable" border="0">
40<colgroup>
41<col width="150px" class="properties_type">
42<col width="300px" class="properties_name">
43<col width="200px" class="properties_flags">
44</colgroup>
45<tbody>
46<tr>
47<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
48<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-audioparse.html#GstAudioParse--channels" title="The “channels” property">channels</a></td>
49<td class="property_flags">Read / Write</td>
50</tr>
51<tr>
52<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
53<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-audioparse.html#GstAudioParse--depth" title="The “depth” property">depth</a></td>
54<td class="property_flags">Read / Write</td>
55</tr>
56<tr>
57<td class="property_type"><span class="type">GstAudioParseEndianness</span></td>
58<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-audioparse.html#GstAudioParse--endianness" title="The “endianness” property">endianness</a></td>
59<td class="property_flags">Read / Write</td>
60</tr>
61<tr>
62<td class="property_type"><span class="type">GstAudioParseFormat</span></td>
63<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-audioparse.html#GstAudioParse--format" title="The “format” property">format</a></td>
64<td class="property_flags">Read / Write</td>
65</tr>
66<tr>
67<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
68<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-audioparse.html#GstAudioParse--rate" title="The “rate” property">rate</a></td>
69<td class="property_flags">Read / Write</td>
70</tr>
71<tr>
72<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
73<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-audioparse.html#GstAudioParse--signed" title="The “signed” property">signed</a></td>
74<td class="property_flags">Read / Write</td>
75</tr>
76<tr>
77<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></td>
78<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-audioparse.html#GstAudioParse--width" title="The “width” property">width</a></td>
79<td class="property_flags">Read / Write</td>
80</tr>
81<tr>
82<td class="property_type">
83<a href="/usr/share/gtk-doc/html/gobject/gobject-Value-arrays.html#GValueArray-struct"><span class="type">GValueArray</span></a> *</td>
84<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-audioparse.html#GstAudioParse--channel-positions" title="The “channel-positions” property">channel-positions</a></td>
85<td class="property_flags">Read / Write</td>
86</tr>
87<tr>
88<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
89<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-audioparse.html#GstAudioParse--interleaved" title="The “interleaved” property">interleaved</a></td>
90<td class="property_flags">Read / Write</td>
91</tr>
92<tr>
93<td class="property_type"><a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/gst-plugins-base-libs-GstAudio.html#GstAudioFormat"><span class="type">GstAudioFormat</span></a></td>
94<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-audioparse.html#GstAudioParse--raw-format" title="The “raw-format” property">raw-format</a></td>
95<td class="property_flags">Read / Write</td>
96</tr>
97<tr>
98<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
99<td class="property_name"><a class="link" href="gst-plugins-bad-plugins-audioparse.html#GstAudioParse--use-sink-caps" title="The “use-sink-caps” property">use-sink-caps</a></td>
100<td class="property_flags">Read / Write</td>
101</tr>
102</tbody>
103</table></div>
104</div>
105<a name="GstAudioParse"></a><div class="refsect1">
106<a name="gst-plugins-bad-plugins-audioparse.other"></a><h2>Types and Values</h2>
107<div class="informaltable"><table class="informaltable" width="100%" border="0">
108<colgroup>
109<col width="150px" class="name">
110<col class="description">
111</colgroup>
112<tbody><tr>
113<td class="datatype_keyword">struct</td>
114<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-audioparse.html#GstAudioParse-struct" title="struct GstAudioParse">GstAudioParse</a></td>
115</tr></tbody>
116</table></div>
117</div>
118<div class="refsect1">
119<a name="gst-plugins-bad-plugins-audioparse.object-hierarchy"></a><h2>Object Hierarchy</h2>
120<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
121    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
122        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a>
123            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a>
124                <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstBin.html#GstBin-struct">GstBin</a>
125                    <span class="lineart">╰──</span> GstAudioParse
126</pre>
127</div>
128<div class="refsect1">
129<a name="gst-plugins-bad-plugins-audioparse.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
130<p>
131GstAudioParse implements
132 <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstChildProxy.html#GstChildProxy-struct">GstChildProxy</a>.</p>
133</div>
134<div class="refsect1">
135<a name="gst-plugins-bad-plugins-audioparse.description"></a><h2>Description</h2>
136<p>Converts a byte stream into audio frames.</p>
137<p>This element is deprecated. Use <a href="/usr/share/gtk-doc/html/gst-plugins-base-plugins-1.0/gst-plugins-base-plugins-unalignedvideoparse.html#GstRawAudioParse-struct"><span class="type">GstRawAudioParse</span></a> instead.</p>
138<div class="refsynopsisdiv">
139<h2>Synopsis</h2>
140<div class="refsect2">
141<a name="id-1.2.15.8.4.1"></a><h3>Element Information</h3>
142<div class="variablelist"><table border="0" class="variablelist">
143<colgroup>
144<col align="left" valign="top">
145<col>
146</colgroup>
147<tbody>
148<tr>
149<td><p><span class="term">plugin</span></p></td>
150<td>
151            <a class="link" href="gst-plugins-bad-plugins-plugin-legacyrawparse.html#plugin-legacyrawparse">legacyrawparse</a>
152          </td>
153</tr>
154<tr>
155<td><p><span class="term">author</span></p></td>
156<td>Sebastian Dröge &lt;sebastian.droege@collabora.co.uk&gt;</td>
157</tr>
158<tr>
159<td><p><span class="term">class</span></p></td>
160<td>Filter/Audio</td>
161</tr>
162</tbody>
163</table></div>
164</div>
165<hr>
166<div class="refsect2">
167<a name="id-1.2.15.8.4.2"></a><h3>Element Pads</h3>
168<div class="variablelist"><table border="0" class="variablelist">
169<colgroup>
170<col align="left" valign="top">
171<col>
172</colgroup>
173<tbody>
174<tr>
175<td><p><span class="term">name</span></p></td>
176<td>sink</td>
177</tr>
178<tr>
179<td><p><span class="term">direction</span></p></td>
180<td>sink</td>
181</tr>
182<tr>
183<td><p><span class="term">presence</span></p></td>
184<td>always</td>
185</tr>
186<tr>
187<td><p><span class="term">details</span></p></td>
188<td>ANY</td>
189</tr>
190</tbody>
191</table></div>
192<div class="variablelist"><table border="0" class="variablelist">
193<colgroup>
194<col align="left" valign="top">
195<col>
196</colgroup>
197<tbody>
198<tr>
199<td><p><span class="term">name</span></p></td>
200<td>src</td>
201</tr>
202<tr>
203<td><p><span class="term">direction</span></p></td>
204<td>source</td>
205</tr>
206<tr>
207<td><p><span class="term">presence</span></p></td>
208<td>always</td>
209</tr>
210<tr>
211<td><p><span class="term">details</span></p></td>
212<td>audio/x-raw, format=(string){ S8, U8, S16LE, S16BE, U16LE, U16BE, S24_32LE, S24_32BE, U24_32LE, U24_32BE, S32LE, S32BE, U32LE, U32BE, S24LE, S24BE, U24LE, U24BE, S20LE, S20BE, U20LE, U20BE, S18LE, S18BE, U18LE, U18BE, F32LE, F32BE, F64LE, F64BE }, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], layout=(string){ interleaved, non-interleaved }</td>
213</tr>
214<tr>
215<td><p><span class="term"></span></p></td>
216<td> audio/x-unaligned-raw, format=(string){ S8, U8, S16LE, S16BE, U16LE, U16BE, S24_32LE, S24_32BE, U24_32LE, U24_32BE, S32LE, S32BE, U32LE, U32BE, S24LE, S24BE, U24LE, U24BE, S20LE, S20BE, U20LE, U20BE, S18LE, S18BE, U18LE, U18BE, F32LE, F32BE, F64LE, F64BE }, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ], layout=(string){ interleaved, non-interleaved }</td>
217</tr>
218<tr>
219<td><p><span class="term"></span></p></td>
220<td> audio/x-alaw, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
221</tr>
222<tr>
223<td><p><span class="term"></span></p></td>
224<td> audio/x-mulaw, rate=(int)[ 1, 2147483647 ], channels=(int)[ 1, 2147483647 ]</td>
225</tr>
226</tbody>
227</table></div>
228</div>
229</div>
230</div>
231<div class="refsect1">
232<a name="gst-plugins-bad-plugins-audioparse.functions_details"></a><h2>Functions</h2>
233<p></p>
234</div>
235<div class="refsect1">
236<a name="gst-plugins-bad-plugins-audioparse.other_details"></a><h2>Types and Values</h2>
237<div class="refsect2">
238<a name="GstAudioParse-struct"></a><h3>struct GstAudioParse</h3>
239<pre class="programlisting">struct GstAudioParse;</pre>
240</div>
241</div>
242<div class="refsect1">
243<a name="gst-plugins-bad-plugins-audioparse.property-details"></a><h2>Property Details</h2>
244<div class="refsect2">
245<a name="GstAudioParse--channels"></a><h3>The <code class="literal">“channels”</code> property</h3>
246<pre class="programlisting">  “channels”                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
247<p>Number of channels in raw stream.</p>
248<p>Flags: Read / Write</p>
249<p>Allowed values: [1,64]</p>
250<p>Default value: 2</p>
251</div>
252<hr>
253<div class="refsect2">
254<a name="GstAudioParse--depth"></a><h3>The <code class="literal">“depth”</code> property</h3>
255<pre class="programlisting">  “depth”                    <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
256<p>Depth of audio samples in raw stream.</p>
257<p>Flags: Read / Write</p>
258<p>Allowed values: &gt;= 1</p>
259<p>Default value: 16</p>
260</div>
261<hr>
262<div class="refsect2">
263<a name="GstAudioParse--endianness"></a><h3>The <code class="literal">“endianness”</code> property</h3>
264<pre class="programlisting">  “endianness”               <span class="type">GstAudioParseEndianness</span></pre>
265<p>Endianness of audio samples in raw stream.</p>
266<p>Flags: Read / Write</p>
267<p>Default value: Little Endian</p>
268</div>
269<hr>
270<div class="refsect2">
271<a name="GstAudioParse--format"></a><h3>The <code class="literal">“format”</code> property</h3>
272<pre class="programlisting">  “format”                   <span class="type">GstAudioParseFormat</span></pre>
273<p>Format of audio samples in raw stream.</p>
274<p>Flags: Read / Write</p>
275<p>Default value: Raw</p>
276</div>
277<hr>
278<div class="refsect2">
279<a name="GstAudioParse--rate"></a><h3>The <code class="literal">“rate”</code> property</h3>
280<pre class="programlisting">  “rate”                     <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
281<p>Rate of audio samples in raw stream.</p>
282<p>Flags: Read / Write</p>
283<p>Allowed values: &gt;= 1</p>
284<p>Default value: 44100</p>
285</div>
286<hr>
287<div class="refsect2">
288<a name="GstAudioParse--signed"></a><h3>The <code class="literal">“signed”</code> property</h3>
289<pre class="programlisting">  “signed”                   <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
290<p>Sign of audio samples in raw stream.</p>
291<p>Flags: Read / Write</p>
292<p>Default value: TRUE</p>
293</div>
294<hr>
295<div class="refsect2">
296<a name="GstAudioParse--width"></a><h3>The <code class="literal">“width”</code> property</h3>
297<pre class="programlisting">  “width”                    <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gint"><span class="type">gint</span></a></pre>
298<p>Width of audio samples in raw stream.</p>
299<p>Flags: Read / Write</p>
300<p>Allowed values: &gt;= 1</p>
301<p>Default value: 16</p>
302</div>
303<hr>
304<div class="refsect2">
305<a name="GstAudioParse--channel-positions"></a><h3>The <code class="literal">“channel-positions”</code> property</h3>
306<pre class="programlisting">  “channel-positions”        <a href="/usr/share/gtk-doc/html/gobject/gobject-Value-arrays.html#GValueArray-struct"><span class="type">GValueArray</span></a> *</pre>
307<p>Channel positions used on the output.</p>
308<p>Flags: Read / Write</p>
309</div>
310<hr>
311<div class="refsect2">
312<a name="GstAudioParse--interleaved"></a><h3>The <code class="literal">“interleaved”</code> property</h3>
313<pre class="programlisting">  “interleaved”              <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
314<p>True if audio has interleaved layout.</p>
315<p>Flags: Read / Write</p>
316<p>Default value: TRUE</p>
317</div>
318<hr>
319<div class="refsect2">
320<a name="GstAudioParse--raw-format"></a><h3>The <code class="literal">“raw-format”</code> property</h3>
321<pre class="programlisting">  “raw-format”               <a href="/usr/share/gtk-doc/html/gst-plugins-base-libs-1.0/gst-plugins-base-libs-GstAudio.html#GstAudioFormat"><span class="type">GstAudioFormat</span></a></pre>
322<p>Format of audio samples in raw stream.</p>
323<p>Flags: Read / Write</p>
324<p>Default value: GST_AUDIO_FORMAT_S16LE</p>
325</div>
326<hr>
327<div class="refsect2">
328<a name="GstAudioParse--use-sink-caps"></a><h3>The <code class="literal">“use-sink-caps”</code> property</h3>
329<pre class="programlisting">  “use-sink-caps”            <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
330<p>Use the sink caps for the format, only performing timestamping.</p>
331<p>Flags: Read / Write</p>
332<p>Default value: FALSE</p>
333</div>
334</div>
335</div>
336<div class="footer">
337<hr>Generated by GTK-Doc V1.28</div>
338</body>
339</html>