swfdecplayer.xml

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

<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the mouse event was handled. <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> to propagate the event
         further. A mouse event may not be handled if the user clicked on a 
         translucent area.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-player-key-press" role="function"/>swfdec_player_key_press ()</title>
<indexterm><primary>swfdec_player_key_press</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            swfdec_player_key_press             (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="guint">guint</link> keycode,
                                                         <link linkend="guint">guint</link> character);</programlisting>
<para>
Call this function to make the <parameter>player</parameter> react to a key press. Be sure to
check that keycode transformations are done correctly. For a list of 
keycodes see FIXME.</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>keycode</parameter>&nbsp;:</term>
<listitem><simpara> the key that was pressed
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>character</parameter>&nbsp;:</term>
<listitem><simpara> UCS4 of the character that was inserted or 0 if none
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the key press was handled by the <parameter>player</parameter>, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if it
         should be propagated further
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-player-key-release" role="function"/>swfdec_player_key_release ()</title>
<indexterm><primary>swfdec_player_key_release</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            swfdec_player_key_release           (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="guint">guint</link> keycode,
                                                         <link linkend="guint">guint</link> character);</programlisting>
<para>
Call this function to make the <parameter>player</parameter> react to a key being released. See
<link linkend="swfdec-player-key-press"><function>swfdec_player_key_press()</function></link> for details.</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>keycode</parameter>&nbsp;:</term>
<listitem><simpara> the key that was released
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>character</parameter>&nbsp;:</term>
<listitem><simpara> UCS4 of the character that was inserted or 0 if none
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the key press was handled by the <parameter>player</parameter>, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if it
         should be propagated further
</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>
<listitem><simpara> offset in samples at which to start rendering. The offset is 
	  calculated relative to the last iteration, so the value set 
	  by <link linkend="swfdec-player-set-audio-advance"><function>swfdec_player_set_audio_advance()</function></link> is ignored.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>n_samples</parameter>&nbsp;:</term>
<listitem><simpara> amount of samples to render.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-player-get-audio" role="function"/>swfdec_player_get_audio ()</title>
<indexterm><primary>swfdec_player_get_audio</primary></indexterm><programlisting>const <link linkend="GList">GList</link>*        swfdec_player_get_audio             (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player);</programlisting>
<para>
Returns a list of all currently active audio streams in <parameter>player</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><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="GList"><type>GList</type></link> of <link linkend="SwfdecAudio"><type>SwfdecAudio</type></link>. You must not modify or free this list.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="SwfdecPlayer--alignment"/>The <literal>&quot;alignment&quot;</literal> property</title>
<indexterm><primary>SwfdecPlayer:alignment</primary></indexterm><programlisting>  &quot;alignment&quot;                <link linkend="SwfdecAlignment">SwfdecAlignment</link>       : Read / Write</programlisting>
<para>point of the screen to align the output to.</para><para>Default value: SWFDEC_ALIGNMENT_CENTER</para>
</refsect2>
<refsect2><title><anchor id="SwfdecPlayer--background-color"/>The <literal>&quot;background-color&quot;</literal> property</title>
<indexterm><primary>SwfdecPlayer:background-color</primary></indexterm><programlisting>  &quot;background-color&quot;         <link linkend="guint">guint</link>                 : Read / Write</programlisting>
<para>ARGB color used to draw the background.</para><para>Default value: 4294967295</para>
</refsect2>
<refsect2><title><anchor id="SwfdecPlayer--cache-size"/>The <literal>&quot;cache-size&quot;</literal> property</title>
<indexterm><primary>SwfdecPlayer:cache-size</primary></indexterm><programlisting>  &quot;cache-size&quot;               <link linkend="guint">guint</link>                 : Read</programlisting>
<para>maximum cache size in bytes.</para><para>Default value: 52428800</para>
</refsect2>
<refsect2><title><anchor id="SwfdecPlayer--height"/>The <literal>&quot;height&quot;</literal> property</title>
<indexterm><primary>SwfdecPlayer:height</primary></indexterm><programlisting>  &quot;height&quot;                   <link linkend="gint">gint</link>                  : Read / Write</programlisting>
<para>current height of the movie.</para><para>Allowed values: &gt;= -1</para>
<para>Default value: -1</para>
</refsect2>
<refsect2><title><anchor id="SwfdecPlayer--initialized"/>The <literal>&quot;initialized&quot;</literal> property</title>
<indexterm><primary>SwfdecPlayer:initialized</primary></indexterm><programlisting>  &quot;initialized&quot;              <link linkend="gboolean">gboolean</link>              : Read</programlisting>
<para>TRUE when the player has initialized its basic values.</para><para>Default value: FALSE</para>
</refsect2>
<refsect2><title><anchor id="SwfdecPlayer--mouse-cursor"/>The <literal>&quot;mouse-cursor&quot;</literal> property</title>
<indexterm><primary>SwfdecPlayer:mouse-cursor</primary></indexterm><programlisting>  &quot;mouse-cursor&quot;             <link linkend="SwfdecMouseCursor">SwfdecMouseCursor</link>     : Read</programlisting>
<para>how the mouse pointer should be presented.</para><para>Default value: SWFDEC_MOUSE_CURSOR_NONE</para>
</refsect2>
<refsect2><title><anchor id="SwfdecPlayer--next-event"/>The <literal>&quot;next-event&quot;</literal> property</title>
<indexterm><primary>SwfdecPlayer:next-event</primary></indexterm><programlisting>  &quot;next-event&quot;               <link linkend="guint">guint</link>                 : Read</programlisting>
<para>how many milliseconds until the next event or 0 when no event pending.</para><para>Default value: 0</para>
</refsect2>
<refsect2><title><anchor id="SwfdecPlayer--scale-mode"/>The <literal>&quot;scale-mode&quot;</literal> property</title>
<indexterm><primary>SwfdecPlayer:scale-mode</primary></indexterm><programlisting>  &quot;scale-mode&quot;               <link linkend="SwfdecScaleMode">SwfdecScaleMode</link>       : Read / Write</programlisting>
<para>method used to scale the movie.</para><para>Default value: SWFDEC_SCALE_SHOW_ALL</para>
</refsect2>
<refsect2><title><anchor id="SwfdecPlayer--width"/>The <literal>&quot;width&quot;</literal> property</title>
<indexterm><primary>SwfdecPlayer:width</primary></indexterm><programlisting>  &quot;width&quot;                    <link linkend="gint">gint</link>                  : Read / Write</programlisting>
<para>current width of the movie.</para><para>Allowed values: &gt;= -1</para>
<para>Default value: -1</para>
</refsect2>

</refsect1>

<refsect1 role="signals">
<title role="signals.title">Signal Details</title>
<refsect2><title><anchor id="SwfdecPlayer-advance"/>The <literal>&quot;advance&quot;</literal> signal</title>
<indexterm><primary>SwfdecPlayer::advance</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                        <link linkend="guint">guint</link>         msecs,
                                                        <link linkend="guint">guint</link>         audio_samples,
                                                        <link linkend="gpointer">gpointer</link>      user_data)          : Run Last</programlisting>
<para>
Emitted whenever the player advances.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link> affected
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>msecs</parameter>&nbsp;:</term>
<listitem><simpara> the amount of milliseconds the player will advance
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>audio_samples</parameter>&nbsp;:</term>
<listitem><simpara> number of frames the audio is advanced (in 44100Hz steps)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="SwfdecPlayer-audio-added"/>The <literal>&quot;audio-added&quot;</literal> signal</title>
<indexterm><primary>SwfdecPlayer::audio-added</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                        <link linkend="SwfdecAudio">SwfdecAudio</link>  *audio,
                                                        <link linkend="gpointer">gpointer</link>      user_data)      : Run Last</programlisting>
<para>
Emitted whenever a new audio stream was added to <parameter>player</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link> affected
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>audio</parameter>&nbsp;:</term>
<listitem><simpara> the audio stream that was added
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="SwfdecPlayer-audio-removed"/>The <literal>&quot;audio-removed&quot;</literal> signal</title>
<indexterm><primary>SwfdecPlayer::audio-removed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,