swfdecloader.xml

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

<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="SwfdecLoader">
<refmeta>
<refentrytitle role="top_of_page">SwfdecLoader</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>SWFDEC Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>SwfdecLoader</refname>
<refpurpose>object used for input</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<anchor id="SwfdecFileLoader"/>
<synopsis>



                    <link linkend="SwfdecLoader-struct">SwfdecLoader</link>;
                    <link linkend="SwfdecFileLoader-struct">SwfdecFileLoader</link>;
<link linkend="SwfdecLoader">SwfdecLoader</link>*       <link linkend="swfdec-file-loader-new">swfdec_file_loader_new</link>              (const <link linkend="char">char</link> *filename);
<link linkend="void">void</link>                <link linkend="swfdec-loader-open">swfdec_loader_open</link>                  (<link linkend="SwfdecLoader">SwfdecLoader</link> *loader,
                                                         const <link linkend="char">char</link> *url);
<link linkend="void">void</link>                <link linkend="swfdec-loader-push">swfdec_loader_push</link>                  (<link linkend="SwfdecLoader">SwfdecLoader</link> *loader,
                                                         <link linkend="SwfdecBuffer">SwfdecBuffer</link> *buffer);
<link linkend="void">void</link>                <link linkend="swfdec-loader-eof">swfdec_loader_eof</link>                   (<link linkend="SwfdecLoader">SwfdecLoader</link> *loader);
<link linkend="void">void</link>                <link linkend="swfdec-loader-error">swfdec_loader_error</link>                 (<link linkend="SwfdecLoader">SwfdecLoader</link> *loader,
                                                         const <link linkend="char">char</link> *error);
const <link linkend="SwfdecURL">SwfdecURL</link>*    <link linkend="swfdec-loader-get-url">swfdec_loader_get_url</link>               (<link linkend="SwfdecLoader">SwfdecLoader</link> *loader);
<link linkend="void">void</link>                <link linkend="swfdec-loader-set-size">swfdec_loader_set_size</link>              (<link linkend="SwfdecLoader">SwfdecLoader</link> *loader,
                                                         <link linkend="gulong">gulong</link> size);
<link linkend="gulong">gulong</link>              <link linkend="swfdec-loader-get-size">swfdec_loader_get_size</link>              (<link linkend="SwfdecLoader">SwfdecLoader</link> *loader);
<link linkend="gulong">gulong</link>              <link linkend="swfdec-loader-get-loaded">swfdec_loader_get_loaded</link>            (<link linkend="SwfdecLoader">SwfdecLoader</link> *loader);
<link linkend="char">char</link>*               <link linkend="swfdec-loader-get-filename">swfdec_loader_get_filename</link>          (<link linkend="SwfdecLoader">SwfdecLoader</link> *loader);
<link linkend="SwfdecLoaderDataType">SwfdecLoaderDataType</link> <link linkend="swfdec-loader-get-data-type">swfdec_loader_get_data_type</link>        (<link linkend="SwfdecLoader">SwfdecLoader</link> *loader);

</synopsis>
</refsynopsisdiv>

<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>

  <link linkend="GObject">GObject</link>
   +----SwfdecLoader
         +----<link linkend="SwfdecFileLoader">SwfdecFileLoader</link>
</synopsis>
<synopsis>

  <link linkend="GObject">GObject</link>
   +----<link linkend="SwfdecLoader">SwfdecLoader</link>
         +----SwfdecFileLoader
               +----<link linkend="SwfdecGtkLoader">SwfdecGtkLoader</link>
</synopsis>

</refsect1>





<refsect1 role="properties">
<title role="properties.title">Properties</title>
<synopsis>

  &quot;<link linkend="SwfdecLoader--data-type">data-type</link>&quot;                <link linkend="SwfdecLoaderDataType">SwfdecLoaderDataType</link>  : Read
  &quot;<link linkend="SwfdecLoader--eof">eof</link>&quot;                      <link linkend="gboolean">gboolean</link>              : Read
  &quot;<link linkend="SwfdecLoader--error">error</link>&quot;                    <link linkend="gchararray">gchararray</link>            : Read
  &quot;<link linkend="SwfdecLoader--loaded">loaded</link>&quot;                   <link linkend="gulong">gulong</link>                : Read / Write
  &quot;<link linkend="SwfdecLoader--size">size</link>&quot;                     <link linkend="gulong">gulong</link>                : Read / Write
  &quot;<link linkend="SwfdecLoader--url">url</link>&quot;                      <link linkend="SwfdecURL">SwfdecURL</link>             : Read / Write / Construct Only
</synopsis>
</refsect1>



<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
SwfdecLoader is the base class used for input. Since developers normally 
need to adapt input to the needs of their application, this class is 
provided to be adapted to their needs.
</para>
<para>
Since Flash files can load new resources while operating, a <link linkend="SwfdecLoader"><type>SwfdecLoader</type></link>
can be instructed to load another resource. It's the loader's responsibility
to make sure the player is allowed to access the resource and provide its
data.
</para>
<para>
For convenience, a <link linkend="SwfdecLoader"><type>SwfdecLoader</type></link> for file access is provided by Swfdec.</para>
<para>

</para>
</refsect1>

<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="SwfdecLoader-struct" role="struct"/>SwfdecLoader</title>
<indexterm><primary>SwfdecLoader</primary></indexterm><programlisting>typedef struct _SwfdecLoader SwfdecLoader;</programlisting>
<para>
This is the base class used for providing input. It is abstract, use a 
subclass to provide your input.</para>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="SwfdecFileLoader-struct" role="struct"/>SwfdecFileLoader</title>
<indexterm><primary>SwfdecFileLoader</primary></indexterm><programlisting>typedef struct _SwfdecFileLoader SwfdecFileLoader;</programlisting>
<para>
This is a <link linkend="SwfdecLoader"><type>SwfdecLoader</type></link> that can load content from files. This symbol is
exported so you can subclass your own loaders from it and have automatic
file access.</para>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="swfdec-file-loader-new" role="function"/>swfdec_file_loader_new ()</title>
<indexterm><primary>swfdec_file_loader_new</primary></indexterm><programlisting><link linkend="SwfdecLoader">SwfdecLoader</link>*       swfdec_file_loader_new              (const <link linkend="char">char</link> *filename);</programlisting>
<para>
Creates a new loader for local files. If an error occurred, the loader will
be in error.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>filename</parameter>&nbsp;:</term>
<listitem><simpara> name of the file to load
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new loader
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-loader-open" role="function"/>swfdec_loader_open ()</title>
<indexterm><primary>swfdec_loader_open</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_loader_open                  (<link linkend="SwfdecLoader">SwfdecLoader</link> *loader,
                                                         const <link linkend="char">char</link> *url);</programlisting>
<para>
Call this function when your loader opened the resulting file. For HTTP this
is when having received the headers. You must call this function before 
<link linkend="swfdec-laoder-push"><function>swfdec_laoder_push()</function></link> can be called.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>loader</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecLoader"><type>SwfdecLoader</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>url</parameter>&nbsp;:</term>
<listitem><simpara> the real URL used for this loader if it has changed (e.g. after HTTP 
      redirects) or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if it hasn't changed
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-loader-push" role="function"/>swfdec_loader_push ()</title>
<indexterm><primary>swfdec_loader_push</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_loader_push                  (<link linkend="SwfdecLoader">SwfdecLoader</link> *loader,
                                                         <link linkend="SwfdecBuffer">SwfdecBuffer</link> *buffer);</programlisting>
<para>
Makes the data in <parameter>buffer</parameter> available to <parameter>loader</parameter> and processes it. The <parameter>loader</parameter>
must be open.</para>
<para>

</para><variablelist role="params">