Tizen 2.0 Release
[framework/multimedia/gst-plugins-good0.10.git] / docs / plugins / html / gst-plugins-good-plugins-matroskamux.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>matroskamux</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-level.html" title="level">
10 <link rel="next" href="gst-plugins-good-plugins-matroskademux.html" title="matroskademux">
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-level.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-matroskademux.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-matroskamux.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-good-plugins-matroskamux.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#gst-plugins-good-plugins-matroskamux.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#gst-plugins-good-plugins-matroskamux.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
31                    | 
32                   <a href="#gst-plugins-good-plugins-matroskamux.properties" class="shortcut">Properties</a>
33 </td></tr>
34 </table>
35 <div class="refentry">
36 <a name="gst-plugins-good-plugins-matroskamux"></a><div class="titlepage"></div>
37 <div class="refnamediv"><table width="100%"><tr>
38 <td valign="top">
39 <h2><span class="refentrytitle"><a name="gst-plugins-good-plugins-matroskamux.top_of_page"></a>matroskamux</span></h2>
40 <p>matroskamux — Muxes video/audio/subtitle streams into a matroska stream</p>
41 </td>
42 <td valign="top" align="right"></td>
43 </tr></table></div>
44 <div class="refsynopsisdiv">
45 <a name="gst-plugins-good-plugins-matroskamux.synopsis"></a><h2>Synopsis</h2>
46 <a name="GstMatroskaMux"></a><pre class="synopsis">                    <a class="link" href="gst-plugins-good-plugins-matroskamux.html#GstMatroskaMux-struct" title="GstMatroskaMux">GstMatroskaMux</a>;
47 </pre>
48 </div>
49 <div class="refsect1">
50 <a name="gst-plugins-good-plugins-matroskamux.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                +----GstMatroskaMux
56                      +----<a class="link" href="gst-plugins-good-plugins-webmmux.html#GstWebMMux">GstWebMMux</a>
57 </pre>
58 </div>
59 <div class="refsect1">
60 <a name="gst-plugins-good-plugins-matroskamux.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
61 <p>
62 GstMatroskaMux implements
63  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstTagSetter.html">GstTagSetter</a>.</p>
64 </div>
65 <div class="refsect1">
66 <a name="gst-plugins-good-plugins-matroskamux.properties"></a><h2>Properties</h2>
67 <pre class="synopsis">
68   "<a class="link" href="gst-plugins-good-plugins-matroskamux.html#GstMatroskaMux--writing-app" title='The "writing-app" property'>writing-app</a>"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
69   "<a class="link" href="gst-plugins-good-plugins-matroskamux.html#GstMatroskaMux--version" title='The "version" property'>version</a>"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
70   "<a class="link" href="gst-plugins-good-plugins-matroskamux.html#GstMatroskaMux--min-index-interval" title='The "min-index-interval" property'>min-index-interval</a>"       <span class="type">gint64</span>                : Read / Write
71   "<a class="link" href="gst-plugins-good-plugins-matroskamux.html#GstMatroskaMux--streamable" title='The "streamable" property'>streamable</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
72 </pre>
73 </div>
74 <div class="refsect1">
75 <a name="gst-plugins-good-plugins-matroskamux.description"></a><h2>Description</h2>
76 <p>
77 matroskamux muxes different input streams into a Matroska file.
78 </p>
79 <p>
80 </p>
81 <div class="refsect2">
82 <a name="idp17457520"></a><h3>Example launch line</h3>
83 <div class="informalexample">
84   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
85     <tbody>
86       <tr>
87         <td class="listing_lines" align="right"><pre>1</pre></td>
88         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v filesrc location<span class="gtkdoc opt">=/</span>path<span class="gtkdoc opt">/</span>to<span class="gtkdoc opt">/</span>mp3 <span class="gtkdoc opt">!</span> mp3parse <span class="gtkdoc opt">!</span> matroskamux name<span class="gtkdoc opt">=</span>mux <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>test<span class="gtkdoc opt">.</span>mkv  filesrc location<span class="gtkdoc opt">=/</span>path<span class="gtkdoc opt">/</span>to<span class="gtkdoc opt">/</span>theora<span class="gtkdoc opt">.</span>ogg <span class="gtkdoc opt">!</span> oggdemux <span class="gtkdoc opt">!</span> theoraparse <span class="gtkdoc opt">!</span> mux<span class="gtkdoc opt">.</span></pre></td>
89       </tr>
90     </tbody>
91   </table>
92 </div>
93  This pipeline muxes an MP3 file and a Ogg Theora video into a Matroska file.
94 <div class="informalexample">
95   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
96     <tbody>
97       <tr>
98         <td class="listing_lines" align="right"><pre>1</pre></td>
99         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch <span class="gtkdoc opt">-</span>v audiotestsrc num<span class="gtkdoc opt">-</span>buffers<span class="gtkdoc opt">=</span><span class="number">100</span> <span class="gtkdoc opt">!</span> audioconvert <span class="gtkdoc opt">!</span> vorbisenc <span class="gtkdoc opt">!</span> matroskamux <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>test<span class="gtkdoc opt">.</span>mka</pre></td>
100       </tr>
101     </tbody>
102   </table>
103 </div>
104  This pipeline muxes a 440Hz sine wave encoded with the Vorbis codec into a Matroska file.
105 </div>
106 <p>
107 </p>
108 <div class="refsynopsisdiv">
109 <h2>Synopsis</h2>
110 <div class="refsect2">
111 <a name="idp17725088"></a><h3>Element Information</h3>
112 <div class="variablelist"><table border="0">
113 <col align="left" valign="top">
114 <tbody>
115 <tr>
116 <td><p><span class="term">plugin</span></p></td>
117 <td>
118             <a class="link" href="gst-plugins-good-plugins-plugin-matroska.html#plugin-matroska">matroska</a>
119           </td>
120 </tr>
121 <tr>
122 <td><p><span class="term">author</span></p></td>
123 <td>GStreamer maintainers &lt;gstreamer-devel@lists.sourceforge.net&gt;</td>
124 </tr>
125 <tr>
126 <td><p><span class="term">class</span></p></td>
127 <td>Codec/Muxer</td>
128 </tr>
129 </tbody>
130 </table></div>
131 </div>
132 <hr>
133 <div class="refsect2">
134 <a name="idp13760608"></a><h3>Element Pads</h3>
135 <div class="variablelist"><table border="0">
136 <col align="left" valign="top">
137 <tbody>
138 <tr>
139 <td><p><span class="term">name</span></p></td>
140 <td>audio_%d</td>
141 </tr>
142 <tr>
143 <td><p><span class="term">direction</span></p></td>
144 <td>sink</td>
145 </tr>
146 <tr>
147 <td><p><span class="term">presence</span></p></td>
148 <td>request</td>
149 </tr>
150 <tr>
151 <td><p><span class="term">details</span></p></td>
152 <td>audio/mpeg, mpegversion=(int)1, layer=(int)[ 1, 3 ], channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ]</td>
153 </tr>
154 <tr>
155 <td><p><span class="term"></span></p></td>
156 <td> audio/mpeg, mpegversion=(int){ 2, 4 }, stream-format=(string)raw, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ]</td>
157 </tr>
158 <tr>
159 <td><p><span class="term"></span></p></td>
160 <td> audio/x-ac3, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ]</td>
161 </tr>
162 <tr>
163 <td><p><span class="term"></span></p></td>
164 <td> audio/x-eac3, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ]</td>
165 </tr>
166 <tr>
167 <td><p><span class="term"></span></p></td>
168 <td> audio/x-dts, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ]</td>
169 </tr>
170 <tr>
171 <td><p><span class="term"></span></p></td>
172 <td> audio/x-vorbis, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ]</td>
173 </tr>
174 <tr>
175 <td><p><span class="term"></span></p></td>
176 <td> audio/x-flac, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ]</td>
177 </tr>
178 <tr>
179 <td><p><span class="term"></span></p></td>
180 <td> audio/x-speex, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ]</td>
181 </tr>
182 <tr>
183 <td><p><span class="term"></span></p></td>
184 <td> audio/x-raw-int, width=(int)8, depth=(int)8, signed=(boolean)false, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ]</td>
185 </tr>
186 <tr>
187 <td><p><span class="term"></span></p></td>
188 <td> audio/x-raw-int, width=(int)16, depth=(int)16, endianness=(int){ 4321, 1234 }, signed=(boolean)true, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ]</td>
189 </tr>
190 <tr>
191 <td><p><span class="term"></span></p></td>
192 <td> audio/x-raw-int, width=(int)24, depth=(int)24, endianness=(int){ 4321, 1234 }, signed=(boolean)true, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ]</td>
193 </tr>
194 <tr>
195 <td><p><span class="term"></span></p></td>
196 <td> audio/x-raw-int, width=(int)32, depth=(int)32, endianness=(int){ 4321, 1234 }, signed=(boolean)true, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ]</td>
197 </tr>
198 <tr>
199 <td><p><span class="term"></span></p></td>
200 <td> audio/x-raw-float, width=(int)[ 32, 64 ], endianness=(int)1234, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ]</td>
201 </tr>
202 <tr>
203 <td><p><span class="term"></span></p></td>
204 <td> audio/x-tta, width=(int){ 8, 16, 24 }, channels=(int){ 1, 2 }, rate=(int)[ 8000, 96000 ]</td>
205 </tr>
206 <tr>
207 <td><p><span class="term"></span></p></td>
208 <td> audio/x-pn-realaudio, raversion=(int){ 1, 2, 8 }, channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ]</td>
209 </tr>
210 <tr>
211 <td><p><span class="term"></span></p></td>
212 <td> audio/x-wma, wmaversion=(int)[ 1, 3 ], block_align=(int)[ 0, 65535 ], bitrate=(int)[ 0, 524288 ], channels=(int)[ 1, 2147483647 ], rate=(int)[ 1, 2147483647 ]</td>
213 </tr>
214 <tr>
215 <td><p><span class="term"></span></p></td>
216 <td> audio/x-alaw, channels=(int){ 1, 2 }, rate=(int)[ 8000, 192000 ]</td>
217 </tr>
218 <tr>
219 <td><p><span class="term"></span></p></td>
220 <td> audio/x-mulaw, channels=(int){ 1, 2 }, rate=(int)[ 8000, 192000 ]</td>
221 </tr>
222 </tbody>
223 </table></div>
224 <div class="variablelist"><table border="0">
225 <col align="left" valign="top">
226 <tbody>
227 <tr>
228 <td><p><span class="term">name</span></p></td>
229 <td>subtitle_%d</td>
230 </tr>
231 <tr>
232 <td><p><span class="term">direction</span></p></td>
233 <td>sink</td>
234 </tr>
235 <tr>
236 <td><p><span class="term">presence</span></p></td>
237 <td>request</td>
238 </tr>
239 <tr>
240 <td><p><span class="term">details</span></p></td>
241 <td>subtitle/x-kate</td>
242 </tr>
243 </tbody>
244 </table></div>
245 <div class="variablelist"><table border="0">
246 <col align="left" valign="top">
247 <tbody>
248 <tr>
249 <td><p><span class="term">name</span></p></td>
250 <td>video_%d</td>
251 </tr>
252 <tr>
253 <td><p><span class="term">direction</span></p></td>
254 <td>sink</td>
255 </tr>
256 <tr>
257 <td><p><span class="term">presence</span></p></td>
258 <td>request</td>
259 </tr>
260 <tr>
261 <td><p><span class="term">details</span></p></td>
262 <td>video/mpeg, mpegversion=(int){ 1, 2, 4 }, systemstream=(boolean)false, width=(int)[ 16, 4096 ], height=(int)[ 16, 4096 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
263 </tr>
264 <tr>
265 <td><p><span class="term"></span></p></td>
266 <td> video/x-h264, stream-format=(string)avc, alignment=(string)au, width=(int)[ 16, 4096 ], height=(int)[ 16, 4096 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
267 </tr>
268 <tr>
269 <td><p><span class="term"></span></p></td>
270 <td> video/x-divx, width=(int)[ 16, 4096 ], height=(int)[ 16, 4096 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
271 </tr>
272 <tr>
273 <td><p><span class="term"></span></p></td>
274 <td> video/x-xvid, width=(int)[ 16, 4096 ], height=(int)[ 16, 4096 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
275 </tr>
276 <tr>
277 <td><p><span class="term"></span></p></td>
278 <td> video/x-huffyuv, width=(int)[ 16, 4096 ], height=(int)[ 16, 4096 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
279 </tr>
280 <tr>
281 <td><p><span class="term"></span></p></td>
282 <td> video/x-dv, width=(int)[ 16, 4096 ], height=(int)[ 16, 4096 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
283 </tr>
284 <tr>
285 <td><p><span class="term"></span></p></td>
286 <td> video/x-h263, width=(int)[ 16, 4096 ], height=(int)[ 16, 4096 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
287 </tr>
288 <tr>
289 <td><p><span class="term"></span></p></td>
290 <td> video/x-msmpeg, width=(int)[ 16, 4096 ], height=(int)[ 16, 4096 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
291 </tr>
292 <tr>
293 <td><p><span class="term"></span></p></td>
294 <td> image/jpeg, width=(int)[ 16, 4096 ], height=(int)[ 16, 4096 ]</td>
295 </tr>
296 <tr>
297 <td><p><span class="term"></span></p></td>
298 <td> video/x-theora</td>
299 </tr>
300 <tr>
301 <td><p><span class="term"></span></p></td>
302 <td> video/x-dirac, width=(int)[ 16, 4096 ], height=(int)[ 16, 4096 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
303 </tr>
304 <tr>
305 <td><p><span class="term"></span></p></td>
306 <td> video/x-pn-realvideo, rmversion=(int)[ 1, 4 ], width=(int)[ 16, 4096 ], height=(int)[ 16, 4096 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
307 </tr>
308 <tr>
309 <td><p><span class="term"></span></p></td>
310 <td> video/x-vp8, width=(int)[ 16, 4096 ], height=(int)[ 16, 4096 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
311 </tr>
312 <tr>
313 <td><p><span class="term"></span></p></td>
314 <td> video/x-raw-yuv, format=(fourcc){ YUY2, I420, YV12, UYVY, AYUV }, width=(int)[ 16, 4096 ], height=(int)[ 16, 4096 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
315 </tr>
316 <tr>
317 <td><p><span class="term"></span></p></td>
318 <td> video/x-wmv, wmvversion=(int)[ 1, 3 ], width=(int)[ 16, 4096 ], height=(int)[ 16, 4096 ], framerate=(fraction)[ 0/1, 2147483647/1 ]</td>
319 </tr>
320 </tbody>
321 </table></div>
322 <div class="variablelist"><table border="0">
323 <col align="left" valign="top">
324 <tbody>
325 <tr>
326 <td><p><span class="term">name</span></p></td>
327 <td>src</td>
328 </tr>
329 <tr>
330 <td><p><span class="term">direction</span></p></td>
331 <td>source</td>
332 </tr>
333 <tr>
334 <td><p><span class="term">presence</span></p></td>
335 <td>always</td>
336 </tr>
337 <tr>
338 <td><p><span class="term">details</span></p></td>
339 <td>video/x-matroska</td>
340 </tr>
341 </tbody>
342 </table></div>
343 </div>
344 </div>
345 <p>
346 </p>
347 </div>
348 <div class="refsect1">
349 <a name="gst-plugins-good-plugins-matroskamux.details"></a><h2>Details</h2>
350 <div class="refsect2">
351 <a name="GstMatroskaMux-struct"></a><h3>GstMatroskaMux</h3>
352 <pre class="programlisting">typedef struct _GstMatroskaMux GstMatroskaMux;</pre>
353 <p>
354 </p>
355 </div>
356 </div>
357 <div class="refsect1">
358 <a name="gst-plugins-good-plugins-matroskamux.property-details"></a><h2>Property Details</h2>
359 <div class="refsect2">
360 <a name="GstMatroskaMux--writing-app"></a><h3>The <code class="literal">"writing-app"</code> property</h3>
361 <pre class="programlisting">  "writing-app"              <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
362 <p>The name the application that creates the matroska file.</p>
363 <p>Default value: NULL</p>
364 </div>
365 <hr>
366 <div class="refsect2">
367 <a name="GstMatroskaMux--version"></a><h3>The <code class="literal">"version"</code> property</h3>
368 <pre class="programlisting">  "version"                  <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
369 <p>This parameter determines what Matroska features can be used.</p>
370 <p>Allowed values: [1,2]</p>
371 <p>Default value: 2</p>
372 </div>
373 <hr>
374 <div class="refsect2">
375 <a name="GstMatroskaMux--min-index-interval"></a><h3>The <code class="literal">"min-index-interval"</code> property</h3>
376 <pre class="programlisting">  "min-index-interval"       <span class="type">gint64</span>                : Read / Write</pre>
377 <p>An index entry is created every so many nanoseconds.</p>
378 <p>Allowed values: &gt;= 0</p>
379 <p>Default value: 0</p>
380 </div>
381 <hr>
382 <div class="refsect2">
383 <a name="GstMatroskaMux--streamable"></a><h3>The <code class="literal">"streamable"</code> property</h3>
384 <pre class="programlisting">  "streamable"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
385 <p>If set to true, the output should be as if it is to be streamed and hence no indexes written or duration written.</p>
386 <p>Default value: FALSE</p>
387 </div>
388 </div>
389 </div>
390 <div class="footer">
391 <hr>
392           Generated by GTK-Doc V1.18</div>
393 </body>
394 </html>