swfdecplayer.xml

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

Queries how long to the next event. This is the next time when you should 
call <link linkend="swfdec-player-advance"><function>swfdec_player_advance()</function></link> to forward to.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> ia <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> number of milliseconds until next event or 0 if no outstanding event
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-player-get-background-color" role="function"/>swfdec_player_get_background_color ()</title>
<indexterm><primary>swfdec_player_get_background_color</primary></indexterm><programlisting><link linkend="guint">guint</link>               swfdec_player_get_background_color  (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player);</programlisting>
<para>
Gets the current background color. The color will be an ARGB-quad, with the 
MSB being the alpha value.</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 background color as an ARGB value
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-player-set-background-color" role="function"/>swfdec_player_set_background_color ()</title>
<indexterm><primary>swfdec_player_set_background_color</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_player_set_background_color  (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="guint">guint</link> color);</programlisting>
<para>
Sets a new background color as an ARGB value. To get transparency, set the 
value to 0. To get a black beackground, use 0xFF000000.</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>color</parameter>&nbsp;:</term>
<listitem><simpara> new color to use as background color
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-player-get-scale-mode" role="function"/>swfdec_player_get_scale_mode ()</title>
<indexterm><primary>swfdec_player_get_scale_mode</primary></indexterm><programlisting><link linkend="SwfdecScaleMode">SwfdecScaleMode</link>     swfdec_player_get_scale_mode        (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player);</programlisting>
<para>
Gets the currrent mode used for scaling the movie. See <link linkend="SwfdecScaleMode"><type>SwfdecScaleMode</type></link> for 
the different modes.</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 current scale mode
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-player-set-scale-mode" role="function"/>swfdec_player_set_scale_mode ()</title>
<indexterm><primary>swfdec_player_set_scale_mode</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_player_set_scale_mode        (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="SwfdecScaleMode">SwfdecScaleMode</link> mode);</programlisting>
<para>
Sets the currrent mode used for scaling the movie. See <link linkend="SwfdecScaleMode"><type>SwfdecScaleMode</type></link> for 
the different modes.</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>mode</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecScaleMode"><type>SwfdecScaleMode</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-player-get-alignment" role="function"/>swfdec_player_get_alignment ()</title>
<indexterm><primary>swfdec_player_get_alignment</primary></indexterm><programlisting><link linkend="SwfdecAlignment">SwfdecAlignment</link>     swfdec_player_get_alignment         (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player);</programlisting>
<para>
Gets the alignment of the player. The alignment describes what point is used
as the anchor for drawing the contents. See <link linkend="SwfdecAlignment"><type>SwfdecAlignment</type></link> for possible 
values.</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 current alignment
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-player-set-alignment" role="function"/>swfdec_player_set_alignment ()</title>
<indexterm><primary>swfdec_player_set_alignment</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_player_set_alignment         (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="SwfdecAlignment">SwfdecAlignment</link> align);</programlisting>
<para>
Sets the alignment to <parameter>align</parameter>. For details about alignment, see 
<link linkend="swfdec-player-get-alignment"><function>swfdec_player_get_alignment()</function></link> and <link linkend="SwfdecAlignment"><type>SwfdecAlignment</type></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>align</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="SwfdecAlignment"><type>SwfdecAlignment</type></link> to set
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-player-render" role="function"/>swfdec_player_render ()</title>
<indexterm><primary>swfdec_player_render</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_player_render                (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="cairo-t">cairo_t</link> *cr,
                                                         <link linkend="double">double</link> x,
                                                         <link linkend="double">double</link> y,
                                                         <link linkend="double">double</link> width,
                                                         <link linkend="double">double</link> height);</programlisting>
<para>
Renders the given area of the current frame to <parameter>cr</parameter>.</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>cr</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="cairo-t"><type>cairo_t</type></link> to render to
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
<listitem><simpara> x coordinate of top left position to render
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara> y coordinate of top left position to render
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
<listitem><simpara> width of area to render or 0 for full width
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
<listitem><simpara> height of area to render or 0 for full height
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-player-advance" role="function"/>swfdec_player_advance ()</title>
<indexterm><primary>swfdec_player_advance</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_player_advance               (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="guint">guint</link> msecs);</programlisting>
<para>
Advances <parameter>player</parameter> by <parameter>msecs</parameter>. You should make sure to call this function as
often as the SwfdecPlayer::next-event property indicates.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link> to advance
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>msecs</parameter>&nbsp;:</term>
<listitem><simpara> number of milliseconds to advance
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-player-handle-mouse" role="function"/>swfdec_player_handle_mouse ()</title>
<indexterm><primary>swfdec_player_handle_mouse</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            swfdec_player_handle_mouse          (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="double">double</link> x,
                                                         <link linkend="double">double</link> y,
                                                         <link linkend="int">int</link> button);</programlisting>
<para>
Updates the current mouse status. If the mouse has left the area of <parameter>player</parameter>,
you should pass values outside the movie size for <parameter>x</parameter> and <parameter>y</parameter>. You will 
probably want to call <link linkend="swfdec-player-advance"><function>swfdec_player_advance()</function></link> before to update the player to
the correct time when calling this function.</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>x</parameter>&nbsp;:</term>
<listitem><simpara> x coordinate of mouse
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara> y coordinate of mouse
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>button</parameter>&nbsp;:</term>
<listitem><simpara> 1 for pressed, 0 for not pressed
</simpara></listitem></varlistentry>