tizen 2.3 release
[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.76.1">
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.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-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>"                <span class="type">guint64</span>               : 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>"           <span class="type">guint64</span>               : Read / Write
69   "<a class="link" href="gst-plugins-base-plugins-oggmux.html#GstOggMux--max-tolerance" title='The "max-tolerance" property'>max-tolerance</a>"            <span class="type">guint64</span>               : Read / Write
70   "<a class="link" href="gst-plugins-base-plugins-oggmux.html#GstOggMux--skeleton" title='The "skeleton" property'>skeleton</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
71 </pre>
72 </div>
73 <div class="refsect1">
74 <a name="gst-plugins-base-plugins-oggmux.description"></a><h2>Description</h2>
75 <div class="refsynopsisdiv">
76 <h2>Synopsis</h2>
77 <div class="refsect2">
78 <a name="idp11180832"></a><h3>Element Information</h3>
79 <div class="variablelist"><table border="0">
80 <col align="left" valign="top">
81 <tbody>
82 <tr>
83 <td><p><span class="term">plugin</span></p></td>
84 <td>
85             <a class="link" href="gst-plugins-base-plugins-plugin-ogg.html#plugin-ogg">ogg</a>
86           </td>
87 </tr>
88 <tr>
89 <td><p><span class="term">author</span></p></td>
90 <td>Wim Taymans &lt;wim@fluendo.com&gt;</td>
91 </tr>
92 <tr>
93 <td><p><span class="term">class</span></p></td>
94 <td>Codec/Muxer</td>
95 </tr>
96 </tbody>
97 </table></div>
98 </div>
99 <hr>
100 <div class="refsect2">
101 <a name="idp12591488"></a><h3>Element Pads</h3>
102 <div class="variablelist"><table border="0">
103 <col align="left" valign="top">
104 <tbody>
105 <tr>
106 <td><p><span class="term">name</span></p></td>
107 <td>sink_%d</td>
108 </tr>
109 <tr>
110 <td><p><span class="term">direction</span></p></td>
111 <td>sink</td>
112 </tr>
113 <tr>
114 <td><p><span class="term">presence</span></p></td>
115 <td>request</td>
116 </tr>
117 <tr>
118 <td><p><span class="term">details</span></p></td>
119 <td>video/x-theora</td>
120 </tr>
121 <tr>
122 <td><p><span class="term"></span></p></td>
123 <td> audio/x-vorbis</td>
124 </tr>
125 <tr>
126 <td><p><span class="term"></span></p></td>
127 <td> audio/x-flac</td>
128 </tr>
129 <tr>
130 <td><p><span class="term"></span></p></td>
131 <td> audio/x-speex</td>
132 </tr>
133 <tr>
134 <td><p><span class="term"></span></p></td>
135 <td> audio/x-celt</td>
136 </tr>
137 <tr>
138 <td><p><span class="term"></span></p></td>
139 <td> application/x-ogm-video</td>
140 </tr>
141 <tr>
142 <td><p><span class="term"></span></p></td>
143 <td> application/x-ogm-audio</td>
144 </tr>
145 <tr>
146 <td><p><span class="term"></span></p></td>
147 <td> video/x-dirac</td>
148 </tr>
149 <tr>
150 <td><p><span class="term"></span></p></td>
151 <td> video/x-smoke</td>
152 </tr>
153 <tr>
154 <td><p><span class="term"></span></p></td>
155 <td> video/x-vp8</td>
156 </tr>
157 <tr>
158 <td><p><span class="term"></span></p></td>
159 <td> text/x-cmml, encoded=(boolean)true</td>
160 </tr>
161 <tr>
162 <td><p><span class="term"></span></p></td>
163 <td> subtitle/x-kate</td>
164 </tr>
165 <tr>
166 <td><p><span class="term"></span></p></td>
167 <td> application/x-kate</td>
168 </tr>
169 <tr>
170 <td><p><span class="term"></span></p></td>
171 <td> audio/x-opus</td>
172 </tr>
173 </tbody>
174 </table></div>
175 <div class="variablelist"><table border="0">
176 <col align="left" valign="top">
177 <tbody>
178 <tr>
179 <td><p><span class="term">name</span></p></td>
180 <td>src</td>
181 </tr>
182 <tr>
183 <td><p><span class="term">direction</span></p></td>
184 <td>source</td>
185 </tr>
186 <tr>
187 <td><p><span class="term">presence</span></p></td>
188 <td>always</td>
189 </tr>
190 <tr>
191 <td><p><span class="term">details</span></p></td>
192 <td>application/ogg</td>
193 </tr>
194 </tbody>
195 </table></div>
196 </div>
197 </div>
198 <p>
199 </p>
200 </div>
201 <div class="refsect1">
202 <a name="gst-plugins-base-plugins-oggmux.details"></a><h2>Details</h2>
203 <div class="refsect2">
204 <a name="GstOggMux-struct"></a><h3>struct GstOggMux</h3>
205 <pre class="programlisting">struct GstOggMux;</pre>
206 <p>
207 </p>
208 </div>
209 </div>
210 <div class="refsect1">
211 <a name="gst-plugins-base-plugins-oggmux.property-details"></a><h2>Property Details</h2>
212 <div class="refsect2">
213 <a name="GstOggMux--max-delay"></a><h3>The <code class="literal">"max-delay"</code> property</h3>
214 <pre class="programlisting">  "max-delay"                <span class="type">guint64</span>               : Read / Write</pre>
215 <p>Maximum delay in multiplexing streams.</p>
216 <p>Default value: 500000000</p>
217 </div>
218 <hr>
219 <div class="refsect2">
220 <a name="GstOggMux--max-page-delay"></a><h3>The <code class="literal">"max-page-delay"</code> property</h3>
221 <pre class="programlisting">  "max-page-delay"           <span class="type">guint64</span>               : Read / Write</pre>
222 <p>Maximum delay for sending out a page.</p>
223 <p>Default value: 500000000</p>
224 </div>
225 <hr>
226 <div class="refsect2">
227 <a name="GstOggMux--max-tolerance"></a><h3>The <code class="literal">"max-tolerance"</code> property</h3>
228 <pre class="programlisting">  "max-tolerance"            <span class="type">guint64</span>               : Read / Write</pre>
229 <p>Maximum timestamp difference for maintaining perfect granules.</p>
230 <p>Default value: 40000000</p>
231 </div>
232 <hr>
233 <div class="refsect2">
234 <a name="GstOggMux--skeleton"></a><h3>The <code class="literal">"skeleton"</code> property</h3>
235 <pre class="programlisting">  "skeleton"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
236 <p>Whether to include a Skeleton track.</p>
237 <p>Default value: FALSE</p>
238 </div>
239 </div>
240 </div>
241 <div class="footer">
242 <hr>
243           Generated by GTK-Doc V1.18</div>
244 </body>
245 </html>