1
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>SwfdecLoader</title>
6
6
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2">
7
7
<link rel="start" href="index.html" title="Swfdec Reference Manual">
8
8
<link rel="up" href="ch03.html" title="extending SwfdecPlayer">
9
9
<link rel="prev" href="SwfdecStream.html" title="SwfdecStream">
10
10
<link rel="next" href="SwfdecSocket.html" title="SwfdecSocket">
11
<meta name="generator" content="GTK-Doc V1.9 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.10 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
13
13
<link rel="chapter" href="ch01.html" title="Swfdec Gtk library">
14
14
<link rel="chapter" href="ch02.html" title="Swfdec library">
24
24
<th width="100%" align="center">Swfdec Reference Manual</th>
25
25
<td><a accesskey="n" href="SwfdecSocket.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
27
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id2615892" class="shortcut">Top</a>
29
<a href="#id2633389" class="shortcut">Description</a>
31
<a href="#id2630343" class="shortcut">Object Hierarchy</a>
33
<a href="#id2630412" class="shortcut">Properties</a></nobr></td></tr>
27
<tr><td colspan="5" class="shortcuts"><nobr><a href="#SwfdecLoader.synopsis" class="shortcut">Top</a>
29
<a href="#SwfdecLoader.description" class="shortcut">Description</a>
31
<a href="#SwfdecLoader.object-hierarchy" class="shortcut">Object Hierarchy</a>
33
<a href="#SwfdecLoader.properties" class="shortcut">Properties</a></nobr></td></tr>
35
35
<div class="refentry" lang="en">
36
36
<a name="SwfdecLoader"></a><div class="titlepage"></div>
37
37
<div class="refnamediv"><table width="100%"><tr>
40
<a name="id2615892"></a><span class="refentrytitle">SwfdecLoader</span>
42
<p>SwfdecLoader — object used for input</p>
39
<h2><span class="refentrytitle"><a name="SwfdecLoader.top_of_page"></a>SwfdecLoader</span></h2>
40
<p>SwfdecLoader — object used for input</p>
44
42
<td valign="top" align="right"></td>
45
43
</tr></table></div>
46
44
<div class="refsynopsisdiv">
45
<a name="SwfdecLoader.synopsis"></a><h2>Synopsis</h2>
48
46
<a name="SwfdecFileLoader"></a><pre class="synopsis">
50
48
#include <swfdec/swfdec.h>
53
<a class="link" href="SwfdecLoader.html#SwfdecLoader-struct">SwfdecLoader</a>;
54
<a class="link" href="SwfdecLoader.html#SwfdecFileLoader-struct">SwfdecFileLoader</a>;
55
<a class="link" href="SwfdecLoader.html#SwfdecLoaderClass">SwfdecLoaderClass</a>;
56
void <a class="link" href="SwfdecLoader.html#swfdec-loader-set-url">swfdec_loader_set_url</a> (<a class="link" href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader,
50
<a class="link" href="SwfdecLoader.html#SwfdecLoader-struct" title="SwfdecLoader">SwfdecLoader</a>;
51
<a class="link" href="SwfdecLoader.html#SwfdecFileLoader-struct" title="SwfdecFileLoader">SwfdecFileLoader</a>;
52
<a class="link" href="SwfdecLoader.html#SwfdecLoaderClass" title="SwfdecLoaderClass">SwfdecLoaderClass</a>;
53
void <a class="link" href="SwfdecLoader.html#swfdec-loader-set-url" title="swfdec_loader_set_url ()">swfdec_loader_set_url</a> (<a class="link" href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader,
58
const <a class="link" href="swfdec-SwfdecURL.html#SwfdecURL">SwfdecURL</a>* <a class="link" href="SwfdecLoader.html#swfdec-loader-get-url">swfdec_loader_get_url</a> (<a class="link" href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader);
59
void <a class="link" href="SwfdecLoader.html#swfdec-loader-set-size">swfdec_loader_set_size</a> (<a class="link" href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader,
55
const <a class="link" href="swfdec-SwfdecURL.html#SwfdecURL" title="SwfdecURL">SwfdecURL</a>* <a class="link" href="SwfdecLoader.html#swfdec-loader-get-url" title="swfdec_loader_get_url ()">swfdec_loader_get_url</a> (<a class="link" href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader);
56
void <a class="link" href="SwfdecLoader.html#swfdec-loader-set-size" title="swfdec_loader_set_size ()">swfdec_loader_set_size</a> (<a class="link" href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader,
61
58
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gulong"
64
61
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#glong"
65
>glong</a> <a class="link" href="SwfdecLoader.html#swfdec-loader-get-size">swfdec_loader_get_size</a> (<a class="link" href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader);
62
>glong</a> <a class="link" href="SwfdecLoader.html#swfdec-loader-get-size" title="swfdec_loader_get_size ()">swfdec_loader_get_size</a> (<a class="link" href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader);
67
64
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gulong"
68
>gulong</a> <a class="link" href="SwfdecLoader.html#swfdec-loader-get-loaded">swfdec_loader_get_loaded</a> (<a class="link" href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader);
69
<a class="link" href="swfdec-Enumerations-and-Types.html#SwfdecLoaderDataType">SwfdecLoaderDataType</a> <a class="link" href="SwfdecLoader.html#swfdec-loader-get-data-type">swfdec_loader_get_data_type</a> (<a class="link" href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader);
65
>gulong</a> <a class="link" href="SwfdecLoader.html#swfdec-loader-get-loaded" title="swfdec_loader_get_loaded ()">swfdec_loader_get_loaded</a> (<a class="link" href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader);
66
<a class="link" href="swfdec-Enumerations-and-Types.html#SwfdecLoaderDataType" title="enum SwfdecLoaderDataType">SwfdecLoaderDataType</a> <a class="link" href="SwfdecLoader.html#swfdec-loader-get-data-type" title="swfdec_loader_get_data_type ()">swfdec_loader_get_data_type</a> (<a class="link" href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader);
73
69
<div class="refsect1" lang="en">
74
<a name="id2630343"></a><h2>Object Hierarchy</h2>
70
<a name="SwfdecLoader.object-hierarchy"></a><h2>Object Hierarchy</h2>
75
71
<pre class="synopsis">
78
73
href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject"
95
89
<div class="refsect1" lang="en">
96
<a name="id2630412"></a><h2>Properties</h2>
90
<a name="SwfdecLoader.properties"></a><h2>Properties</h2>
97
91
<pre class="synopsis">
99
"<a class="link" href="SwfdecLoader.html#SwfdecLoader--data-type">data-type</a>" <a class="link" href="swfdec-Enumerations-and-Types.html#SwfdecLoaderDataType">SwfdecLoaderDataType</a> : Read
100
"<a class="link" href="SwfdecLoader.html#SwfdecLoader--loaded">loaded</a>" <a
92
"<a class="link" href="SwfdecLoader.html#SwfdecLoader--data-type" title='The "data-type" property'>data-type</a>" <a class="link" href="swfdec-Enumerations-and-Types.html#SwfdecLoaderDataType" title="enum SwfdecLoaderDataType">SwfdecLoaderDataType</a> : Read
93
"<a class="link" href="SwfdecLoader.html#SwfdecLoader--loaded" title='The "loaded" property'>loaded</a>" <a
101
94
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gulong"
102
95
>gulong</a> : Read / Write
103
"<a class="link" href="SwfdecLoader.html#SwfdecLoader--size">size</a>" <a
96
"<a class="link" href="SwfdecLoader.html#SwfdecLoader--size" title='The "size" property'>size</a>" <a
104
97
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#glong"
105
98
>glong</a> : Read / Write
106
"<a class="link" href="SwfdecLoader.html#SwfdecLoader--url">url</a>" <a class="link" href="swfdec-SwfdecURL.html#SwfdecURL">SwfdecURL</a> : Read
99
"<a class="link" href="SwfdecLoader.html#SwfdecLoader--url" title='The "url" property'>url</a>" <a class="link" href="swfdec-SwfdecURL.html#SwfdecURL" title="SwfdecURL">SwfdecURL</a>* : Read
109
102
<div class="refsect1" lang="en">
110
<a name="id2633389"></a><h2>Description</h2>
103
<a name="SwfdecLoader.description"></a><h2>Description</h2>
112
105
SwfdecLoader is the base class used for reading input. Since developers
113
106
normally need to adapt input to the needs of their application, this class
127
120
<div class="refsect1" lang="en">
128
<a name="id2633435"></a><h2>Details</h2>
121
<a name="SwfdecLoader.details"></a><h2>Details</h2>
129
122
<div class="refsect2" lang="en">
130
<a name="id2633446"></a><h3>
131
<a name="SwfdecLoader-struct"></a>SwfdecLoader</h3>
132
<a class="indexterm" name="id2633458"></a><pre class="programlisting">typedef struct _SwfdecLoader SwfdecLoader;</pre>
123
<a name="SwfdecLoader-struct"></a><h3>SwfdecLoader</h3>
124
<pre class="programlisting">typedef struct _SwfdecLoader SwfdecLoader;</pre>
134
126
This is the base object used for providing input. It is abstract, use a
135
127
subclass to provide your input.</p>
141
133
<div class="refsect2" lang="en">
142
<a name="id2633479"></a><h3>
143
<a name="SwfdecFileLoader-struct"></a>SwfdecFileLoader</h3>
144
<a class="indexterm" name="id2633491"></a><pre class="programlisting">typedef struct _SwfdecFileLoader SwfdecFileLoader;</pre>
134
<a name="SwfdecFileLoader-struct"></a><h3>SwfdecFileLoader</h3>
135
<pre class="programlisting">typedef struct _SwfdecFileLoader SwfdecFileLoader;</pre>
146
137
This is a <a class="link" href="SwfdecLoader.html" title="SwfdecLoader"><span class="type">SwfdecLoader</span></a> that can load content from files. This symbol is
147
138
exported so you can subclass your own loaders from it and have automatic
182
172
<div class="refsect2" lang="en">
183
<a name="id2633579"></a><h3>
184
<a name="swfdec-loader-set-url"></a>swfdec_loader_set_url ()</h3>
185
<a class="indexterm" name="id2633590"></a><pre class="programlisting">void swfdec_loader_set_url (<a class="link" href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader,
173
<a name="swfdec-loader-set-url"></a><h3>swfdec_loader_set_url ()</h3>
174
<pre class="programlisting">void swfdec_loader_set_url (<a class="link" href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader,
186
175
const char *url);</pre>
188
177
Updates the url of the given <em class="parameter"><code>loader</code></em> to point to the new <em class="parameter"><code>url</code></em>. This is useful
189
178
whe encountering HTTP redirects, as the loader is supposed to reference the
190
179
final URL after all rdirections.
191
180
This function may only be called once and must have been called before
192
calling <a class="link" href="SwfdecStream.html#swfdec-stream-open"><code class="function">swfdec_stream_open()</code></a> on <em class="parameter"><code>loader</code></em>.</p>
181
calling <a class="link" href="SwfdecStream.html#swfdec-stream-open" title="swfdec_stream_open ()"><code class="function">swfdec_stream_open()</code></a> on <em class="parameter"><code>loader</code></em>.</p>
213
202
<div class="refsect2" lang="en">
214
<a name="id2633692"></a><h3>
215
<a name="swfdec-loader-get-url"></a>swfdec_loader_get_url ()</h3>
216
<a class="indexterm" name="id2633703"></a><pre class="programlisting">const <a class="link" href="swfdec-SwfdecURL.html#SwfdecURL">SwfdecURL</a>* swfdec_loader_get_url (<a class="link" href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader);</pre>
203
<a name="swfdec-loader-get-url"></a><h3>swfdec_loader_get_url ()</h3>
204
<pre class="programlisting">const <a class="link" href="swfdec-SwfdecURL.html#SwfdecURL" title="SwfdecURL">SwfdecURL</a>* swfdec_loader_get_url (<a class="link" href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader);</pre>
218
206
Gets the url this loader is handling. This is mostly useful for writing
219
207
subclasses of <a class="link" href="SwfdecLoader.html" title="SwfdecLoader"><span class="type">SwfdecLoader</span></a>.</p>
224
212
<col align="left" valign="top">
227
<td><p><span class="term"><em class="parameter"><code>loader</code></em> :</span></p></td>
215
<td><p><span class="term"><em class="parameter"><code>loader</code></em> :</span></p></td>
228
216
<td> a <a class="link" href="SwfdecLoader.html" title="SwfdecLoader"><span class="type">SwfdecLoader</span></a>
232
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
233
<td> a <a class="link" href="swfdec-SwfdecURL.html#SwfdecURL"><span class="type">SwfdecURL</span></a> describing <em class="parameter"><code>loader</code></em> or <a
220
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
221
<td> a <a class="link" href="swfdec-SwfdecURL.html#SwfdecURL" title="SwfdecURL"><span class="type">SwfdecURL</span></a> describing <em class="parameter"><code>loader</code></em> or <a
234
222
href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"
235
223
><code class="literal">NULL</code></a> if the <em class="parameter"><code>url</code></em> is not known
243
231
<div class="refsect2" lang="en">
244
<a name="id2638168"></a><h3>
245
<a name="swfdec-loader-set-size"></a>swfdec_loader_set_size ()</h3>
246
<a class="indexterm" name="id2638179"></a><pre class="programlisting">void swfdec_loader_set_size (<a class="link" href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader,
232
<a name="swfdec-loader-set-size"></a><h3>swfdec_loader_set_size ()</h3>
233
<pre class="programlisting">void swfdec_loader_set_size (<a class="link" href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader,
248
235
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gulong"
249
236
>gulong</a> size);</pre>
330
315
<div class="refsect2" lang="en">
331
<a name="id2638436"></a><h3>
332
<a name="swfdec-loader-get-data-type"></a>swfdec_loader_get_data_type ()</h3>
333
<a class="indexterm" name="id2638447"></a><pre class="programlisting"><a class="link" href="swfdec-Enumerations-and-Types.html#SwfdecLoaderDataType">SwfdecLoaderDataType</a> swfdec_loader_get_data_type (<a class="link" href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader);</pre>
316
<a name="swfdec-loader-get-data-type"></a><h3>swfdec_loader_get_data_type ()</h3>
317
<pre class="programlisting"><a class="link" href="swfdec-Enumerations-and-Types.html#SwfdecLoaderDataType" title="enum SwfdecLoaderDataType">SwfdecLoaderDataType</a> swfdec_loader_get_data_type (<a class="link" href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader);</pre>
335
319
Queries the type of data this loader provides. The type is determined
336
320
automatically by Swfdec.</p>
341
325
<col align="left" valign="top">
344
<td><p><span class="term"><em class="parameter"><code>loader</code></em> :</span></p></td>
328
<td><p><span class="term"><em class="parameter"><code>loader</code></em> :</span></p></td>
345
329
<td> a <a class="link" href="SwfdecLoader.html" title="SwfdecLoader"><span class="type">SwfdecLoader</span></a>
349
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
333
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
350
334
<td> the type this data was identified to be in or
351
335
<a class="link" href="swfdec-Enumerations-and-Types.html#SWFDEC-LOADER-DATA-UNKNOWN:CAPS"><span class="type">SWFDEC_LOADER_DATA_UNKNOWN</span></a> if not identified
358
342
<div class="refsect1" lang="en">
359
<a name="id2638523"></a><h2>Property Details</h2>
343
<a name="SwfdecLoader.property-details"></a><h2>Property Details</h2>
360
344
<div class="refsect2" lang="en">
361
<a name="id2638534"></a><h3>
362
<a name="SwfdecLoader--data-type"></a>The <code class="literal">"data-type"</code> property</h3>
363
<a class="indexterm" name="id2638548"></a><pre class="programlisting"> "data-type" <a class="link" href="swfdec-Enumerations-and-Types.html#SwfdecLoaderDataType">SwfdecLoaderDataType</a> : Read</pre>
345
<a name="SwfdecLoader--data-type"></a><h3>The <code class="literal">"data-type"</code> property</h3>
346
<pre class="programlisting"> "data-type" <a class="link" href="swfdec-Enumerations-and-Types.html#SwfdecLoaderDataType" title="enum SwfdecLoaderDataType">SwfdecLoaderDataType</a> : Read</pre>
364
347
<p>the data's type as identified by Swfdec.</p>
365
348
<p>Default value: SWFDEC_LOADER_DATA_UNKNOWN</p>
368
351
<div class="refsect2" lang="en">
369
<a name="id2638572"></a><h3>
370
<a name="SwfdecLoader--loaded"></a>The <code class="literal">"loaded"</code> property</h3>
371
<a class="indexterm" name="id2638585"></a><pre class="programlisting"> "loaded" <a
352
<a name="SwfdecLoader--loaded"></a><h3>The <code class="literal">"loaded"</code> property</h3>
353
<pre class="programlisting"> "loaded" <a
372
354
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gulong"
373
355
>gulong</a> : Read / Write</pre>
374
356
<p>bytes already loaded.</p>
377
359
<div class="refsect2" lang="en">
378
<a name="id2638606"></a><h3>
379
<a name="SwfdecLoader--size"></a>The <code class="literal">"size"</code> property</h3>
380
<a class="indexterm" name="id2638621"></a><pre class="programlisting"> "size" <a
360
<a name="SwfdecLoader--size"></a><h3>The <code class="literal">"size"</code> property</h3>
361
<pre class="programlisting"> "size" <a
381
362
href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#glong"
382
363
>glong</a> : Read / Write</pre>
383
364
<p>amount of bytes in loader.</p>
388
369
<div class="refsect2" lang="en">
389
<a name="id2638649"></a><h3>
390
<a name="SwfdecLoader--url"></a>The <code class="literal">"url"</code> property</h3>
391
<a class="indexterm" name="id2638664"></a><pre class="programlisting"> "url" <a class="link" href="swfdec-SwfdecURL.html#SwfdecURL">SwfdecURL</a> : Read</pre>
370
<a name="SwfdecLoader--url"></a><h3>The <code class="literal">"url"</code> property</h3>
371
<pre class="programlisting"> "url" <a class="link" href="swfdec-SwfdecURL.html#SwfdecURL" title="SwfdecURL">SwfdecURL</a>* : Read</pre>
392
372
<p>URL for this file.</p>
395
<div class="refsect1" lang="en">
396
<a name="id2638687"></a><div class="refsect2" lang="en"><a name="id2638688"></a></div>
398
<div class="refsect2" lang="en"><a name="id2638689"></a></div>
378
Generated by GTK-Doc V1.10</div>