8fcad3e2a5b09be99229d9f36f995af83a61209c
[framework/multimedia/gst-plugins-base0.10.git] / docs / plugins / html / gst-plugins-base-plugins-oggmux.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>oggmux</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7 <link rel="home" href="index.html" title="GStreamer Base Plugins 0.10 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-playbin.html" title="playbin">
11 <meta name="generator" content="GTK-Doc V1.17 (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-base-plugins-oggdemux.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 Base Plugins 0.10 Plugins Reference Manual</th>
21 <td><a accesskey="n" href="gst-plugins-base-plugins-playbin.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-base-plugins-oggmux.synopsis" class="shortcut">Top</a>
25                    | 
26                   <a href="#gst-plugins-base-plugins-oggmux.description" class="shortcut">Description</a>
27                    | 
28                   <a href="#gst-plugins-base-plugins-oggmux.object-hierarchy" class="shortcut">Object Hierarchy</a>
29                    | 
30                   <a href="#gst-plugins-base-plugins-oggmux.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
31                    | 
32                   <a href="#gst-plugins-base-plugins-oggmux.properties" class="shortcut">Properties</a>
33 </td></tr>
34 </table>
35 <div class="refentry">
36 <a name="gst-plugins-base-plugins-oggmux"></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-base-plugins-oggmux.top_of_page"></a>oggmux</span></h2>
40 <p>oggmux — mux ogg streams (info about ogg: http://xiph.org)</p>
41 </td>
42 <td valign="top" align="right"></td>
43 </tr></table></div>
44 <div class="refsynopsisdiv">
45 <a name="gst-plugins-base-plugins-oggmux.synopsis"></a><h2>Synopsis</h2>
46 <a name="GstOggMux"></a><pre class="synopsis">struct              <a class="link" href="gst-plugins-base-plugins-oggmux.html#GstOggMux-struct" title="struct GstOggMux">GstOggMux</a>;
47 </pre>
48 </div>
49 <div class="refsect1">
50 <a name="gst-plugins-base-plugins-oggmux.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                +----GstOggMux
56 </pre>
57 </div>
58 <div class="refsect1">
59 <a name="gst-plugins-base-plugins-oggmux.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
60 <p>
61 GstOggMux implements
62  <a href="http://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer/html/GstPreset.html">GstPreset</a>.</p>
63 </div>
64 <div class="refsect1">
65 <a name="gst-plugins-base-plugins-oggmux.properties"></a><h2>Properties</h2>
66 <pre class="synopsis">
67   "<a class="link" href="gst-plugins-base-plugins-oggmux.html#GstOggMux--max-delay" title='The "max-delay" property'>max-delay</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>               : Read / Write
68   "<a class="link" href="gst-plugins-base-plugins-oggmux.html#GstOggMux--max-page-delay" title='The "max-page-delay" property'>max-page-delay</a>"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>               : Read / Write
69 </pre>
70 </div>
71 <div class="refsect1">
72 <a name="gst-plugins-base-plugins-oggmux.description"></a><h2>Description</h2>
73 <p>
74 This element merges streams (audio and video) into ogg files.
75 </p>
76 <p>
77 </p>
78 <div class="refsect2">
79 <a name="idp11580192"></a><h3>Example pipelines</h3>
80 <div class="informalexample">
81   <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
82     <tbody>
83       <tr>
84         <td class="listing_lines" align="right"><pre>1</pre></td>
85         <td class="listing_code"><pre class="programlisting">gst<span class="gtkdoc opt">-</span>launch 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>yuv<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> ffmpegcolorspace <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>
86       </tr>
87     </tbody>
88   </table>
89 </div>
90  Encodes a video stream captured from a v4l2-compatible camera to Ogg/Theora
91 (the encoding will stop automatically after 500 frames)
92 </div>
93 <p>
94 </p>
95 <p>
96 Last reviewed on 2008-02-06 (0.10.17)
97 </p>
98 <div class="refsynopsisdiv">
99 <h2>Synopsis</h2>
100 <div class="refsect2">
101 <a name="idp11578016"></a><h3>Element Information</h3>
102 <div class="variablelist"><table border="0">
103 <col align="left" valign="top">
104 <tbody>
105 <tr>
106 <td><p><span class="term">plugin</span></p></td>
107 <td>
108             <a class="link" href="gst-plugins-base-plugins-plugin-ogg.html#plugin-ogg">ogg</a>
109           </td>
110 </tr>
111 <tr>
112 <td><p><span class="term">author</span></p></td>
113 <td>Wim Taymans &lt;wim@fluendo.com&gt;</td>
114 </tr>
115 <tr>
116 <td><p><span class="term">class</span></p></td>
117 <td>Codec/Muxer</td>
118 </tr>
119 </tbody>
120 </table></div>
121 </div>
122 <hr>
123 <div class="refsect2">
124 <a name="idp5957200"></a><h3>Element Pads</h3>
125 <div class="variablelist"><table border="0">
126 <col align="left" valign="top">
127 <tbody>
128 <tr>
129 <td><p><span class="term">name</span></p></td>
130 <td>sink_%d</td>
131 </tr>
132 <tr>
133 <td><p><span class="term">direction</span></p></td>
134 <td>sink</td>
135 </tr>
136 <tr>
137 <td><p><span class="term">presence</span></p></td>
138 <td>request</td>
139 </tr>
140 <tr>
141 <td><p><span class="term">details</span></p></td>
142 <td>video/x-theora</td>
143 </tr>
144 <tr>
145 <td><p><span class="term"></span></p></td>
146 <td> audio/x-vorbis</td>
147 </tr>
148 <tr>
149 <td><p><span class="term"></span></p></td>
150 <td> audio/x-flac</td>
151 </tr>
152 <tr>
153 <td><p><span class="term"></span></p></td>
154 <td> audio/x-speex</td>
155 </tr>
156 <tr>
157 <td><p><span class="term"></span></p></td>
158 <td> audio/x-celt</td>
159 </tr>
160 <tr>
161 <td><p><span class="term"></span></p></td>
162 <td> application/x-ogm-video</td>
163 </tr>
164 <tr>
165 <td><p><span class="term"></span></p></td>
166 <td> application/x-ogm-audio</td>
167 </tr>
168 <tr>
169 <td><p><span class="term"></span></p></td>
170 <td> video/x-dirac</td>
171 </tr>
172 <tr>
173 <td><p><span class="term"></span></p></td>
174 <td> video/x-smoke</td>
175 </tr>
176 <tr>
177 <td><p><span class="term"></span></p></td>
178 <td> video/x-vp8</td>
179 </tr>
180 <tr>
181 <td><p><span class="term"></span></p></td>
182 <td> text/x-cmml, encoded=(boolean)true</td>
183 </tr>
184 <tr>
185 <td><p><span class="term"></span></p></td>
186 <td> subtitle/x-kate</td>
187 </tr>
188 <tr>
189 <td><p><span class="term"></span></p></td>
190 <td> application/x-kate</td>
191 </tr>
192 </tbody>
193 </table></div>
194 <div class="variablelist"><table border="0">
195 <col align="left" valign="top">
196 <tbody>
197 <tr>
198 <td><p><span class="term">name</span></p></td>
199 <td>src</td>
200 </tr>
201 <tr>
202 <td><p><span class="term">direction</span></p></td>
203 <td>source</td>
204 </tr>
205 <tr>
206 <td><p><span class="term">presence</span></p></td>
207 <td>always</td>
208 </tr>
209 <tr>
210 <td><p><span class="term">details</span></p></td>
211 <td>application/ogg</td>
212 </tr>
213 </tbody>
214 </table></div>
215 </div>
216 </div>
217 <p>
218 </p>
219 </div>
220 <div class="refsect1">
221 <a name="gst-plugins-base-plugins-oggmux.details"></a><h2>Details</h2>
222 <div class="refsect2">
223 <a name="GstOggMux-struct"></a><h3>struct GstOggMux</h3>
224 <pre class="programlisting">struct GstOggMux;</pre>
225 <p>
226 The ogg muxer object structure.
227 </p>
228 </div>
229 </div>
230 <div class="refsect1">
231 <a name="gst-plugins-base-plugins-oggmux.property-details"></a><h2>Property Details</h2>
232 <div class="refsect2">
233 <a name="GstOggMux--max-delay"></a><h3>The <code class="literal">"max-delay"</code> property</h3>
234 <pre class="programlisting">  "max-delay"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>               : Read / Write</pre>
235 <p>Maximum delay in multiplexing streams.</p>
236 <p>Default value: 500000000</p>
237 </div>
238 <hr>
239 <div class="refsect2">
240 <a name="GstOggMux--max-page-delay"></a><h3>The <code class="literal">"max-page-delay"</code> property</h3>
241 <pre class="programlisting">  "max-page-delay"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint64"><span class="type">guint64</span></a>               : Read / Write</pre>
242 <p>Maximum delay for sending out a page.</p>
243 <p>Default value: 500000000</p>
244 </div>
245 </div>
246 <div class="refsect1">
247 <a name="gst-plugins-base-plugins-oggmux.see-also"></a><h2>See Also</h2>
248 <a class="link" href="gst-plugins-base-plugins-oggdemux.html" title="oggdemux">oggdemux</a>
249 </div>
250 </div>
251 <div class="footer">
252 <hr>
253           Generated by GTK-Doc V1.17</div>
254 </body>
255 </html>