• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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>kateparse: GStreamer Bad 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 Bad Plugins 1.0 Plugins Reference Manual">
8<link rel="up" href="ch01.html" title="gst-plugins-bad Elements">
9<link rel="prev" href="gst-plugins-bad-plugins-kateenc.html" title="kateenc">
10<link rel="next" href="gst-plugins-bad-plugins-katetag.html" title="katetag">
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">|</span18                  <a href="#gst-plugins-bad-plugins-kateparse.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span19                  <a href="#gst-plugins-bad-plugins-kateparse.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
20</td>
21<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
22<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
23<td><a accesskey="p" href="gst-plugins-bad-plugins-kateenc.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
24<td><a accesskey="n" href="gst-plugins-bad-plugins-katetag.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
25</tr></table>
26<div class="refentry">
27<a name="gst-plugins-bad-plugins-kateparse"></a><div class="titlepage"></div>
28<div class="refnamediv"><table width="100%"><tr>
29<td valign="top">
30<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-kateparse.top_of_page"></a>kateparse</span></h2>
31<p>kateparse — parses kate streams</p>
32</td>
33<td class="gallery_image" valign="top" align="right"></td>
34</tr></table></div>
35<a name="GstKateParse"></a><div class="refsect1">
36<a name="gst-plugins-bad-plugins-kateparse.other"></a><h2>Types and Values</h2>
37<div class="informaltable"><table class="informaltable" width="100%" border="0">
38<colgroup>
39<col width="150px" class="name">
40<col class="description">
41</colgroup>
42<tbody><tr>
43<td class="datatype_keyword">struct</td>
44<td class="function_name"><a class="link" href="gst-plugins-bad-plugins-kateparse.html#GstKateParse-struct" title="struct GstKateParse">GstKateParse</a></td>
45</tr></tbody>
46</table></div>
47</div>
48<div class="refsect1">
49<a name="gst-plugins-bad-plugins-kateparse.object-hierarchy"></a><h2>Object Hierarchy</h2>
50<pre class="screen">    <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
51    <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
52        <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstObject.html#GstObject-struct">GstObject</a>
53            <span class="lineart">╰──</span> <a href="/usr/share/gtk-doc/html/gstreamer-1.0/GstElement.html#GstElement-struct">GstElement</a>
54                <span class="lineart">╰──</span> GstKateParse
55                    <span class="lineart">╰──</span> <a class="link" href="gst-plugins-bad-plugins-katetag.html#GstKateTag">GstKateTag</a>
56</pre>
57</div>
58<div class="refsect1">
59<a name="gst-plugins-bad-plugins-kateparse.description"></a><h2>Description</h2>
60<p>The kateparse element will parse the header packets of the Kate
61stream and put them as the streamheader in the caps. This is used in the
62multifdsink case where you want to stream live kate streams to multiple
63clients, each client has to receive the streamheaders first before they can
64consume the kate packets.</p>
65<p>This element also makes sure that the buffers that it pushes out are properly
66timestamped and that their offset and offset_end are set. The buffers that
67kateparse outputs have all of the metadata that oggmux expects to receive,
68which allows you to (for example) remux an ogg/kate file.</p>
69<div class="refsect3">
70<a name="id-1.2.131.6.4"></a><h4>Example pipelines</h4>
71<div class="informalexample">
72  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
73    <tbody>
74      <tr>
75        <td class="listing_lines" align="right"><pre>1</pre></td>
76        <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> <span class="gtkdoc opt">-</span>v filesrc location<span class="gtkdoc opt">=</span>kate<span class="gtkdoc opt">.</span>ogg <span class="gtkdoc opt">!</span> oggdemux <span class="gtkdoc opt">!</span> kateparse <span class="gtkdoc opt">!</span> fakesink</pre></td>
77      </tr>
78    </tbody>
79  </table>
80</div>
81
82<p>
83This pipeline shows that the streamheader is set in the caps, and that each
84buffer has the timestamp, duration, offset, and offset_end set.</p>
85<div class="informalexample">
86  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
87    <tbody>
88      <tr>
89        <td class="listing_lines" align="right"><pre>1
902</pre></td>
91        <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> filesrc location<span class="gtkdoc opt">=</span>kate<span class="gtkdoc opt">.</span>ogg <span class="gtkdoc opt">!</span> oggdemux <span class="gtkdoc opt">!</span> kateparse \
92           <span class="gtkdoc opt">!</span> oggmux <span class="gtkdoc opt">!</span> filesink location<span class="gtkdoc opt">=</span>kate<span class="gtkdoc opt">-</span>remuxed<span class="gtkdoc opt">.</span>ogg</pre></td>
93      </tr>
94    </tbody>
95  </table>
96</div>
97
98<p>
99This pipeline shows remuxing. kate-remuxed.ogg might not be exactly the same
100as kate.ogg, but they should produce exactly the same decoded data.</p>
101</div>
102<div class="refsynopsisdiv">
103<h2>Synopsis</h2>
104<div class="refsect2">
105<a name="id-1.2.131.6.5.1"></a><h3>Element Information</h3>
106<div class="variablelist"><table border="0" class="variablelist">
107<colgroup>
108<col align="left" valign="top">
109<col>
110</colgroup>
111<tbody>
112<tr>
113<td><p><span class="term">plugin</span></p></td>
114<td>
115            <a class="link" href="gst-plugins-bad-plugins-plugin-kate.html#plugin-kate">kate</a>
116          </td>
117</tr>
118<tr>
119<td><p><span class="term">author</span></p></td>
120<td>Vincent Penquerc'h &lt;ogg.k.ogg.k at googlemail dot com&gt;</td>
121</tr>
122<tr>
123<td><p><span class="term">class</span></p></td>
124<td>Codec/Parser/Subtitle</td>
125</tr>
126</tbody>
127</table></div>
128</div>
129<hr>
130<div class="refsect2">
131<a name="id-1.2.131.6.5.2"></a><h3>Element Pads</h3>
132<div class="variablelist"><table border="0" class="variablelist">
133<colgroup>
134<col align="left" valign="top">
135<col>
136</colgroup>
137<tbody>
138<tr>
139<td><p><span class="term">name</span></p></td>
140<td>sink</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>always</td>
149</tr>
150<tr>
151<td><p><span class="term">details</span></p></td>
152<td>subtitle/x-kate</td>
153</tr>
154<tr>
155<td><p><span class="term"></span></p></td>
156<td> application/x-kate</td>
157</tr>
158</tbody>
159</table></div>
160<div class="variablelist"><table border="0" class="variablelist">
161<colgroup>
162<col align="left" valign="top">
163<col>
164</colgroup>
165<tbody>
166<tr>
167<td><p><span class="term">name</span></p></td>
168<td>src</td>
169</tr>
170<tr>
171<td><p><span class="term">direction</span></p></td>
172<td>source</td>
173</tr>
174<tr>
175<td><p><span class="term">presence</span></p></td>
176<td>always</td>
177</tr>
178<tr>
179<td><p><span class="term">details</span></p></td>
180<td>subtitle/x-kate</td>
181</tr>
182<tr>
183<td><p><span class="term"></span></p></td>
184<td> application/x-kate</td>
185</tr>
186</tbody>
187</table></div>
188</div>
189</div>
190</div>
191<div class="refsect1">
192<a name="gst-plugins-bad-plugins-kateparse.functions_details"></a><h2>Functions</h2>
193<p></p>
194</div>
195<div class="refsect1">
196<a name="gst-plugins-bad-plugins-kateparse.other_details"></a><h2>Types and Values</h2>
197<div class="refsect2">
198<a name="GstKateParse-struct"></a><h3>struct GstKateParse</h3>
199<pre class="programlisting">struct GstKateParse;</pre>
200<p>Opaque data structure.</p>
201</div>
202</div>
203<div class="refsect1">
204<a name="gst-plugins-bad-plugins-kateparse.see-also"></a><h2>See Also</h2>
205<p>katedec, vorbisparse, oggdemux, theoraparse</p>
206</div>
207</div>
208<div class="footer">
209<hr>Generated by GTK-Doc V1.28</div>
210</body>
211</html>