swfdecplayer.html

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

</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2594138"></a><h2>Property Details</h2>
<div class="refsect2" lang="en">
<a name="id2594147"></a><h3>
<a name="SwfdecPlayer--background-color"></a>The "<code class="literal">background-color</code>" property</h3>
<a class="indexterm" name="id2594162"></a><pre class="programlisting">  "background-color"         guint                 : Read / Write</pre>
<p>ARGB color used to draw the background.</p>
<p>Default value: 4294967295</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2594186"></a><h3>
<a name="SwfdecPlayer--cache-size"></a>The "<code class="literal">cache-size</code>" property</h3>
<a class="indexterm" name="id2594198"></a><pre class="programlisting">  "cache-size"               guint                 : Read</pre>
<p>maximum cache size in bytes.</p>
<p>Default value: 52428800</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2594222"></a><h3>
<a name="SwfdecPlayer--initialized"></a>The "<code class="literal">initialized</code>" property</h3>
<a class="indexterm" name="id2594234"></a><pre class="programlisting">  "initialized"              gboolean              : Read</pre>
<p>TRUE when the player has initialized its basic values.</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2594258"></a><h3>
<a name="SwfdecPlayer--mouse-cursor"></a>The "<code class="literal">mouse-cursor</code>" property</h3>
<a class="indexterm" name="id2594271"></a><pre class="programlisting">  "mouse-cursor"             <a href="swfdec-Enumerations.html#SwfdecMouseCursor">SwfdecMouseCursor</a>     : Read</pre>
<p>how the mouse pointer should be presented.</p>
<p>Default value: SWFDEC_MOUSE_CURSOR_NONE</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2594295"></a><h3>
<a name="SwfdecPlayer--next-event"></a>The "<code class="literal">next-event</code>" property</h3>
<a class="indexterm" name="id2594307"></a><pre class="programlisting">  "next-event"               guint                 : Read</pre>
<p>how many milliseconds until the next event or 0 when no event pending.</p>
<p>Default value: 0</p>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2594332"></a><h2>Signal Details</h2>
<div class="refsect2" lang="en">
<a name="id2594342"></a><h3>
<a name="SwfdecPlayer-advance"></a>The "advance" signal</h3>
<a class="indexterm" name="id2594349"></a><pre class="programlisting">void                user_function                      (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player,
                                                        guint         msecs,
                                                        guint         audio_samples,
                                                        gpointer      user_data)          : Run Last</pre>
<p>
Emitted whenever the player advances.</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>msecs</code></em>&#160;:</span></td>
<td> the amount of milliseconds the player will advance
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>audio_samples</code></em>&#160;:</span></td>
<td> number of frames the audio is advanced (in 44100Hz steps)
</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="id2594461"></a><h3>
<a name="SwfdecPlayer-audio-added"></a>The "audio-added" signal</h3>
<a class="indexterm" name="id2594468"></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 a new audio stream was added to <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> 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 added
</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="id2594564"></a><h3>
<a name="SwfdecPlayer-audio-removed"></a>The "audio-removed" signal</h3>
<a class="indexterm" name="id2594571"></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="id2594669"></a><h3>
<a name="SwfdecPlayer-handle-mouse"></a>The "handle-mouse" signal</h3>
<a class="indexterm" name="id2594676"></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="id2594843"></a><h3>
<a name="SwfdecPlayer-invalidate"></a>The "invalidate" signal</h3>
<a class="indexterm" name="id2594850"></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="id2595001"></a><h3>
<a name="SwfdecPlayer-launch"></a>The "launch" signal</h3>
<a class="indexterm" name="id2595008"></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>&#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="id2595132"></a><h3>
<a name="SwfdecPlayer-trace"></a>The "trace" signal</h3>
<a class="indexterm" name="id2595140"></a><pre class="programlisting">void                user_function                      (<a href="SwfdecPlayer.html" title="SwfdecPlayer">SwfdecPlayer</a> *player,
                                                        gchar        *text,
                                                        gpointer      user_data)      : Run Last</pre>
<p>
Emits a debugging string while running. 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>text</code></em>&#160;:</span></td>
<td> the debugging string
</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>
</div>
</div>
</body>
</html>