swfdecplayer.html

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

<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>loader</code></em>&#160;:</span></td>
<td> the loader to use for this player. Takes ownership of the given loader.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610386"></a><h3>
<a name="swfdec-player-set-loader-with-variables"></a>swfdec_player_set_loader_with_variables ()</h3>
<a class="indexterm" name="id2610399"></a><pre class="programlisting">void                swfdec_player_set_loader_with_variables
                                                        (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player,
                                                         <a href="SwfdecLoader.html" title="SwfdecLoader">SwfdecLoader</a> *loader,
                                                         const char *variables);</pre>
<p>
Sets the loader for the main data. This function only works if no loader has 
been set on <em class="parameter"><code>player</code></em> yet.
If the <em class="parameter"><code>variables</code></em> are set and validate, they will be set as properties on the 
root movie. 
</p>
<div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Note</h3>If you want to capture events during the setup process, you want to 
connect your signal handlers before calling <a href="SwfdecPlayer.html#swfdec-player-set-loader"><code class="function">swfdec_player_set_loader()</code></a> and
not use conveniencse functions such as <a href="SwfdecPlayer.html#swfdec-player-new-from-file"><code class="function">swfdec_player_new_from_file()</code></a>.</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> a <a href="SwfdecPlayer.html" title="SwfdecPlayer"><span class="type">SwfdecPlayer</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>loader</code></em>&#160;:</span></td>
<td> the loader to use for this player. Takes ownership of the given loader.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>variables</code></em>&#160;:</span></td>
<td> 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.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610522"></a><h3>
<a name="swfdec-player-is-initialized"></a>swfdec_player_is_initialized ()</h3>
<a class="indexterm" name="id2610534"></a><pre class="programlisting">gboolean            swfdec_player_is_initialized        (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player);</pre>
<p>
Determines if the <em class="parameter"><code>player</code></em> 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.</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> TRUE if the basic values are known.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610606"></a><h3>
<a name="swfdec-player-get-rate"></a>swfdec_player_get_rate ()</h3>
<a class="indexterm" name="id2610617"></a><pre class="programlisting">double              swfdec_player_get_rate              (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player);</pre>
<p>
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.</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 framerate of this movie or 0 if it isn't known yet or the
         movie doesn't have a framerate.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610683"></a><h3>
<a name="swfdec-player-get-image-size"></a>swfdec_player_get_image_size ()</h3>
<a class="indexterm" name="id2610696"></a><pre class="programlisting">void                swfdec_player_get_image_size        (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player,
                                                         int *width,
                                                         int *height);</pre>
<p>
If the default size of the movie is initialized, fills in <em class="parameter"><code>width</code></em> and <em class="parameter"><code>height</code></em> 
with the size. Otherwise <em class="parameter"><code>width</code></em> and <em class="parameter"><code>height</code></em> are set to 0.</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>width</code></em>&#160;:</span></td>
<td> integer to store the width in or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td> integer to store the height in or <code class="literal">NULL</code>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610825"></a><h3>
<a name="swfdec-player-get-size"></a>swfdec_player_get_size ()</h3>
<a class="indexterm" name="id2610835"></a><pre class="programlisting">void                swfdec_player_get_size              (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player,
                                                         int *width,
                                                         int *height);</pre>
<p>
Gets the currently set image size. If the default width or height should be 
used, the width or height respectively is set to -1.</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>width</code></em>&#160;:</span></td>
<td> integer to store the width in or <code class="literal">NULL</code>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td> integer to store the height in or <code class="literal">NULL</code>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2610944"></a><h3>
<a name="swfdec-player-set-size"></a>swfdec_player_set_size ()</h3>
<a class="indexterm" name="id2610954"></a><pre class="programlisting">void                swfdec_player_set_size              (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player,
                                                         int width,
                                                         int height);</pre>
<p>
Sets the image size to the given values. The image size is what the area that
the <em class="parameter"><code>player</code></em> will render and advocate with scripts.</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>width</code></em>&#160;:</span></td>
<td> desired width of the movie or -1 for default
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>height</code></em>&#160;:</span></td>
<td> desired height of the movie or -1 for default
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2611052"></a><h3>
<a name="swfdec-player-get-next-event"></a>swfdec_player_get_next_event ()</h3>
<a class="indexterm" name="id2611064"></a><pre class="programlisting">guint               swfdec_player_get_next_event        (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player);</pre>
<p>
Queries how long to the next event. This is the next time when you should 
call <a href="SwfdecPlayer.html#swfdec-player-advance"><code class="function">swfdec_player_advance()</code></a> to forward to.</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> ia <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> number of milliseconds until next event or 0 if no outstanding event
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2611136"></a><h3>
<a name="swfdec-player-get-background-color"></a>swfdec_player_get_background_color ()</h3>
<a class="indexterm" name="id2611149"></a><pre class="programlisting">guint               swfdec_player_get_background_color  (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player);</pre>
<p>
Gets the current background color. The color will be an ARGB-quad, with the 
MSB being the alpha value.</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 background color as an ARGB value
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2611211"></a><h3>
<a name="swfdec-player-set-background-color"></a>swfdec_player_set_background_color ()</h3>
<a class="indexterm" name="id2611225"></a><pre class="programlisting">void                swfdec_player_set_background_color  (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player,
                                                         guint color);</pre>
<p>
Sets a new background color as an ARGB value. To get transparency, set the