Tizen 2.0 Release
[framework/multimedia/gst-plugins-good0.10.git] / docs / plugins / html / gst-plugins-good-plugins-multipartdemux.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>multipartdemux</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GStreamer Good Plugins 0.10 Plugins Reference Manual">
8 <link rel="up" href="ch01.html" title="gst-plugins-good Elements">
9 <link rel="prev" href="gst-plugins-good-plugins-multifilesrc.html" title="multifilesrc">
10 <link rel="next" href="gst-plugins-good-plugins-multipartmux.html" title="multipartmux">
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-good-plugins-multifilesrc.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 Good Plugins 0.10 Plugins Reference Manual</th>
21 <td><a accesskey="n" href="gst-plugins-good-plugins-multipartmux.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-good-plugins-multipartdemux.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-good-plugins-multipartdemux.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#gst-plugins-good-plugins-multipartdemux.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#gst-plugins-good-plugins-multipartdemux.properties" class="shortcut">Properties</a>
31 </td></tr>
32 </table>
33 <div class="refentry">
34 <a name="gst-plugins-good-plugins-multipartdemux"></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-good-plugins-multipartdemux.top_of_page"></a>multipartdemux</span></h2>
38 <p>multipartdemux — demux multipart streams</p>
39 </td>
40 <td valign="top" align="right"></td>
41 </tr></table></div>
42 <div class="refsynopsisdiv">
43 <a name="gst-plugins-good-plugins-multipartdemux.synopsis"></a><h2>Synopsis</h2>
44 <a name="GstMultipartDemux"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-multipartdemux.html#GstMultipartDemux-struct" title="struct GstMultipartDemux">GstMultipartDemux</a>;
45 </pre>
46 </div>
47 <div class="refsect1">
48 <a name="gst-plugins-good-plugins-multipartdemux.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                +----GstMultipartDemux
54 </pre>
55 </div>
56 <div class="refsect1">
57 <a name="gst-plugins-good-plugins-multipartdemux.properties"></a><h2>Properties</h2>
58 <pre class="synopsis">
59   "<a class="link" href="gst-plugins-good-plugins-multipartdemux.html#GstMultipartDemux--autoscan" title='The "autoscan" property'>autoscan</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
60   "<a class="link" href="gst-plugins-good-plugins-multipartdemux.html#GstMultipartDemux--boundary" title='The "boundary" property'>boundary</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct
61   "<a class="link" href="gst-plugins-good-plugins-multipartdemux.html#GstMultipartDemux--single-stream" title='The "single-stream" property'>single-stream</a>"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
62 </pre>
63 </div>
64 <div class="refsect1">
65 <a name="gst-plugins-good-plugins-multipartdemux.description"></a><h2>Description</h2>
66 <p>
67 MultipartDemux uses the Content-type field of incoming buffers to demux and 
68 push data to dynamic source pads. Most of the time multipart streams are 
69 sequential JPEG frames generated from a live source such as a network source
70 or a camera.
71 </p>
72 <p>
73 The output buffers of the multipartdemux typically have no timestamps and are
74 usually played as fast as possible (at the rate that the source provides the
75 data).
76 </p>
77 <p>
78 the content in multipart files is separated with a boundary string that can
79 be configured specifically with the <a class="link" href="gst-plugins-good-plugins-multipartdemux.html#GstMultipartDemux--boundary" title='The "boundary" property'><span class="type">"boundary"</span></a> property
80 otherwise it will be autodetected.
81 </p>
82 <p>
83 </p>
84 <div class="refsect2">
85 <a name="idp8163344"></a><h3>Sample pipelines</h3>
86 <div class="informalexample">
87   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
88     <tbody>
89       <tr>
90         <td class="listing_lines" align="right"><pre>1</pre></td>
91         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch filesrc location<span class="gtkdoc opt">=/</span>tmp<span class="gtkdoc opt">/</span>test<span class="gtkdoc opt">.</span>multipart <span class="gtkdoc opt">!</span> multipartdemux <span class="gtkdoc opt">!</span> jpegdec <span class="gtkdoc opt">!</span> ffmpegcolorspace <span class="gtkdoc opt">!</span> ximagesink</pre></td>
92       </tr>
93     </tbody>
94   </table>
95 </div>
96  a simple pipeline to demux a multipart file muxed with <a class="link" href="gst-plugins-good-plugins-multipartmux.html#GstMultipartMux"><span class="type">GstMultipartMux</span></a>
97 containing JPEG frames.
98 </div>
99 <p>
100 </p>
101 <div class="refsynopsisdiv">
102 <h2>Synopsis</h2>
103 <div class="refsect2">
104 <a name="idp15215184"></a><h3>Element Information</h3>
105 <div class="variablelist"><table border="0">
106 <col align="left" valign="top">
107 <tbody>
108 <tr>
109 <td><p><span class="term">plugin</span></p></td>
110 <td>
111             <a class="link" href="gst-plugins-good-plugins-plugin-multipart.html#plugin-multipart">multipart</a>
112           </td>
113 </tr>
114 <tr>
115 <td><p><span class="term">author</span></p></td>
116 <td>Wim Taymans &lt;wim.taymans@gmail.com&gt;, Sjoerd Simons &lt;sjoerd@luon.net&gt;</td>
117 </tr>
118 <tr>
119 <td><p><span class="term">class</span></p></td>
120 <td>Codec/Demuxer</td>
121 </tr>
122 </tbody>
123 </table></div>
124 </div>
125 <hr>
126 <div class="refsect2">
127 <a name="idp18269712"></a><h3>Element Pads</h3>
128 <div class="variablelist"><table border="0">
129 <col align="left" valign="top">
130 <tbody>
131 <tr>
132 <td><p><span class="term">name</span></p></td>
133 <td>sink</td>
134 </tr>
135 <tr>
136 <td><p><span class="term">direction</span></p></td>
137 <td>sink</td>
138 </tr>
139 <tr>
140 <td><p><span class="term">presence</span></p></td>
141 <td>always</td>
142 </tr>
143 <tr>
144 <td><p><span class="term">details</span></p></td>
145 <td>multipart/x-mixed-replace</td>
146 </tr>
147 </tbody>
148 </table></div>
149 <div class="variablelist"><table border="0">
150 <col align="left" valign="top">
151 <tbody>
152 <tr>
153 <td><p><span class="term">name</span></p></td>
154 <td>src_%d</td>
155 </tr>
156 <tr>
157 <td><p><span class="term">direction</span></p></td>
158 <td>source</td>
159 </tr>
160 <tr>
161 <td><p><span class="term">presence</span></p></td>
162 <td>sometimes</td>
163 </tr>
164 <tr>
165 <td><p><span class="term">details</span></p></td>
166 <td>ANY</td>
167 </tr>
168 </tbody>
169 </table></div>
170 </div>
171 </div>
172 <p>
173 </p>
174 </div>
175 <div class="refsect1">
176 <a name="gst-plugins-good-plugins-multipartdemux.details"></a><h2>Details</h2>
177 <div class="refsect2">
178 <a name="GstMultipartDemux-struct"></a><h3>struct GstMultipartDemux</h3>
179 <pre class="programlisting">struct GstMultipartDemux;</pre>
180 <p>
181 The opaque <a class="link" href="gst-plugins-good-plugins-multipartdemux.html#GstMultipartDemux"><span class="type">GstMultipartDemux</span></a> structure.
182 </p>
183 </div>
184 </div>
185 <div class="refsect1">
186 <a name="gst-plugins-good-plugins-multipartdemux.property-details"></a><h2>Property Details</h2>
187 <div class="refsect2">
188 <a name="GstMultipartDemux--autoscan"></a><h3>The <code class="literal">"autoscan"</code> property</h3>
189 <pre class="programlisting">  "autoscan"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
190 <p>Try to autofind the prefix (deprecated unused, see boundary).</p>
191 <p>Default value: FALSE</p>
192 </div>
193 <hr>
194 <div class="refsect2">
195 <a name="GstMultipartDemux--boundary"></a><h3>The <code class="literal">"boundary"</code> property</h3>
196 <pre class="programlisting">  "boundary"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write / Construct</pre>
197 <p>The boundary string separating data, automatic if NULL.</p>
198 <p>Default value: NULL</p>
199 </div>
200 <hr>
201 <div class="refsect2">
202 <a name="GstMultipartDemux--single-stream"></a><h3>The <code class="literal">"single-stream"</code> property</h3>
203 <pre class="programlisting">  "single-stream"            <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
204 <p>Assume that there is only one stream whose content-type will not change and emit no-more-pads as soon as the first boundary content is parsed, decoded, and pads are linked.</p>
205 <p>Default value: FALSE</p>
206 </div>
207 </div>
208 <div class="refsect1">
209 <a name="gst-plugins-good-plugins-multipartdemux.see-also"></a><h2>See Also</h2>
210 <a class="link" href="gst-plugins-good-plugins-multipartmux.html#GstMultipartMux"><span class="type">GstMultipartMux</span></a>
211 </div>
212 </div>
213 <div class="footer">
214 <hr>
215           Generated by GTK-Doc V1.18</div>
216 </body>
217 </html>