swfdecplayer.xml

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

                                                        <link linkend="SwfdecAudio">SwfdecAudio</link>  *audio,
                                                        <link linkend="gpointer">gpointer</link>      user_data)      : Run Last</programlisting>
<para>
Emitted whenever an audio stream was removed from <parameter>player</parameter>. The stream will 
have been added with the SwfdecPlayer::audio-added signal previously.</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 removed
</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-fscommand"/>The <literal>&quot;fscommand&quot;</literal> signal</title>
<indexterm><primary>SwfdecPlayer::fscommand</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                        <link linkend="gchar">gchar</link>        *command,
                                                        <link linkend="gchar">gchar</link>        *paramter,
                                                        <link linkend="gpointer">gpointer</link>      user_data)      : Run Last</programlisting>
<para>
This signal is emited whenever a Flash script command (also known as 
fscommand) is encountered. This method is ued by the Flash file to
communicate with the hosting environment. In web browsers it is used to 
call Javascript functions. Standalone Flash players understand a limited 
set of functions. They vary from player to player, but the most common are 
listed here: <itemizedlist>
<listitem><para>"quit": quits the player.</para></listitem>
<listitem><para>"fullscreen": A boolean setting (parameter is "true" or 
"false") that sets the player into fullscreen mode.</para></listitem>
<listitem><para>"allowscale": A boolean setting that tells the player to
not scale the Flash application.</para></listitem>
<listitem><para>"showmenu": A boolean setting that tells the Flash player
to not show its own entries in the right-click menu.</para></listitem>
<listitem><para>"exec": Run an external executable. The parameter 
specifies the path.</para></listitem>
<listitem><para>"trapallkeys": A boolean setting that tells the Flash 
player to pass all key events to the Flash application instead of using it
for keyboard shortcuts or similar.</para></listitem>
</itemizedlist></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>command</parameter>&nbsp;:</term>
<listitem><simpara> the command to execute
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>paramter</parameter>&nbsp;:</term>
<listitem><simpara> parameter to pass to the command. The parameter depends on the 
           function.
</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-handle-key"/>The <literal>&quot;handle-key&quot;</literal> signal</title>
<indexterm><primary>SwfdecPlayer::handle-key</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            user_function                      (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                        <link linkend="guint">guint</link>         key,
                                                        <link linkend="guint">guint</link>         pressed,
                                                        <link linkend="gboolean">gboolean</link>      Returns,
                                                        <link linkend="gpointer">gpointer</link>      user_data)      : Run Last</programlisting>
<para>
This signal is emitted whenever <parameter>player</parameter> should respond to a key event. If
any of the handlers returns TRUE, <link linkend="swfdec-player-key-press"><function>swfdec_player_key_press()</function></link> or 
<link linkend="swfdec-player-key-release"><function>swfdec_player_key_release()</function></link> will return TRUE. Note that unlike many event 
handlers in gtk, returning TRUE will not stop further event handlers from 
being invoked. Use <link linkend="g-signal-stop-emission"><function>g_signal_stop_emission()</function></link> in that case.</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>key</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="SwfdecKey"><type>SwfdecKey</type></link> that was pressed or released
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>pressed</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the <parameter>key</parameter> was pressed or <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if it was released
</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>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if this handler handles the event. 
</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="SwfdecPlayer-handle-mouse"/>The <literal>&quot;handle-mouse&quot;</literal> signal</title>
<indexterm><primary>SwfdecPlayer::handle-mouse</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            user_function                      (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                        <link linkend="gdouble">gdouble</link>       x,
                                                        <link linkend="gdouble">gdouble</link>       y,
                                                        <link linkend="gint">gint</link>          button,
                                                        <link linkend="gpointer">gpointer</link>      user_data)      : Run Last</programlisting>
<para>
This signal is emitted whenever <parameter>player</parameter> should respond to a mouse event. If
any of the handlers returns TRUE, <link linkend="swfdec-player-handle-mouse"><function>swfdec_player_handle_mouse()</function></link> will return 
TRUE. Note that unlike many event handlers in gtk, returning TRUE will not 
stop further event handlers from being invoked. Use <link linkend="g-signal-stop-emission"><function>g_signal_stop_emission()</function></link>
in that case.</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>x</parameter>&nbsp;:</term>
<listitem><simpara> new x coordinate of the mouse
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara> new y coordinate of the mouse
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>button</parameter>&nbsp;:</term>
<listitem><simpara> 1 if the button is pressed, 0 if not
</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>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if this handler handles the event. 
</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="SwfdecPlayer-invalidate"/>The <literal>&quot;invalidate&quot;</literal> signal</title>
<indexterm><primary>SwfdecPlayer::invalidate</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                        <link linkend="gdouble">gdouble</link>       x,
                                                        <link linkend="gdouble">gdouble</link>       y,
                                                        <link linkend="gdouble">gdouble</link>       width,
                                                        <link linkend="gdouble">gdouble</link>       height,
                                                        <link linkend="gpointer">gpointer</link>      user_data)      : Run Last</programlisting>
<para>
This signal is emitted whenever graphical elements inside the player have 
changed. The coordinates describe the smallest rectangle that includes all
changes.</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>x</parameter>&nbsp;:</term>
<listitem><simpara> x coordinate of invalid region
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara> y coordinate of invalid region
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
<listitem><simpara> width of invalid region
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
<listitem><simpara> height of invalid region
</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-launch"/>The <literal>&quot;launch&quot;</literal> signal</title>
<indexterm><primary>SwfdecPlayer::launch</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                        <link linkend="gchar">gchar</link>        *url,
                                                        <link linkend="gchar">gchar</link>        *target,
                                                        <link linkend="gpointer">gpointer</link>      user_data)      : Run Last</programlisting>
<para>
Emitted whenever the <parameter>player</parameter> encounters an URL that should be loaded into 
a target the Flash player does not recognize. In most cases this happens 
when the user clicks a link in an embedded Flash movie that should open a
new web page.
The effect of calling any swfdec functions on the emitting <parameter>player</parameter> is undefined.</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>url</parameter>&nbsp;:</term>
<listitem><simpara> URL to open
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>target</parameter>&nbsp;:</term>
<listitem><simpara> target to load the URL into
</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>
</refsect1>




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