swfdecplayer.html

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

<div class="refsect2" lang="en">
<a name="id2613272"></a><h3>
<a name="SwfdecPlayer-audio-removed"></a>The <code class="literal">"audio-removed"</code> signal</h3>
<a class="indexterm" name="id2613289"></a><pre class="programlisting">void                user_function                      (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player,
                                                        <a href="SwfdecAudio.html" title="SwfdecAudio">SwfdecAudio</a>  *audio,
                                                        gpointer      user_data)      : Run Last</pre>
<p>
Emitted whenever an audio stream was removed from <em class="parameter"><code>player</code></em>. The stream will 
have been added with the SwfdecPlayer::audio-added signal previously.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>player</code></em>&#160;:</span></td>
<td> the <a href="SwfdecPlayer.html" title="SwfdecPlayer"><span class="type">SwfdecPlayer</span></a> affected
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>audio</code></em>&#160;:</span></td>
<td> the audio stream that was removed
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2613397"></a><h3>
<a name="SwfdecPlayer-fscommand"></a>The <code class="literal">"fscommand"</code> signal</h3>
<a class="indexterm" name="id2613413"></a><pre class="programlisting">void                user_function                      (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player,
                                                        gchar        *command,
                                                        gchar        *paramter,
                                                        gpointer      user_data)      : Run Last</pre>
<p>
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: </p>
<div class="itemizedlist"><ul type="disc">
<li><p>"quit": quits the player.</p></li>
<li><p>"fullscreen": A boolean setting (parameter is "true" or 
"false") that sets the player into fullscreen mode.</p></li>
<li><p>"allowscale": A boolean setting that tells the player to
not scale the Flash application.</p></li>
<li><p>"showmenu": A boolean setting that tells the Flash player
to not show its own entries in the right-click menu.</p></li>
<li><p>"exec": Run an external executable. The parameter 
specifies the path.</p></li>
<li><p>"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.</p></li>
</ul></div>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>player</code></em>&#160;:</span></td>
<td> the <a href="SwfdecPlayer.html" title="SwfdecPlayer"><span class="type">SwfdecPlayer</span></a> affected
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>command</code></em>&#160;:</span></td>
<td> the command to execute
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>paramter</code></em>&#160;:</span></td>
<td> parameter to pass to the command. The parameter depends on the 
           function.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2613581"></a><h3>
<a name="SwfdecPlayer-handle-key"></a>The <code class="literal">"handle-key"</code> signal</h3>
<a class="indexterm" name="id2613598"></a><pre class="programlisting">gboolean            user_function                      (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player,
                                                        guint         key,
                                                        guint         pressed,
                                                        gboolean      Returns,
                                                        gpointer      user_data)      : Run Last</pre>
<p>
This signal is emitted whenever <em class="parameter"><code>player</code></em> should respond to a key event. If
any of the handlers returns TRUE, <a href="SwfdecPlayer.html#swfdec-player-key-press"><code class="function">swfdec_player_key_press()</code></a> or 
<a href="SwfdecPlayer.html#swfdec-player-key-release"><code class="function">swfdec_player_key_release()</code></a> will return TRUE. Note that unlike many event 
handlers in gtk, returning TRUE will not stop further event handlers from 
being invoked. Use <code class="function">g_signal_stop_emission()</code> in that case.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>player</code></em>&#160;:</span></td>
<td> the <a href="SwfdecPlayer.html" title="SwfdecPlayer"><span class="type">SwfdecPlayer</span></a> affected
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>key</code></em>&#160;:</span></td>
<td> <a href="swfdec-Enumerations.html#SwfdecKey"><span class="type">SwfdecKey</span></a> that was pressed or released
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>pressed</code></em>&#160;:</span></td>
<td> <code class="literal">TRUE</code> if the <em class="parameter"><code>key</code></em> was pressed or <code class="literal">FALSE</code> if it was released
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE if this handler handles the event. 
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2613809"></a><h3>
<a name="SwfdecPlayer-handle-mouse"></a>The <code class="literal">"handle-mouse"</code> signal</h3>
<a class="indexterm" name="id2613826"></a><pre class="programlisting">gboolean            user_function                      (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player,
                                                        gdouble       x,
                                                        gdouble       y,
                                                        gint          button,
                                                        gpointer      user_data)      : Run Last</pre>
<p>
This signal is emitted whenever <em class="parameter"><code>player</code></em> should respond to a mouse event. If
any of the handlers returns TRUE, <a href="SwfdecPlayer.html#swfdec-player-handle-mouse"><code class="function">swfdec_player_handle_mouse()</code></a> will return 
TRUE. Note that unlike many event handlers in gtk, returning TRUE will not 
stop further event handlers from being invoked. Use <code class="function">g_signal_stop_emission()</code>
in that case.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>player</code></em>&#160;:</span></td>
<td> the <a href="SwfdecPlayer.html" title="SwfdecPlayer"><span class="type">SwfdecPlayer</span></a> affected
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></td>
<td> new x coordinate of the mouse
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></td>
<td> new y coordinate of the mouse
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>button</code></em>&#160;:</span></td>
<td> 1 if the button is pressed, 0 if not
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE if this handler handles the event. 
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2614010"></a><h3>
<a name="SwfdecPlayer-invalidate"></a>The <code class="literal">"invalidate"</code> signal</h3>
<a class="indexterm" name="id2614026"></a><pre class="programlisting">void                user_function                      (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player,
                                                        gdouble       x,
                                                        gdouble       y,
                                                        gdouble       width,
                                                        gdouble       height,
                                                        gpointer      user_data)      : Run Last</pre>
<p>
This signal is emitted whenever graphical elements inside the player have 
changed. The coordinates describe the smallest rectangle that includes all
changes.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>player</code></em>&#160;:</span></td>
<td> the <a href="SwfdecPlayer.html" title="SwfdecPlayer"><span class="type">SwfdecPlayer</span></a> affected
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></td>
<td> x coordinate of invalid region
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></td>
<td> y coordinate of invalid region
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td> width of invalid region
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td> height of invalid region
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&#160;:</span></td>
<td>user data set when the signal handler was connected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2614193"></a><h3>
<a name="SwfdecPlayer-launch"></a>The <code class="literal">"launch"</code> signal</h3>
<a class="indexterm" name="id2614208"></a><pre class="programlisting">void                user_function                      (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player,
                                                        gchar        *url,
                                                        gchar        *target,
                                                        gpointer      user_data)      : Run Last</pre>
<p>
Emitted whenever the <em class="parameter"><code>player</code></em> 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 <em class="parameter"><code>player</code></em> is undefined.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>player</code></em>&#160;:</span></td>
<td> the <a href="SwfdecPlayer.html" title="SwfdecPlayer"><span class="type">SwfdecPlayer</span></a> affected
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>url</code></em>&#160;:</span></td>
<td> URL to open
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>target</code></em>&#160;:</span></td>
<td> target to load the URL into
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>user_data</code></em>&