Tizen 2.0 Release
[framework/multimedia/gst-plugins-good0.10.git] / docs / plugins / html / gst-plugins-good-plugins-multipartmux.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>multipartmux</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-multipartdemux.html" title="multipartdemux">
10 <link rel="next" href="gst-plugins-good-plugins-multiudpsink.html" title="multiudpsink">
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-multipartdemux.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-multiudpsink.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-multipartmux.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-good-plugins-multipartmux.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#gst-plugins-good-plugins-multipartmux.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#gst-plugins-good-plugins-multipartmux.properties" class="shortcut">Properties</a>
31 </td></tr>
32 </table>
33 <div class="refentry">
34 <a name="gst-plugins-good-plugins-multipartmux"></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-multipartmux.top_of_page"></a>multipartmux</span></h2>
38 <p>multipartmux — mux 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-multipartmux.synopsis"></a><h2>Synopsis</h2>
44 <a name="GstMultipartMux"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-good-plugins-multipartmux.html#GstMultipartMux-struct" title="struct GstMultipartMux">GstMultipartMux</a>;
45 </pre>
46 </div>
47 <div class="refsect1">
48 <a name="gst-plugins-good-plugins-multipartmux.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                +----GstMultipartMux
54 </pre>
55 </div>
56 <div class="refsect1">
57 <a name="gst-plugins-good-plugins-multipartmux.properties"></a><h2>Properties</h2>
58 <pre class="synopsis">
59   "<a class="link" href="gst-plugins-good-plugins-multipartmux.html#GstMultipartMux--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
60 </pre>
61 </div>
62 <div class="refsect1">
63 <a name="gst-plugins-good-plugins-multipartmux.description"></a><h2>Description</h2>
64 <p>
65 MultipartMux uses the <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/gstreamer-GstCaps.html#GstCaps"><span class="type">GstCaps</span></a> of the sink pad as the Content-type field for
66 incoming buffers when muxing them to a multipart stream. Most of the time 
67 multipart streams are sequential JPEG frames.
68 </p>
69 <p>
70 </p>
71 <div class="refsect2">
72 <a name="idp18337424"></a><h3>Sample pipelines</h3>
73 <div class="informalexample">
74   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
75     <tbody>
76       <tr>
77         <td class="listing_lines" align="right"><pre>1</pre></td>
78         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch videotestsrc <span class="gtkdoc opt">!</span> video<span class="gtkdoc opt">/</span>x<span class="gtkdoc opt">-</span>raw<span class="gtkdoc opt">-</span>yuv<span class="gtkdoc opt">,</span> framerate<span class="gtkdoc opt">=</span><span class="string">'(fraction)'</span><span class="number">5</span><span class="gtkdoc opt">/</span><span class="number">1</span> <span class="gtkdoc opt">!</span> jpegenc <span class="gtkdoc opt">!</span> multipartmux <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=/</span>tmp<span class="gtkdoc opt">/</span>test<span class="gtkdoc opt">.</span>multipart</pre></td>
79       </tr>
80     </tbody>
81   </table>
82 </div>
83  a pipeline to mux 5 JPEG frames per second into a multipart stream
84 stored to a file.
85 </div>
86 <p>
87 </p>
88 <div class="refsynopsisdiv">
89 <h2>Synopsis</h2>
90 <div class="refsect2">
91 <a name="idp18679792"></a><h3>Element Information</h3>
92 <div class="variablelist"><table border="0">
93 <col align="left" valign="top">
94 <tbody>
95 <tr>
96 <td><p><span class="term">plugin</span></p></td>
97 <td>
98             <a class="link" href="gst-plugins-good-plugins-plugin-multipart.html#plugin-multipart">multipart</a>
99           </td>
100 </tr>
101 <tr>
102 <td><p><span class="term">author</span></p></td>
103 <td>Wim Taymans &lt;wim@fluendo.com&gt;</td>
104 </tr>
105 <tr>
106 <td><p><span class="term">class</span></p></td>
107 <td>Codec/Muxer</td>
108 </tr>
109 </tbody>
110 </table></div>
111 </div>
112 <hr>
113 <div class="refsect2">
114 <a name="idp13771472"></a><h3>Element Pads</h3>
115 <div class="variablelist"><table border="0">
116 <col align="left" valign="top">
117 <tbody>
118 <tr>
119 <td><p><span class="term">name</span></p></td>
120 <td>sink_%d</td>
121 </tr>
122 <tr>
123 <td><p><span class="term">direction</span></p></td>
124 <td>sink</td>
125 </tr>
126 <tr>
127 <td><p><span class="term">presence</span></p></td>
128 <td>request</td>
129 </tr>
130 <tr>
131 <td><p><span class="term">details</span></p></td>
132 <td>ANY</td>
133 </tr>
134 </tbody>
135 </table></div>
136 <div class="variablelist"><table border="0">
137 <col align="left" valign="top">
138 <tbody>
139 <tr>
140 <td><p><span class="term">name</span></p></td>
141 <td>src</td>
142 </tr>
143 <tr>
144 <td><p><span class="term">direction</span></p></td>
145 <td>source</td>
146 </tr>
147 <tr>
148 <td><p><span class="term">presence</span></p></td>
149 <td>always</td>
150 </tr>
151 <tr>
152 <td><p><span class="term">details</span></p></td>
153 <td>multipart/x-mixed-replace</td>
154 </tr>
155 </tbody>
156 </table></div>
157 </div>
158 </div>
159 <p>
160 </p>
161 </div>
162 <div class="refsect1">
163 <a name="gst-plugins-good-plugins-multipartmux.details"></a><h2>Details</h2>
164 <div class="refsect2">
165 <a name="GstMultipartMux-struct"></a><h3>struct GstMultipartMux</h3>
166 <pre class="programlisting">struct GstMultipartMux;</pre>
167 <p>
168 The opaque <a class="link" href="gst-plugins-good-plugins-multipartmux.html#GstMultipartMux"><span class="type">GstMultipartMux</span></a> structure.
169 </p>
170 </div>
171 </div>
172 <div class="refsect1">
173 <a name="gst-plugins-good-plugins-multipartmux.property-details"></a><h2>Property Details</h2>
174 <div class="refsect2">
175 <a name="GstMultipartMux--boundary"></a><h3>The <code class="literal">"boundary"</code> property</h3>
176 <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</pre>
177 <p>Boundary string.</p>
178 <p>Default value: "ThisRandomString"</p>
179 </div>
180 </div>
181 </div>
182 <div class="footer">
183 <hr>
184           Generated by GTK-Doc V1.18</div>
185 </body>
186 </html>