swfdecplayer.xml

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

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 size of the movie is already known, 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 NULL
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
<listitem><simpara> integer to store the height in or NULL
</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>
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>unsigned <link linkend="int">int</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,
                                                         unsigned <link linkend="int">int</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-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>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if the mouse event was handled. A mouse event may not be 
         handled if the user clicked on a translucent area for example.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-player-render-audio" role="function"/>swfdec_player_render_audio ()</title>
<indexterm><primary>swfdec_player_render_audio</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_player_render_audio          (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="gint16">gint16</link> *dest,
                                                         <link linkend="guint">guint</link> start_offset,
                                                         <link linkend="guint">guint</link> n_samples);</programlisting>
<para>
Renders the data for this frame into the given location. The data is added to <parameter>dest</parameter>, 
so you probably want to initialize <parameter>dest</parameter> to silence before 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>dest</parameter>&nbsp;:</term>
<listitem><simpara> location to add audio signal to. The audio signal will be in 
       44100kHz signed 16bit stereo.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>start_offset</parameter>&nbsp;:</term>