swfdecplayer.html

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

value to 0. To get a black beackground, use 0xFF000000.</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> a <a href="SwfdecPlayer.html" title="SwfdecPlayer"><span class="type">SwfdecPlayer</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>color</code></em>&#160;:</span></td>
<td> new color to use as background color
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2611297"></a><h3>
<a name="swfdec-player-get-scale-mode"></a>swfdec_player_get_scale_mode ()</h3>
<a class="indexterm" name="id2611310"></a><pre class="programlisting"><a href="swfdec-Enumerations.html#SwfdecScaleMode">SwfdecScaleMode</a>     swfdec_player_get_scale_mode        (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player);</pre>
<p>
Gets the currrent mode used for scaling the movie. See <a href="swfdec-Enumerations.html#SwfdecScaleMode"><span class="type">SwfdecScaleMode</span></a> for 
the different modes.</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> a <a href="SwfdecPlayer.html" title="SwfdecPlayer"><span class="type">SwfdecPlayer</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> the current scale mode
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2611377"></a><h3>
<a name="swfdec-player-set-scale-mode"></a>swfdec_player_set_scale_mode ()</h3>
<a class="indexterm" name="id2611390"></a><pre class="programlisting">void                swfdec_player_set_scale_mode        (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player,
                                                         <a href="swfdec-Enumerations.html#SwfdecScaleMode">SwfdecScaleMode</a> mode);</pre>
<p>
Sets the currrent mode used for scaling the movie. See <a href="swfdec-Enumerations.html#SwfdecScaleMode"><span class="type">SwfdecScaleMode</span></a> for 
the different modes.</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> a <a href="SwfdecPlayer.html" title="SwfdecPlayer"><span class="type">SwfdecPlayer</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>mode</code></em>&#160;:</span></td>
<td> a <a href="swfdec-Enumerations.html#SwfdecScaleMode"><span class="type">SwfdecScaleMode</span></a>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2611473"></a><h3>
<a name="swfdec-player-get-alignment"></a>swfdec_player_get_alignment ()</h3>
<a class="indexterm" name="id2611484"></a><pre class="programlisting"><a href="swfdec-Enumerations.html#SwfdecAlignment">SwfdecAlignment</a>     swfdec_player_get_alignment         (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player);</pre>
<p>
Gets the alignment of the player. The alignment describes what point is used
as the anchor for drawing the contents. See <a href="swfdec-Enumerations.html#SwfdecAlignment"><span class="type">SwfdecAlignment</span></a> for possible 
values.</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> a <a href="SwfdecPlayer.html" title="SwfdecPlayer"><span class="type">SwfdecPlayer</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> the current alignment
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2611552"></a><h3>
<a name="swfdec-player-set-alignment"></a>swfdec_player_set_alignment ()</h3>
<a class="indexterm" name="id2611563"></a><pre class="programlisting">void                swfdec_player_set_alignment         (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player,
                                                         <a href="swfdec-Enumerations.html#SwfdecAlignment">SwfdecAlignment</a> align);</pre>
<p>
Sets the alignment to <em class="parameter"><code>align</code></em>. For details about alignment, see 
<a href="SwfdecPlayer.html#swfdec-player-get-alignment"><code class="function">swfdec_player_get_alignment()</code></a> and <a href="swfdec-Enumerations.html#SwfdecAlignment"><span class="type">SwfdecAlignment</span></a>.</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> a <a href="SwfdecPlayer.html" title="SwfdecPlayer"><span class="type">SwfdecPlayer</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>align</code></em>&#160;:</span></td>
<td> <a href="swfdec-Enumerations.html#SwfdecAlignment"><span class="type">SwfdecAlignment</span></a> to set
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2611660"></a><h3>
<a name="swfdec-player-render"></a>swfdec_player_render ()</h3>
<a class="indexterm" name="id2611670"></a><pre class="programlisting">void                swfdec_player_render                (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player,
                                                         <a
href="../cairo/cairo-cairo-t.html#cairo-t"
>cairo_t</a> *cr,
                                                         double x,
                                                         double y,
                                                         double width,
                                                         double height);</pre>
<p>
Renders the given area of the current frame to <em class="parameter"><code>cr</code></em>.</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> a <a href="SwfdecPlayer.html" title="SwfdecPlayer"><span class="type">SwfdecPlayer</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>cr</code></em>&#160;:</span></td>
<td> <a
href="../cairo/cairo-cairo-t.html#cairo-t"
><span class="type">cairo_t</span></a> to render to
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></td>
<td> x coordinate of top left position to render
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></td>
<td> y coordinate of top left position to render
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>width</code></em>&#160;:</span></td>
<td> width of area to render or 0 for full width
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td> height of area to render or 0 for full height
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2611832"></a><h3>
<a name="swfdec-player-advance"></a>swfdec_player_advance ()</h3>
<a class="indexterm" name="id2611843"></a><pre class="programlisting">void                swfdec_player_advance               (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player,
                                                         guint msecs);</pre>
<p>
Advances <em class="parameter"><code>player</code></em> by <em class="parameter"><code>msecs</code></em>. You should make sure to call this function as
often as the SwfdecPlayer::next-event property indicates.</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> to advance
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>msecs</code></em>&#160;:</span></td>
<td> number of milliseconds to advance
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2611925"></a><h3>
<a name="swfdec-player-handle-mouse"></a>swfdec_player_handle_mouse ()</h3>
<a class="indexterm" name="id2611936"></a><pre class="programlisting">gboolean            swfdec_player_handle_mouse          (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player,
                                                         double x,
                                                         double y,
                                                         int button);</pre>
<p>
Updates the current mouse status. If the mouse has left the area of <em class="parameter"><code>player</code></em>,
you should pass values outside the movie size for <em class="parameter"><code>x</code></em> and <em class="parameter"><code>y</code></em>. You will 
probably want to call <a href="SwfdecPlayer.html#swfdec-player-advance"><code class="function">swfdec_player_advance()</code></a> before to update the player to
the correct time when calling this function.</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> a <a href="SwfdecPlayer.html" title="SwfdecPlayer"><span class="type">SwfdecPlayer</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>x</code></em>&#160;:</span></td>
<td> x coordinate of mouse
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>y</code></em>&#160;:</span></td>
<td> y coordinate of mouse
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>button</code></em>&#160;:</span></td>
<td> 1 for pressed, 0 for not pressed
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> <code class="literal">TRUE</code> if the mouse event was handled. <code class="literal">FALSE</code> to propagate the event
         further. A mouse event may not be handled if the user clicked on a 
         translucent area.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2612101"></a><h3>
<a name="swfdec-player-key-press"></a>swfdec_player_key_press ()</h3>
<a class="indexterm" name="id2612112"></a><pre class="programlisting">gboolean            swfdec_player_key_press             (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player,
                                                         guint keycode,
                                                         guint character);</pre>
<p>
Call this function to make the <em class="parameter"><code>player</code></em> react to a key press. Be sure to
check that keycode transformations are done correctly. For a list of 
keycodes see FIXME.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>