swfdecplayer.html

Swfdec still is development software, but has also followed a rigid no-crashes-allowed policy. I b

<div class="refsect2" lang="en">
<a name="id2593026"></a><h3>
<a name="swfdec-player-get-rate"></a>swfdec_player_get_rate ()</h3>
<a class="indexterm" name="id2593037"></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="id2593104"></a><h3>
<a name="swfdec-player-get-image-size"></a>swfdec_player_get_image_size ()</h3>
<a class="indexterm" name="id2593116"></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 size of the movie is already known, 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 NULL
</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 NULL
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2593228"></a><h3>
<a name="swfdec-player-get-next-event"></a>swfdec_player_get_next_event ()</h3>
<a class="indexterm" name="id2593241"></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="id2593312"></a><h3>
<a name="swfdec-player-get-background-color"></a>swfdec_player_get_background_color ()</h3>
<a class="indexterm" name="id2593326"></a><pre class="programlisting">unsigned int        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="id2593389"></a><h3>
<a name="swfdec-player-set-background-color"></a>swfdec_player_set_background_color ()</h3>
<a class="indexterm" name="id2593402"></a><pre class="programlisting">void                swfdec_player_set_background_color  (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player,
                                                         unsigned int color);</pre>
<p>
Sets a new background color as an ARGB value. To get transparency, set the 
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="id2593475"></a><h3>
<a name="swfdec-player-render"></a>swfdec_player_render ()</h3>
<a class="indexterm" name="id2593486"></a><pre class="programlisting">void                swfdec_player_render                (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player,
                                                         cairo_t *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> <span class="type">cairo_t</span> 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="id2593647"></a><h3>
<a name="swfdec-player-advance"></a>swfdec_player_advance ()</h3>
<a class="indexterm" name="id2593658"></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="id2593740"></a><h3>
<a name="swfdec-player-handle-mouse"></a>swfdec_player_handle_mouse ()</h3>
<a class="indexterm" name="id2593751"></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> TRUE if the mouse event was handled. A mouse event may not be 
         handled if the user clicked on a translucent area for example.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2593899"></a><h3>
<a name="swfdec-player-render-audio"></a>swfdec_player_render_audio ()</h3>
<a class="indexterm" name="id2593910"></a><pre class="programlisting">void                swfdec_player_render_audio          (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player,
                                                         gint16 *dest,
                                                         guint start_offset,
                                                         guint n_samples);</pre>
<p>
Renders the data for this frame into the given location. The data is added to <em class="parameter"><code>dest</code></em>, 
so you probably want to initialize <em class="parameter"><code>dest</code></em> to silence before 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>dest</code></em>&#160;:</span></td>
<td> location to add audio signal to. The audio signal will be in 
       44100kHz signed 16bit stereo.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>start_offset</code></em>&#160;:</span></td>
<td> offset in samples at which to start rendering. The offset is 
	  calculated relative to the last iteration, so the value set 
	  by <code class="function">swfdec_player_set_audio_advance()</code> is ignored.
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>n_samples</code></em>&#160;:</span></td>
<td> amount of samples to render.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2594046"></a><h3>
<a name="swfdec-player-get-audio"></a>swfdec_player_get_audio ()</h3>
<a class="indexterm" name="id2594056"></a><pre class="programlisting">const GList*        swfdec_player_get_audio             (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player);</pre>
<p>
Returns a list of all currently active audio streams in <em class="parameter"><code>player</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"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> A <span class="type">GList</span> of <a href="SwfdecAudio.html" title="SwfdecAudio"><span class="type">SwfdecAudio</span></a>. You must not modify or free this list.
</td>