swfdecloader.xml

Swfdec still is development software, but has also followed a rigid no-crashes-allowed policy. I b

<?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>

<synopsis>



                    <link linkend="SwfdecLoader-struct">SwfdecLoader</link>;
<link linkend="SwfdecLoader">SwfdecLoader</link>*       <link linkend="swfdec-loader-new-from-file">swfdec_loader_new_from_file</link>         (const <link linkend="char">char</link> *filename,
                                                         <link linkend="GError">GError</link> **error);
<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);
<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
</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
</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="swfdec-loader-new-from-file" role="function"/>swfdec_loader_new_from_file ()</title>
<indexterm><primary>swfdec_loader_new_from_file</primary></indexterm><programlisting><link linkend="SwfdecLoader">SwfdecLoader</link>*       swfdec_loader_new_from_file         (const <link linkend="char">char</link> *filename,
                                                         <link linkend="GError">GError</link> **error);</programlisting>
<para>
Creates a new loader for local files.</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><parameter>error</parameter>&nbsp;:</term>
<listitem><simpara> return loacation for an error or NULL
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new loader on success or NULL on failure
</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.</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>buffer</parameter>&nbsp;:</term>
<listitem><simpara> new data to make available. The loader takes the reference
         to the buffer.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-loader-eof" role="function"/>swfdec_loader_eof ()</title>