swfdecplayer.xml

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

<listitem><simpara> offset in samples at which to start rendering. The offset is 
	  calculated relative to the last iteration, so the value set 
	  by <link linkend="swfdec-player-set-audio-advance"><function>swfdec_player_set_audio_advance()</function></link> is ignored.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>n_samples</parameter>&nbsp;:</term>
<listitem><simpara> amount of samples to render.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-player-get-audio" role="function"/>swfdec_player_get_audio ()</title>
<indexterm><primary>swfdec_player_get_audio</primary></indexterm><programlisting>const <link linkend="GList">GList</link>*        swfdec_player_get_audio             (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player);</programlisting>
<para>
Returns a list of all currently active audio streams in <parameter>player</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A <link linkend="GList"><type>GList</type></link> of <link linkend="SwfdecAudio"><type>SwfdecAudio</type></link>. You must not modify or free this list.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="SwfdecPlayer--background-color"/>The &quot;<literal>background-color</literal>&quot; property</title>
<indexterm><primary>SwfdecPlayer:background-color</primary></indexterm><programlisting>  &quot;background-color&quot;         <link linkend="guint">guint</link>                 : Read / Write</programlisting>
<para>ARGB color used to draw the background.</para><para>Default value: 4294967295</para>
</refsect2>
<refsect2><title><anchor id="SwfdecPlayer--cache-size"/>The &quot;<literal>cache-size</literal>&quot; property</title>
<indexterm><primary>SwfdecPlayer:cache-size</primary></indexterm><programlisting>  &quot;cache-size&quot;               <link linkend="guint">guint</link>                 : Read</programlisting>
<para>maximum cache size in bytes.</para><para>Default value: 52428800</para>
</refsect2>
<refsect2><title><anchor id="SwfdecPlayer--initialized"/>The &quot;<literal>initialized</literal>&quot; property</title>
<indexterm><primary>SwfdecPlayer:initialized</primary></indexterm><programlisting>  &quot;initialized&quot;              <link linkend="gboolean">gboolean</link>              : Read</programlisting>
<para>TRUE when the player has initialized its basic values.</para><para>Default value: FALSE</para>
</refsect2>
<refsect2><title><anchor id="SwfdecPlayer--mouse-cursor"/>The &quot;<literal>mouse-cursor</literal>&quot; property</title>
<indexterm><primary>SwfdecPlayer:mouse-cursor</primary></indexterm><programlisting>  &quot;mouse-cursor&quot;             <link linkend="SwfdecMouseCursor">SwfdecMouseCursor</link>     : Read</programlisting>
<para>how the mouse pointer should be presented.</para><para>Default value: SWFDEC_MOUSE_CURSOR_NONE</para>
</refsect2>
<refsect2><title><anchor id="SwfdecPlayer--next-event"/>The &quot;<literal>next-event</literal>&quot; property</title>
<indexterm><primary>SwfdecPlayer:next-event</primary></indexterm><programlisting>  &quot;next-event&quot;               <link linkend="guint">guint</link>                 : Read</programlisting>
<para>how many milliseconds until the next event or 0 when no event pending.</para><para>Default value: 0</para>
</refsect2>

</refsect1>

<refsect1 role="signals">
<title role="signals.title">Signal Details</title>
<refsect2><title><anchor id="SwfdecPlayer-advance"/>The &quot;advance&quot; signal</title>
<indexterm><primary>SwfdecPlayer::advance</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                        <link linkend="guint">guint</link>         msecs,
                                                        <link linkend="guint">guint</link>         audio_samples,
                                                        <link linkend="gpointer">gpointer</link>      user_data)          : Run Last</programlisting>
<para>
Emitted whenever the player advances.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link> affected
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>msecs</parameter>&nbsp;:</term>
<listitem><simpara> the amount of milliseconds the player will advance
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>audio_samples</parameter>&nbsp;:</term>
<listitem><simpara> number of frames the audio is advanced (in 44100Hz steps)
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="SwfdecPlayer-audio-added"/>The &quot;audio-added&quot; signal</title>
<indexterm><primary>SwfdecPlayer::audio-added</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                        <link linkend="SwfdecAudio">SwfdecAudio</link>  *audio,
                                                        <link linkend="gpointer">gpointer</link>      user_data)      : Run Last</programlisting>
<para>
Emitted whenever a new audio stream was added to <parameter>player</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link> affected
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>audio</parameter>&nbsp;:</term>
<listitem><simpara> the audio stream that was added
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="SwfdecPlayer-audio-removed"/>The &quot;audio-removed&quot; signal</title>
<indexterm><primary>SwfdecPlayer::audio-removed</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                        <link linkend="SwfdecAudio">SwfdecAudio</link>  *audio,
                                                        <link linkend="gpointer">gpointer</link>      user_data)      : Run Last</programlisting>
<para>
Emitted whenever an audio stream was removed from <parameter>player</parameter>. The stream will 
have been added with the SwfdecPlayer::audio-added signal previously.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link> affected
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>audio</parameter>&nbsp;:</term>
<listitem><simpara> the audio stream that was removed
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="SwfdecPlayer-handle-mouse"/>The &quot;handle-mouse&quot; signal</title>
<indexterm><primary>SwfdecPlayer::handle-mouse</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            user_function                      (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                        <link linkend="gdouble">gdouble</link>       x,
                                                        <link linkend="gdouble">gdouble</link>       y,
                                                        <link linkend="gint">gint</link>          button,
                                                        <link linkend="gpointer">gpointer</link>      user_data)      : Run Last</programlisting>
<para>
this signal is emitted whenever <parameter>player</parameter> should respond to a mouse event. If
any of the handlers returns TRUE, <link linkend="swfdec-player-handle-mouse"><function>swfdec_player_handle_mouse()</function></link> will return 
TRUE. Note that unlike many event handlers in gtk, returning TRUE will not 
stop further event handlers from being invoked. Use <link linkend="g-signal-stop-emission"><function>g_signal_stop_emission()</function></link>
in that case.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link> affected
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
<listitem><simpara> new x coordinate of the mouse
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara> new y coordinate of the mouse
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>button</parameter>&nbsp;:</term>
<listitem><simpara> 1 if the button is pressed, 0 if not
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if this handler handles the event. 
</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="SwfdecPlayer-invalidate"/>The &quot;invalidate&quot; signal</title>
<indexterm><primary>SwfdecPlayer::invalidate</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                        <link linkend="gdouble">gdouble</link>       x,
                                                        <link linkend="gdouble">gdouble</link>       y,
                                                        <link linkend="gdouble">gdouble</link>       width,
                                                        <link linkend="gdouble">gdouble</link>       height,
                                                        <link linkend="gpointer">gpointer</link>      user_data)      : Run Last</programlisting>
<para>
This signal is emitted whenever graphical elements inside the player have 
changed. The coordinates describe the smallest rectangle that includes all
changes.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link> affected
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>x</parameter>&nbsp;:</term>
<listitem><simpara> x coordinate of invalid region
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>y</parameter>&nbsp;:</term>
<listitem><simpara> y coordinate of invalid region
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>width</parameter>&nbsp;:</term>
<listitem><simpara> width of invalid region
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>height</parameter>&nbsp;:</term>
<listitem><simpara> height of invalid region
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="SwfdecPlayer-launch"/>The &quot;launch&quot; signal</title>
<indexterm><primary>SwfdecPlayer::launch</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                        <link linkend="gchar">gchar</link>        *url,
                                                        <link linkend="gchar">gchar</link>        *target,
                                                        <link linkend="gpointer">gpointer</link>      user_data)      : Run Last</programlisting>
<para>
Emitted whenever the <parameter>player</parameter> 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 <parameter>player</parameter> is undefined.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link> affected
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>url</parameter>&nbsp;:</term>
<listitem><simpara> URL to open
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>target</parameter>&nbsp;:</term>
<listitem><simpara> target to load the URL into
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2><refsect2><title><anchor id="SwfdecPlayer-trace"/>The &quot;trace&quot; signal</title>
<indexterm><primary>SwfdecPlayer::trace</primary></indexterm><programlisting><link linkend="void">void</link>                user_function                      (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                        <link linkend="gchar">gchar</link>        *text,
                                                        <link linkend="gpointer">gpointer</link>      user_data)      : Run Last</programlisting>
<para>
Emits a debugging string while running. The effect of calling any swfdec 
functions on the emitting <parameter>player</parameter> is undefined.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> the <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link> affected
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>text</parameter>&nbsp;:</term>
<listitem><simpara> the debugging string
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter>&nbsp;:</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>



</refentry>