swfdecplayer.xml

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

<refsect2>
<title><anchor id="swfdec-player-new" role="function"/>swfdec_player_new ()</title>
<indexterm><primary>swfdec_player_new</primary></indexterm><programlisting><link linkend="SwfdecPlayer">SwfdecPlayer</link>*       swfdec_player_new                   (<link linkend="SwfdecAsDebugger">SwfdecAsDebugger</link> *debugger);</programlisting>
<para>
Creates a new player.
This function calls <link linkend="swfdec-init"><function>swfdec_init()</function></link> for you if it wasn't called before.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>debugger</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="NULL:CAPS"><literal>NULL</literal></link> or a <link linkend="SwfdecAsDebugger"><type>SwfdecAsDebugger</type></link> to use for debugging this player.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The new player
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-player-new-from-file" role="function"/>swfdec_player_new_from_file ()</title>
<indexterm><primary>swfdec_player_new_from_file</primary></indexterm><programlisting><link linkend="SwfdecPlayer">SwfdecPlayer</link>*       swfdec_player_new_from_file         (const <link linkend="char">char</link> *filename);</programlisting>
<para>
Creates a player to play back the given file. If the file does not
exist or another error occurs, the player will be in an error state and not
be initialized.
This function calls <link linkend="swfdec-init"><function>swfdec_init()</function></link> for you if it wasn't called before.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>filename</parameter>&nbsp;:</term>
<listitem><simpara> name of the file to play
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new player
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-player-set-loader" role="function"/>swfdec_player_set_loader ()</title>
<indexterm><primary>swfdec_player_set_loader</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_player_set_loader            (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="SwfdecLoader">SwfdecLoader</link> *loader);</programlisting>
<para>
Sets the loader for the main data. This function only works if no loader has 
been set on <parameter>player</parameter> yet.
For details, see <link linkend="swfdec-player-set-loader-with-variables"><function>swfdec_player_set_loader_with_variables()</function></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>loader</parameter>&nbsp;:</term>
<listitem><simpara> the loader to use for this player. Takes ownership of the given loader.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-player-set-loader-with-variables" role="function"/>swfdec_player_set_loader_with_variables ()</title>
<indexterm><primary>swfdec_player_set_loader_with_variables</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_player_set_loader_with_variables
                                                        (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="SwfdecLoader">SwfdecLoader</link> *loader,
                                                         const <link linkend="char">char</link> *variables);</programlisting>
<para>
Sets the loader for the main data. This function only works if no loader has 
been set on <parameter>player</parameter> yet.
If the <parameter>variables</parameter> are set and validate, they will be set as properties on the 
root movie. 
<note>If you want to capture events during the setup process, you want to 
connect your signal handlers before calling <link linkend="swfdec-player-set-loader"><function>swfdec_player_set_loader()</function></link> and
not use conveniencse functions such as <link linkend="swfdec-player-new-from-file"><function>swfdec_player_new_from_file()</function></link>.</note></para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>loader</parameter>&nbsp;:</term>
<listitem><simpara> the loader to use for this player. Takes ownership of the given loader.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>variables</parameter>&nbsp;:</term>
<listitem><simpara> a string that is checked to be in 'application/x-www-form-urlencoded'
            syntax describing the arguments to set on the new player or NULL for
            none.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-player-is-initialized" role="function"/>swfdec_player_is_initialized ()</title>
<indexterm><primary>swfdec_player_is_initialized</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            swfdec_player_is_initialized        (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player);</programlisting>
<para>
Determines if the <parameter>player</parameter> is initalized yet. An initialized player is able
to provide basic values like width, height or rate. A player may not be 
initialized if the loader it was started with does not reference a Flash
resources or it did not provide enough data yet. If a player is initialized,
it will never be uninitialized again.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if the basic values are known.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-player-get-rate" role="function"/>swfdec_player_get_rate ()</title>
<indexterm><primary>swfdec_player_get_rate</primary></indexterm><programlisting><link linkend="double">double</link>              swfdec_player_get_rate              (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player);</programlisting>
<para>
Queries the framerate of this movie. This number specifies the number
of frames that are supposed to pass per second. It is a 
multiple of 1/256. It is possible that the movie has no framerate if it does
not display a Flash movie but an FLV video for example. This does not mean
it will not change however.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The framerate of this movie or 0 if it isn't known yet or the
         movie doesn't have a framerate.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-player-get-image-size" role="function"/>swfdec_player_get_image_size ()</title>
<indexterm><primary>swfdec_player_get_image_size</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_player_get_image_size        (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="int">int</link> *width,
                                                         <link linkend="int">int</link> *height);</programlisting>
<para>
If the default size of the movie is initialized, fills in <parameter>width</parameter> and <parameter>height</parameter> 
with the size. Otherwise <parameter>width</parameter> and <parameter>height</parameter> are set to 0.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
<listitem><simpara> integer to store the width in or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
<listitem><simpara> integer to store the height in or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-player-get-size" role="function"/>swfdec_player_get_size ()</title>
<indexterm><primary>swfdec_player_get_size</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_player_get_size              (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="int">int</link> *width,
                                                         <link linkend="int">int</link> *height);</programlisting>
<para>
Gets the currently set image size. If the default width or height should be 
used, the width or height respectively is set to -1.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
<listitem><simpara> integer to store the width in or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
<listitem><simpara> integer to store the height in or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-player-set-size" role="function"/>swfdec_player_set_size ()</title>
<indexterm><primary>swfdec_player_set_size</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_player_set_size              (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="int">int</link> width,
                                                         <link linkend="int">int</link> height);</programlisting>
<para>
Sets the image size to the given values. The image size is what the area that
the <parameter>player</parameter> will render and advocate with scripts.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
<listitem><simpara> desired width of the movie or -1 for default
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
<listitem><simpara> desired height of the movie or -1 for default
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-player-get-next-event" role="function"/>swfdec_player_get_next_event ()</title>
<indexterm><primary>swfdec_player_get_next_event</primary></indexterm><programlisting><link linkend="guint">guint</link>               swfdec_player_get_next_event        (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player);</programlisting>
<para>