swfdecloader.xml

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

<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>
<indexterm><primary>swfdec_loader_eof</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_loader_eof                   (<link linkend="SwfdecLoader">SwfdecLoader</link> *loader);</programlisting>
<para>
Indicates to <parameter>loader</parameter> that no more data will follow. The loader must be open.</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>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-loader-error" role="function"/>swfdec_loader_error ()</title>
<indexterm><primary>swfdec_loader_error</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_loader_error                 (<link linkend="SwfdecLoader">SwfdecLoader</link> *loader,
                                                         const <link linkend="char">char</link> *error);</programlisting>
<para>
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.</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>error</parameter>&nbsp;:</term>
<listitem><simpara> a string describing the error
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-loader-get-url" role="function"/>swfdec_loader_get_url ()</title>
<indexterm><primary>swfdec_loader_get_url</primary></indexterm><programlisting>const <link linkend="SwfdecURL">SwfdecURL</link>*    swfdec_loader_get_url               (<link linkend="SwfdecLoader">SwfdecLoader</link> *loader);</programlisting>
<para>
Gets the url this loader is handling. This is mostly useful for writing 
subclasses of <link linkend="SwfdecLoader"><type>SwfdecLoader</type></link>.</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><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a <link linkend="SwfdecURL"><type>SwfdecURL</type></link> describing <parameter>loader</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-loader-set-size" role="function"/>swfdec_loader_set_size ()</title>
<indexterm><primary>swfdec_loader_set_size</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_loader_set_size              (<link linkend="SwfdecLoader">SwfdecLoader</link> *loader,
                                                         <link linkend="gulong">gulong</link> size);</programlisting>
<para>
Sets the size of bytes in this loader. This function may only be called once.</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>size</parameter>&nbsp;:</term>
<listitem><simpara> the amount of bytes in this loader
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-loader-get-size" role="function"/>swfdec_loader_get_size ()</title>
<indexterm><primary>swfdec_loader_get_size</primary></indexterm><programlisting><link linkend="gulong">gulong</link>              swfdec_loader_get_size              (<link linkend="SwfdecLoader">SwfdecLoader</link> *loader);</programlisting>
<para>
Queries the amount of bytes inside <parameter>loader</parameter>. If the size is unknown, 0 is 
returned.</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><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the total number of bytes for this loader or 0 if unknown
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-loader-get-loaded" role="function"/>swfdec_loader_get_loaded ()</title>
<indexterm><primary>swfdec_loader_get_loaded</primary></indexterm><programlisting><link linkend="gulong">gulong</link>              swfdec_loader_get_loaded            (<link linkend="SwfdecLoader">SwfdecLoader</link> *loader);</programlisting>
<para>
Gets the amount of bytes that have already been pushed into <parameter>loader</parameter> and are
available to Swfdec.</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><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> Amount of bytes in <parameter>loader</parameter>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-loader-get-filename" role="function"/>swfdec_loader_get_filename ()</title>
<indexterm><primary>swfdec_loader_get_filename</primary></indexterm><programlisting><link linkend="char">char</link>*               swfdec_loader_get_filename          (<link linkend="SwfdecLoader">SwfdecLoader</link> *loader);</programlisting>
<para>
Gets the suggested filename to use for this loader. This may be of interest
when displaying information about the file that is played back.</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><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A string in the glib filename encoding that contains the filename
         for this loader. <link linkend="g-free"><function>g_free()</function></link> after use.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-loader-get-data-type" role="function"/>swfdec_loader_get_data_type ()</title>
<indexterm><primary>swfdec_loader_get_data_type</primary></indexterm><programlisting><link linkend="SwfdecLoaderDataType">SwfdecLoaderDataType</link> swfdec_loader_get_data_type        (<link linkend="SwfdecLoader">SwfdecLoader</link> *loader);</programlisting>
<para>
Queries the type of data this loader provides. The type is determined 
automatically by Swfdec.</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><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the type this data was identified to be in or 
         <link linkend="SWFDEC-LOADER-DATA-UNKNOWN:CAPS"><type>SWFDEC_LOADER_DATA_UNKNOWN</type></link> if not identified
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="SwfdecLoader--data-type"/>The <literal>&quot;data-type&quot;</literal> property</title>
<indexterm><primary>SwfdecLoader:data-type</primary></indexterm><programlisting>  &quot;data-type&quot;                <link linkend="SwfdecLoaderDataType">SwfdecLoaderDataType</link>  : Read</programlisting>
<para>the data's type as identified by Swfdec.</para><para>Default value: SWFDEC_LOADER_DATA_UNKNOWN</para>
</refsect2>
<refsect2><title><anchor id="SwfdecLoader--eof"/>The <literal>&quot;eof&quot;</literal> property</title>
<indexterm><primary>SwfdecLoader:eof</primary></indexterm><programlisting>  &quot;eof&quot;                      <link linkend="gboolean">gboolean</link>              : Read</programlisting>
<para>TRUE when all data has been handed to the loader.</para><para>Default value: FALSE</para>
</refsect2>
<refsect2><title><anchor id="SwfdecLoader--error"/>The <literal>&quot;error&quot;</literal> property</title>
<indexterm><primary>SwfdecLoader:error</primary></indexterm><programlisting>  &quot;error&quot;                    <link linkend="gchararray">gchararray</link>            : Read</programlisting>
<para>NULL when no error or string describing error.</para><para>Default value: NULL</para>
</refsect2>
<refsect2><title><anchor id="SwfdecLoader--loaded"/>The <literal>&quot;loaded&quot;</literal> property</title>
<indexterm><primary>SwfdecLoader:loaded</primary></indexterm><programlisting>  &quot;loaded&quot;                   <link linkend="gulong">gulong</link>                : Read / Write</programlisting>
<para>bytes already loaded.</para></refsect2>
<refsect2><title><anchor id="SwfdecLoader--size"/>The <literal>&quot;size&quot;</literal> property</title>
<indexterm><primary>SwfdecLoader:size</primary></indexterm><programlisting>  &quot;size&quot;                     <link linkend="gulong">gulong</link>                : Read / Write</programlisting>
<para>amount of bytes in loader.</para></refsect2>
<refsect2><title><anchor id="SwfdecLoader--url"/>The <literal>&quot;url&quot;</literal> property</title>
<indexterm><primary>SwfdecLoader:url</primary></indexterm><programlisting>  &quot;url&quot;                      <link linkend="SwfdecURL">SwfdecURL</link>             : Read / Write / Construct Only</programlisting>
<para>URL for this file.</para></refsect2>

</refsect1>





<refsect1><refsect2 /><refsect2 /></refsect1>
</refentry>