← Back to branch summary

~ubuntu-branches/ubuntu/quantal/gst-plugins-bad-multiverse0.10/quantal

« back to all changes in this revision

Viewing changes to docs/plugins/html/gst-plugins-bad-plugins-katedec.html

  • Committer: Bazaar Package Importer
  • Author(s): Onkar Shinde
  • Date: 2009-12-07 08:54:28 UTC
  • mfrom: (1.1.15 upstream)
  • Revision ID: james.westby@ubuntu.com-20091207085428-ml6aaukf0p2ph34d
Tags: 0.10.17-0ubuntu1
* New upstream release.
* Add myself to maintainer.
* Fix misc lintian warnings.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/plugins/html/gst-plugins-bad-plugins-katedec.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>katedec</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
 
7
<link rel="home" href="index.html" title="GStreamer Bad Plugins 0.10 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-kateparse.html" title="kateparse">
 
11
<meta name="generator" content="GTK-Doc V1.11 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
<link rel="chapter" href="ch01.html" title="gst-plugins-bad Elements">
 
14
<link rel="chapter" href="ch02.html" title="gst-plugins-bad Plugins">
 
15
<link rel="chapter" href="ch03.html" title="gst-plugins-bad Classes">
 
16
</head>
 
17
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
18
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
19
<tr valign="middle">
 
20
<td><a accesskey="p" href="gst-plugins-bad-plugins-kateenc.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
21
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
22
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
23
<th width="100%" align="center">GStreamer Bad Plugins 0.10 Plugins Reference Manual</th>
 
24
<td><a accesskey="n" href="gst-plugins-bad-plugins-kateparse.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
25
</tr>
 
26
<tr><td colspan="5" class="shortcuts">
 
27
<a href="#gst-plugins-bad-plugins-katedec.synopsis" class="shortcut">Top</a>
 
28
                 | 
 
29
                <a href="#gst-plugins-bad-plugins-katedec.description" class="shortcut">Description</a>
 
30
                 | 
 
31
                <a href="#gst-plugins-bad-plugins-katedec.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
32
                 | 
 
33
                <a href="#gst-plugins-bad-plugins-katedec.properties" class="shortcut">Properties</a>
 
34
</td></tr>
 
35
</table>
 
36
<div class="refentry" title="katedec">
 
37
<a name="gst-plugins-bad-plugins-katedec"></a><div class="titlepage"></div>
 
38
<div class="refnamediv"><table width="100%"><tr>
 
39
<td valign="top">
 
40
<h2><span class="refentrytitle"><a name="gst-plugins-bad-plugins-katedec.top_of_page"></a>katedec</span></h2>
 
41
<p>katedec — Decodes Kate text streams</p>
 
42
</td>
 
43
<td valign="top" align="right"></td>
 
44
</tr></table></div>
 
45
<div class="refsynopsisdiv" title="Synopsis">
 
46
<a name="gst-plugins-bad-plugins-katedec.synopsis"></a><h2>Synopsis</h2>
 
47
<a name="GstKateDec"></a><pre class="synopsis">
 
48
                    <a class="link" href="gst-plugins-bad-plugins-katedec.html#GstKateDec-struct" title="GstKateDec">GstKateDec</a>;
 
49
</pre>
 
50
</div>
 
51
<div class="refsect1" title="Object Hierarchy">
 
52
<a name="gst-plugins-bad-plugins-katedec.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
53
<pre class="synopsis">
 
54
  <a
 
55
href="../gobject/gobject-The-Base-Object-Type.html#GObject"
 
56
>GObject</a>
 
57
   +----<a
 
58
href="../gstreamer-0.10/GstObject.html"
 
59
>GstObject</a>
 
60
         +----<a
 
61
href="../gstreamer-0.10/GstElement.html"
 
62
>GstElement</a>
 
63
               +----GstKateDec
 
64
</pre>
 
65
</div>
 
66
<div class="refsect1" title="Properties">
 
67
<a name="gst-plugins-bad-plugins-katedec.properties"></a><h2>Properties</h2>
 
68
<pre class="synopsis">
 
69
  "<a class="link" href="gst-plugins-bad-plugins-katedec.html#GstKateDec--category" title='The "category" property'>category</a>"                 <a
 
70
href="../glib/glib-Basic-Types.html#gchar"
 
71
>gchar</a>*                : Read
 
72
  "<a class="link" href="gst-plugins-bad-plugins-katedec.html#GstKateDec--language" title='The "language" property'>language</a>"                 <a
 
73
href="../glib/glib-Basic-Types.html#gchar"
 
74
>gchar</a>*                : Read
 
75
  "<a class="link" href="gst-plugins-bad-plugins-katedec.html#GstKateDec--original-canvas-height" title='The "original-canvas-height" property'>original-canvas-height</a>"   <a
 
76
href="../glib/glib-Basic-Types.html#gint"
 
77
>gint</a>                  : Read
 
78
  "<a class="link" href="gst-plugins-bad-plugins-katedec.html#GstKateDec--original-canvas-width" title='The "original-canvas-width" property'>original-canvas-width</a>"    <a
 
79
href="../glib/glib-Basic-Types.html#gint"
 
80
>gint</a>                  : Read
 
81
  "<a class="link" href="gst-plugins-bad-plugins-katedec.html#GstKateDec--remove-markup" title='The "remove-markup" property'>remove-markup</a>"            <a
 
82
href="../glib/glib-Basic-Types.html#gboolean"
 
83
>gboolean</a>              : Read / Write
 
84
</pre>
 
85
</div>
 
86
<div class="refsect1" title="Description">
 
87
<a name="gst-plugins-bad-plugins-katedec.description"></a><h2>Description</h2>
 
88
<p>
 
89
</p>
 
90
<div class="refsect2" title="Example pipeline">
 
91
<a name="id2854432"></a><h3>Example pipeline</h3>
 
92
<p>
 
93
This element decodes Kate streams
 
94
<a class="ulink" href="http://libkate.googlecode.com/" target="_top">Kate</a> is a free codec
 
95
for text based data, such as subtitles. Any number of kate streams can be
 
96
embedded in an Ogg stream.
 
97
</p>
 
98
<p>
 
99
libkate (see above url) is needed to build this plugin.
 
100
</p>
 
101
<p>
 
102
This explicitely decodes a Kate stream:
 
103
</p>
 
104
<pre class="programlisting">
 
105
gst-launch filesrc location=test.ogg ! oggdemux ! katedec ! fakesink silent=TRUE
 
106
</pre>
 
107
<p>
 
108
</p>
 
109
<p>
 
110
This will automatically detect and use any Kate streams multiplexed
 
111
in an Ogg stream:
 
112
</p>
 
113
<pre class="programlisting">
 
114
gst-launch playbin uri=file:///tmp/test.ogg
 
115
</pre>
 
116
<p>
 
117
</p>
 
118
</div>
 
119
<div class="refsynopsisdiv" title="Synopsis">
 
120
<h2>Synopsis</h2>
 
121
<div class="refsect2" title="Element Information">
 
122
<a name="id2785219"></a><h3>Element Information</h3>
 
123
<div class="variablelist"><table border="0">
 
124
<col align="left" valign="top">
 
125
<tbody>
 
126
<tr>
 
127
<td><p><span class="term">plugin</span></p></td>
 
128
<td>
 
129
            <a class="link" href="gst-plugins-bad-plugins-plugin-kate.html#plugin-kate">kate</a>
 
130
          </td>
 
131
</tr>
 
132
<tr>
 
133
<td><p><span class="term">author</span></p></td>
 
134
<td>Vincent Penquerc'h &lt;ogg.k.ogg.k@googlemail.com&gt;</td>
 
135
</tr>
 
136
<tr>
 
137
<td><p><span class="term">class</span></p></td>
 
138
<td>Codec/Decoder/Subtitle</td>
 
139
</tr>
 
140
</tbody>
 
141
</table></div>
 
142
</div>
 
143
<hr>
 
144
<div class="refsect2" title="Element Pads">
 
145
<a name="id2871537"></a><h3>Element Pads</h3>
 
146
<div class="variablelist"><table border="0">
 
147
<col align="left" valign="top">
 
148
<tbody>
 
149
<tr>
 
150
<td><p><span class="term">name</span></p></td>
 
151
<td>sink</td>
 
152
</tr>
 
153
<tr>
 
154
<td><p><span class="term">direction</span></p></td>
 
155
<td>sink</td>
 
156
</tr>
 
157
<tr>
 
158
<td><p><span class="term">presence</span></p></td>
 
159
<td>always</td>
 
160
</tr>
 
161
<tr>
 
162
<td><p><span class="term">details</span></p></td>
 
163
<td>subtitle/x-kate</td>
 
164
</tr>
 
165
</tbody>
 
166
</table></div>
 
167
<div class="variablelist"><table border="0">
 
168
<col align="left" valign="top">
 
169
<tbody>
 
170
<tr>
 
171
<td><p><span class="term">name</span></p></td>
 
172
<td>src</td>
 
173
</tr>
 
174
<tr>
 
175
<td><p><span class="term">direction</span></p></td>
 
176
<td>source</td>
 
177
</tr>
 
178
<tr>
 
179
<td><p><span class="term">presence</span></p></td>
 
180
<td>always</td>
 
181
</tr>
 
182
<tr>
 
183
<td><p><span class="term">details</span></p></td>
 
184
<td>text/plain</td>
 
185
</tr>
 
186
<tr>
 
187
<td><p><span class="term"></span></p></td>
 
188
<td> text/x-pango-markup</td>
 
189
</tr>
 
190
<tr>
 
191
<td><p><span class="term"></span></p></td>
 
192
<td> video/x-dvd-subpicture</td>
 
193
</tr>
 
194
</tbody>
 
195
</table></div>
 
196
</div>
 
197
</div>
 
198
<p>
 
199
</p>
 
200
</div>
 
201
<div class="refsect1" title="Details">
 
202
<a name="gst-plugins-bad-plugins-katedec.details"></a><h2>Details</h2>
 
203
<div class="refsect2" title="GstKateDec">
 
204
<a name="GstKateDec-struct"></a><h3>GstKateDec</h3>
 
205
<pre class="programlisting">typedef struct _GstKateDec GstKateDec;</pre>
 
206
<p>
 
207
</p>
 
208
</div>
 
209
</div>
 
210
<div class="refsect1" title="Property Details">
 
211
<a name="gst-plugins-bad-plugins-katedec.property-details"></a><h2>Property Details</h2>
 
212
<div class="refsect2" title='The "category" property'>
 
213
<a name="GstKateDec--category"></a><h3>The <code class="literal">"category"</code> property</h3>
 
214
<pre class="programlisting">  "category"                 <a
 
215
href="../glib/glib-Basic-Types.html#gchar"
 
216
>gchar</a>*                : Read</pre>
 
217
<p>The category of the stream.</p>
 
218
<p>Default value: ""</p>
 
219
</div>
 
220
<hr>
 
221
<div class="refsect2" title='The "language" property'>
 
222
<a name="GstKateDec--language"></a><h3>The <code class="literal">"language"</code> property</h3>
 
223
<pre class="programlisting">  "language"                 <a
 
224
href="../glib/glib-Basic-Types.html#gchar"
 
225
>gchar</a>*                : Read</pre>
 
226
<p>The language of the stream.</p>
 
227
<p>Default value: ""</p>
 
228
</div>
 
229
<hr>
 
230
<div class="refsect2" title='The "original-canvas-height" property'>
 
231
<a name="GstKateDec--original-canvas-height"></a><h3>The <code class="literal">"original-canvas-height"</code> property</h3>
 
232
<pre class="programlisting">  "original-canvas-height"   <a
 
233
href="../glib/glib-Basic-Types.html#gint"
 
234
>gint</a>                  : Read</pre>
 
235
<p>The canvas height this stream was authored for (0 is unspecified).</p>
 
236
<p>Allowed values: &gt;= 0</p>
 
237
<p>Default value: 0</p>
 
238
</div>
 
239
<hr>
 
240
<div class="refsect2" title='The "original-canvas-width" property'>
 
241
<a name="GstKateDec--original-canvas-width"></a><h3>The <code class="literal">"original-canvas-width"</code> property</h3>
 
242
<pre class="programlisting">  "original-canvas-width"    <a
 
243
href="../glib/glib-Basic-Types.html#gint"
 
244
>gint</a>                  : Read</pre>
 
245
<p>The canvas width this stream was authored for.</p>
 
246
<p>Allowed values: &gt;= 0</p>
 
247
<p>Default value: 0</p>
 
248
</div>
 
249
<hr>
 
250
<div class="refsect2" title='The "remove-markup" property'>
 
251
<a name="GstKateDec--remove-markup"></a><h3>The <code class="literal">"remove-markup"</code> property</h3>
 
252
<pre class="programlisting">  "remove-markup"            <a
 
253
href="../glib/glib-Basic-Types.html#gboolean"
 
254
>gboolean</a>              : Read / Write</pre>
 
255
<p>Remove markup from decoded text ?.</p>
 
256
<p>Default value: FALSE</p>
 
257
</div>
 
258
</div>
 
259
<div class="refsect1" title="See Also">
 
260
<a name="gst-plugins-bad-plugins-katedec.see-also"></a><h2>See Also</h2>
 
261
oggdemux
 
262
</div>
 
263
</div>
 
264
<div class="footer">
 
265
<hr>
 
266
          Generated by GTK-Doc V1.11</div>
 
267
</body>
 
268
</html>