swfdecloader.html

Swfdec is a decoder/renderer for Macromedia Flash animations. The decoding and rendering engine is

<div class="refsect2" lang="en">
<a name="id2568527"></a><h3>
<a name="swfdec-loader-error"></a>swfdec_loader_error ()</h3>
<a class="indexterm" name="id2568539"></a><pre class="programlisting">void                swfdec_loader_error                 (<a href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader,
                                                         const char *error);</pre>
<p>
Moves the loader in the error state if it wasn't before. A loader that is in
the error state will not process any more data. Also, internal error 
handling scripts may be executed.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>loader</code></em>&#160;:</span></td>
<td> a <a href="SwfdecLoader.html" title="SwfdecLoader"><span class="type">SwfdecLoader</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>error</code></em>&#160;:</span></td>
<td> a string describing the error
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2568620"></a><h3>
<a name="swfdec-loader-get-url"></a>swfdec_loader_get_url ()</h3>
<a class="indexterm" name="id2568631"></a><pre class="programlisting">const <a href="swfdec-SwfdecURL.html#SwfdecURL">SwfdecURL</a>*    swfdec_loader_get_url               (<a href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader);</pre>
<p>
Gets the url this loader is handling. This is mostly useful for writing 
subclasses of <a href="SwfdecLoader.html" title="SwfdecLoader"><span class="type">SwfdecLoader</span></a>.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>loader</code></em>&#160;:</span></td>
<td> a <a href="SwfdecLoader.html" title="SwfdecLoader"><span class="type">SwfdecLoader</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a <a href="swfdec-SwfdecURL.html#SwfdecURL"><span class="type">SwfdecURL</span></a> describing <em class="parameter"><code>loader</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2568721"></a><h3>
<a name="swfdec-loader-set-size"></a>swfdec_loader_set_size ()</h3>
<a class="indexterm" name="id2568732"></a><pre class="programlisting">void                swfdec_loader_set_size              (<a href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader,
                                                         gulong size);</pre>
<p>
Sets the size of bytes in this loader. This function may only be called once.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>loader</code></em>&#160;:</span></td>
<td> a <a href="SwfdecLoader.html" title="SwfdecLoader"><span class="type">SwfdecLoader</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>size</code></em>&#160;:</span></td>
<td> the amount of bytes in this loader
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2568812"></a><h3>
<a name="swfdec-loader-get-size"></a>swfdec_loader_get_size ()</h3>
<a class="indexterm" name="id2568823"></a><pre class="programlisting">gulong              swfdec_loader_get_size              (<a href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader);</pre>
<p>
Queries the amount of bytes inside <em class="parameter"><code>loader</code></em>. If the size is unknown, 0 is 
returned.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>loader</code></em>&#160;:</span></td>
<td> a <a href="SwfdecLoader.html" title="SwfdecLoader"><span class="type">SwfdecLoader</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> the total number of bytes for this loader or 0 if unknown
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2568897"></a><h3>
<a name="swfdec-loader-get-loaded"></a>swfdec_loader_get_loaded ()</h3>
<a class="indexterm" name="id2568908"></a><pre class="programlisting">gulong              swfdec_loader_get_loaded            (<a href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader);</pre>
<p>
Gets the amount of bytes that have already been pushed into <em class="parameter"><code>loader</code></em> and are
available to Swfdec.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>loader</code></em>&#160;:</span></td>
<td> a <a href="SwfdecLoader.html" title="SwfdecLoader"><span class="type">SwfdecLoader</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> Amount of bytes in <em class="parameter"><code>loader</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2568988"></a><h3>
<a name="swfdec-loader-get-filename"></a>swfdec_loader_get_filename ()</h3>
<a class="indexterm" name="id2568999"></a><pre class="programlisting">char*               swfdec_loader_get_filename          (<a href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader);</pre>
<p>
Gets the suggested filename to use for this loader. This may be of interest
when displaying information about the file that is played back.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>loader</code></em>&#160;:</span></td>
<td> a <a href="SwfdecLoader.html" title="SwfdecLoader"><span class="type">SwfdecLoader</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> A string in the glib filename encoding that contains the filename
         for this loader. <code class="function">g_free()</code> after use.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2615353"></a><h3>
<a name="swfdec-loader-get-data-type"></a>swfdec_loader_get_data_type ()</h3>
<a class="indexterm" name="id2615364"></a><pre class="programlisting"><a href="swfdec-Enumerations.html#SwfdecLoaderDataType">SwfdecLoaderDataType</a> swfdec_loader_get_data_type        (<a href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader);</pre>
<p>
Queries the type of data this loader provides. The type is determined 
automatically by Swfdec.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>loader</code></em>&#160;:</span></td>
<td> a <a href="SwfdecLoader.html" title="SwfdecLoader"><span class="type">SwfdecLoader</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> the type this data was identified to be in or 
         <a href="swfdec-Enumerations.html#SWFDEC-LOADER-DATA-UNKNOWN:CAPS"><span class="type">SWFDEC_LOADER_DATA_UNKNOWN</span></a> if not identified
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2615433"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2615442"></a><h3>
<a name="SwfdecLoader--data-type"></a>The <code class="literal">"data-type"</code> property</h3>
<a class="indexterm" name="id2615455"></a><pre class="programlisting">  "data-type"                <a href="swfdec-Enumerations.html#SwfdecLoaderDataType">SwfdecLoaderDataType</a>  : Read</pre>
<p>the data's type as identified by Swfdec.</p>
<p>Default value: SWFDEC_LOADER_DATA_UNKNOWN</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2615481"></a><h3>
<a name="SwfdecLoader--eof"></a>The <code class="literal">"eof"</code> property</h3>
<a class="indexterm" name="id2615496"></a><pre class="programlisting">  "eof"                      gboolean              : Read</pre>
<p>TRUE when all data has been handed to the loader.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2615522"></a><h3>
<a name="SwfdecLoader--error"></a>The <code class="literal">"error"</code> property</h3>
<a class="indexterm" name="id2615537"></a><pre class="programlisting">  "error"                    gchararray            : Read</pre>
<p>NULL when no error or string describing error.</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2615564"></a><h3>
<a name="SwfdecLoader--loaded"></a>The <code class="literal">"loaded"</code> property</h3>
<a class="indexterm" name="id2615577"></a><pre class="programlisting">  "loaded"                   gulong                : Read / Write</pre>
<p>bytes already loaded.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2615600"></a><h3>
<a name="SwfdecLoader--size"></a>The <code class="literal">"size"</code> property</h3>
<a class="indexterm" name="id2615615"></a><pre class="programlisting">  "size"                     gulong                : Read / Write</pre>
<p>amount of bytes in loader.</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2615637"></a><h3>
<a name="SwfdecLoader--url"></a>The <code class="literal">"url"</code> property</h3>
<a class="indexterm" name="id2615652"></a><pre class="programlisting">  "url"                      <a href="swfdec-SwfdecURL.html#SwfdecURL">SwfdecURL</a>             : Read / Write / Construct Only</pre>
<p>URL for this file.</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2615676"></a><div class="refsect2" lang="en"><a name="id2615677"></a></div>
<hr>
<div class="refsect2" lang="en"><a name="id2615678"></a></div>
</div>
</div>
</body>
</html>