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>oggmux: GStreamer Base 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 Base Plugins 1.0 Plugins Reference Manual"> 8<link rel="up" href="ch01.html" title="gst-plugins-base Elements"> 9<link rel="prev" href="gst-plugins-base-plugins-oggdemux.html" title="oggdemux"> 10<link rel="next" href="gst-plugins-base-plugins-oggparse.html" title="oggparse"> 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">|</span> 18 <a href="#gst-plugins-base-plugins-oggmux.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> 19 <a href="#gst-plugins-base-plugins-oggmux.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> 20 <a href="#gst-plugins-base-plugins-oggmux.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> 21 <a href="#gst-plugins-base-plugins-oggmux.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-base-plugins-oggdemux.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> 26<td><a accesskey="n" href="gst-plugins-base-plugins-oggparse.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-base-plugins-oggmux"></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-base-plugins-oggmux.top_of_page"></a>oggmux</span></h2> 33<p>oggmux</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-base-plugins-oggmux.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#guint64"><span class="type">guint64</span></a></td> 48<td class="property_name"><a class="link" href="gst-plugins-base-plugins-oggmux.html#GstOggMux--max-delay" title="The “max-delay” property">max-delay</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#guint64"><span class="type">guint64</span></a></td> 53<td class="property_name"><a class="link" href="gst-plugins-base-plugins-oggmux.html#GstOggMux--max-page-delay" title="The “max-page-delay” property">max-page-delay</a></td> 54<td class="property_flags">Read / Write</td> 55</tr> 56<tr> 57<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></td> 58<td class="property_name"><a class="link" href="gst-plugins-base-plugins-oggmux.html#GstOggMux--max-tolerance" title="The “max-tolerance” property">max-tolerance</a></td> 59<td class="property_flags">Read / Write</td> 60</tr> 61<tr> 62<td class="property_type"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> 63<td class="property_name"><a class="link" href="gst-plugins-base-plugins-oggmux.html#GstOggMux--skeleton" title="The “skeleton” property">skeleton</a></td> 64<td class="property_flags">Read / Write</td> 65</tr> 66</tbody> 67</table></div> 68</div> 69<a name="GstOggMux"></a><div class="refsect1"> 70<a name="gst-plugins-base-plugins-oggmux.other"></a><h2>Types and Values</h2> 71<div class="informaltable"><table class="informaltable" width="100%" border="0"> 72<colgroup> 73<col width="150px" class="name"> 74<col class="description"> 75</colgroup> 76<tbody><tr> 77<td class="datatype_keyword">struct</td> 78<td class="function_name"><a class="link" href="gst-plugins-base-plugins-oggmux.html#GstOggMux-struct" title="struct GstOggMux">GstOggMux</a></td> 79</tr></tbody> 80</table></div> 81</div> 82<div class="refsect1"> 83<a name="gst-plugins-base-plugins-oggmux.object-hierarchy"></a><h2>Object Hierarchy</h2> 84<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> 85 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a> 86 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a> 87 <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a> 88 <span class="lineart">╰──</span> GstOggMux 89</pre> 90</div> 91<div class="refsect1"> 92<a name="gst-plugins-base-plugins-oggmux.implemented-interfaces"></a><h2>Implemented Interfaces</h2> 93<p> 94GstOggMux implements 95 <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstPreset.html#GstPreset-struct">GstPreset</a>.</p> 96</div> 97<div class="refsect1"> 98<a name="gst-plugins-base-plugins-oggmux.description"></a><h2>Description</h2> 99<p>This element merges streams (audio and video) into ogg files.</p> 100<div class="refsect3"> 101<a name="id-1.2.74.8.3"></a><h4>Example pipelines</h4> 102<div class="informalexample"> 103 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0"> 104 <tbody> 105 <tr> 106 <td class="listing_lines" align="right"><pre>1</pre></td> 107 <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch<span class="gtkdoc opt">-</span><span class="number">1.0</span> v4l2src num<span class="gtkdoc opt">-</span>buffers<span class="gtkdoc opt">=</span><span class="number">500</span> <span class="gtkdoc opt">!</span> video<span class="gtkdoc opt">/</span>x<span class="gtkdoc opt">-</span>raw<span class="gtkdoc opt">,</span>width<span class="gtkdoc opt">=</span><span class="number">320</span><span class="gtkdoc opt">,</span>height<span class="gtkdoc opt">=</span><span class="number">240</span> <span class="gtkdoc opt">!</span> videoconvert <span class="gtkdoc opt">!</span> videorate <span class="gtkdoc opt">!</span> theoraenc <span class="gtkdoc opt">!</span> oggmux <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>video<span class="gtkdoc opt">.</span>ogg</pre></td> 108 </tr> 109 </tbody> 110 </table> 111</div> 112 113<p> 114Encodes a video stream captured from a v4l2-compatible camera to Ogg/Theora 115(the encoding will stop automatically after 500 frames)</p> 116</div> 117<div class="refsynopsisdiv"> 118<h2>Synopsis</h2> 119<div class="refsect2"> 120<a name="id-1.2.74.8.4.1"></a><h3>Element Information</h3> 121<div class="variablelist"><table border="0" class="variablelist"> 122<colgroup> 123<col align="left" valign="top"> 124<col> 125</colgroup> 126<tbody> 127<tr> 128<td><p><span class="term">plugin</span></p></td> 129<td> 130 <a class="link" href="gst-plugins-base-plugins-plugin-ogg.html#plugin-ogg">ogg</a> 131 </td> 132</tr> 133<tr> 134<td><p><span class="term">author</span></p></td> 135<td>Wim Taymans <wim@fluendo.com></td> 136</tr> 137<tr> 138<td><p><span class="term">class</span></p></td> 139<td>Codec/Muxer</td> 140</tr> 141</tbody> 142</table></div> 143</div> 144<hr> 145<div class="refsect2"> 146<a name="id-1.2.74.8.4.2"></a><h3>Element Pads</h3> 147<div class="variablelist"><table border="0" class="variablelist"> 148<colgroup> 149<col align="left" valign="top"> 150<col> 151</colgroup> 152<tbody> 153<tr> 154<td><p><span class="term">name</span></p></td> 155<td>audio_%u</td> 156</tr> 157<tr> 158<td><p><span class="term">direction</span></p></td> 159<td>sink</td> 160</tr> 161<tr> 162<td><p><span class="term">presence</span></p></td> 163<td>request</td> 164</tr> 165<tr> 166<td><p><span class="term">details</span></p></td> 167<td>audio/x-vorbis</td> 168</tr> 169<tr> 170<td><p><span class="term"></span></p></td> 171<td> audio/x-flac</td> 172</tr> 173<tr> 174<td><p><span class="term"></span></p></td> 175<td> audio/x-speex</td> 176</tr> 177<tr> 178<td><p><span class="term"></span></p></td> 179<td> audio/x-celt</td> 180</tr> 181<tr> 182<td><p><span class="term"></span></p></td> 183<td> application/x-ogm-audio</td> 184</tr> 185<tr> 186<td><p><span class="term"></span></p></td> 187<td> audio/x-opus</td> 188</tr> 189</tbody> 190</table></div> 191<div class="variablelist"><table border="0" class="variablelist"> 192<colgroup> 193<col align="left" valign="top"> 194<col> 195</colgroup> 196<tbody> 197<tr> 198<td><p><span class="term">name</span></p></td> 199<td>subtitle_%u</td> 200</tr> 201<tr> 202<td><p><span class="term">direction</span></p></td> 203<td>sink</td> 204</tr> 205<tr> 206<td><p><span class="term">presence</span></p></td> 207<td>request</td> 208</tr> 209<tr> 210<td><p><span class="term">details</span></p></td> 211<td>text/x-cmml, encoded=(boolean)true</td> 212</tr> 213<tr> 214<td><p><span class="term"></span></p></td> 215<td> subtitle/x-kate</td> 216</tr> 217<tr> 218<td><p><span class="term"></span></p></td> 219<td> application/x-kate</td> 220</tr> 221</tbody> 222</table></div> 223<div class="variablelist"><table border="0" class="variablelist"> 224<colgroup> 225<col align="left" valign="top"> 226<col> 227</colgroup> 228<tbody> 229<tr> 230<td><p><span class="term">name</span></p></td> 231<td>video_%u</td> 232</tr> 233<tr> 234<td><p><span class="term">direction</span></p></td> 235<td>sink</td> 236</tr> 237<tr> 238<td><p><span class="term">presence</span></p></td> 239<td>request</td> 240</tr> 241<tr> 242<td><p><span class="term">details</span></p></td> 243<td>video/x-theora</td> 244</tr> 245<tr> 246<td><p><span class="term"></span></p></td> 247<td> application/x-ogm-video</td> 248</tr> 249<tr> 250<td><p><span class="term"></span></p></td> 251<td> video/x-dirac</td> 252</tr> 253<tr> 254<td><p><span class="term"></span></p></td> 255<td> video/x-smoke</td> 256</tr> 257<tr> 258<td><p><span class="term"></span></p></td> 259<td> video/x-vp8</td> 260</tr> 261<tr> 262<td><p><span class="term"></span></p></td> 263<td> video/x-daala</td> 264</tr> 265</tbody> 266</table></div> 267<div class="variablelist"><table border="0" class="variablelist"> 268<colgroup> 269<col align="left" valign="top"> 270<col> 271</colgroup> 272<tbody> 273<tr> 274<td><p><span class="term">name</span></p></td> 275<td>src</td> 276</tr> 277<tr> 278<td><p><span class="term">direction</span></p></td> 279<td>source</td> 280</tr> 281<tr> 282<td><p><span class="term">presence</span></p></td> 283<td>always</td> 284</tr> 285<tr> 286<td><p><span class="term">details</span></p></td> 287<td>application/ogg</td> 288</tr> 289<tr> 290<td><p><span class="term"></span></p></td> 291<td> audio/ogg</td> 292</tr> 293<tr> 294<td><p><span class="term"></span></p></td> 295<td> video/ogg</td> 296</tr> 297</tbody> 298</table></div> 299</div> 300</div> 301</div> 302<div class="refsect1"> 303<a name="gst-plugins-base-plugins-oggmux.functions_details"></a><h2>Functions</h2> 304<p></p> 305</div> 306<div class="refsect1"> 307<a name="gst-plugins-base-plugins-oggmux.other_details"></a><h2>Types and Values</h2> 308<div class="refsect2"> 309<a name="GstOggMux-struct"></a><h3>struct GstOggMux</h3> 310<pre class="programlisting">struct GstOggMux;</pre> 311<p>The ogg muxer object structure.</p> 312</div> 313</div> 314<div class="refsect1"> 315<a name="gst-plugins-base-plugins-oggmux.property-details"></a><h2>Property Details</h2> 316<div class="refsect2"> 317<a name="GstOggMux--max-delay"></a><h3>The <code class="literal">“max-delay”</code> property</h3> 318<pre class="programlisting"> “max-delay” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre> 319<p>Maximum delay in multiplexing streams.</p> 320<p>Flags: Read / Write</p> 321<p>Default value: 500000000</p> 322</div> 323<hr> 324<div class="refsect2"> 325<a name="GstOggMux--max-page-delay"></a><h3>The <code class="literal">“max-page-delay”</code> property</h3> 326<pre class="programlisting"> “max-page-delay” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre> 327<p>Maximum delay for sending out a page.</p> 328<p>Flags: Read / Write</p> 329<p>Default value: 500000000</p> 330</div> 331<hr> 332<div class="refsect2"> 333<a name="GstOggMux--max-tolerance"></a><h3>The <code class="literal">“max-tolerance”</code> property</h3> 334<pre class="programlisting"> “max-tolerance” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a></pre> 335<p>Maximum timestamp difference for maintaining perfect granules.</p> 336<p>Flags: Read / Write</p> 337<p>Default value: 40000000</p> 338</div> 339<hr> 340<div class="refsect2"> 341<a name="GstOggMux--skeleton"></a><h3>The <code class="literal">“skeleton”</code> property</h3> 342<pre class="programlisting"> “skeleton” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> 343<p>Whether to include a Skeleton track.</p> 344<p>Flags: Read / Write</p> 345<p>Default value: FALSE</p> 346</div> 347</div> 348<div class="refsect1"> 349<a name="gst-plugins-base-plugins-oggmux.see-also"></a><h2>See Also</h2> 350<a class="link" href="gst-plugins-base-plugins-oggdemux.html" title="oggdemux">oggdemux</a> 351</div> 352</div> 353<div class="footer"> 354<hr>Generated by GTK-Doc V1.28</div> 355</body> 356</html>
