swfdecgtkplayer.xml

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

<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="SwfdecGtkPlayer">
<refmeta>
<refentrytitle role="top_of_page">SwfdecGtkPlayer</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>SWFDEC Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>SwfdecGtkPlayer</refname>
<refpurpose>an improved <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>



                    <link linkend="SwfdecGtkPlayer-struct">SwfdecGtkPlayer</link>;
<link linkend="SwfdecPlayer">SwfdecPlayer</link>*       <link linkend="swfdec-gtk-player-new">swfdec_gtk_player_new</link>               (<link linkend="SwfdecAsDebugger">SwfdecAsDebugger</link> *debugger);
<link linkend="SwfdecPlayer">SwfdecPlayer</link>*       <link linkend="swfdec-gtk-player-new-from-uri">swfdec_gtk_player_new_from_uri</link>      (const <link linkend="char">char</link> *uri);
<link linkend="gboolean">gboolean</link>            <link linkend="swfdec-gtk-player-get-playing">swfdec_gtk_player_get_playing</link>       (<link linkend="SwfdecGtkPlayer">SwfdecGtkPlayer</link> *player);
<link linkend="void">void</link>                <link linkend="swfdec-gtk-player-set-playing">swfdec_gtk_player_set_playing</link>       (<link linkend="SwfdecGtkPlayer">SwfdecGtkPlayer</link> *player,
                                                         <link linkend="gboolean">gboolean</link> playing);
<link linkend="double">double</link>              <link linkend="swfdec-gtk-player-get-speed">swfdec_gtk_player_get_speed</link>         (<link linkend="SwfdecGtkPlayer">SwfdecGtkPlayer</link> *player);
<link linkend="void">void</link>                <link linkend="swfdec-gtk-player-set-speed">swfdec_gtk_player_set_speed</link>         (<link linkend="SwfdecGtkPlayer">SwfdecGtkPlayer</link> *player,
                                                         <link linkend="double">double</link> speed);
<link linkend="gboolean">gboolean</link>            <link linkend="swfdec-gtk-player-get-audio-enabled">swfdec_gtk_player_get_audio_enabled</link> (<link linkend="SwfdecGtkPlayer">SwfdecGtkPlayer</link> *player);
<link linkend="void">void</link>                <link linkend="swfdec-gtk-player-set-audio-enabled">swfdec_gtk_player_set_audio_enabled</link> (<link linkend="SwfdecGtkPlayer">SwfdecGtkPlayer</link> *player,
                                                         <link linkend="gboolean">gboolean</link> enabled);

</synopsis>
</refsynopsisdiv>

<refsect1 role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>

  <link linkend="GObject">GObject</link>
   +----<link linkend="SwfdecAsContext">SwfdecAsContext</link>
         +----<link linkend="SwfdecPlayer">SwfdecPlayer</link>
               +----SwfdecGtkPlayer
</synopsis>

</refsect1>





<refsect1 role="properties">
<title role="properties.title">Properties</title>
<synopsis>

  &quot;<link linkend="SwfdecGtkPlayer--audio-enabled">audio-enabled</link>&quot;            <link linkend="gboolean">gboolean</link>              : Read / Write
  &quot;<link linkend="SwfdecGtkPlayer--playing">playing</link>&quot;                  <link linkend="gboolean">gboolean</link>              : Read / Write
  &quot;<link linkend="SwfdecGtkPlayer--speed">speed</link>&quot;                    <link linkend="gdouble">gdouble</link>               : Read / Write
</synopsis>
</refsect1>



<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
The <link linkend="SwfdecGtkPlayer"><type>SwfdecGtkPlayer</type></link> adds common functionality to the rather barebones 
<link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link> class, such as automatic playback and audio handling. Note 
that by default, the player will be paused, so you need to call 
<link linkend="swfdec-gtk-player-set-playing"><function>swfdec_gtk_player_set_playing()</function></link> on the new player.
</para>
<para>
<parameter>see_also</parameter>: SwfdecPlayer</para>
<para>

</para>
</refsect1>

<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="SwfdecGtkPlayer-struct" role="struct"/>SwfdecGtkPlayer</title>
<indexterm><primary>SwfdecGtkPlayer</primary></indexterm><programlisting>typedef struct _SwfdecGtkPlayer SwfdecGtkPlayer;</programlisting>
<para>
The structure for the Swfdec Gtk player contains no public fields.</para>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="swfdec-gtk-player-new" role="function"/>swfdec_gtk_player_new ()</title>
<indexterm><primary>swfdec_gtk_player_new</primary></indexterm><programlisting><link linkend="SwfdecPlayer">SwfdecPlayer</link>*       swfdec_gtk_player_new               (<link linkend="SwfdecAsDebugger">SwfdecAsDebugger</link> *debugger);</programlisting>
<para>
Creates a new Swfdec Gtk player.
This function calls <link linkend="swfdec-init"><function>swfdec_init()</function></link> for you if it wasn't called before.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>debugger</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="NULL:CAPS"><literal>NULL</literal></link> or a <link linkend="SwfdecAsDebugger"><type>SwfdecAsDebugger</type></link> to debug this player
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The new player
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-gtk-player-new-from-uri" role="function"/>swfdec_gtk_player_new_from_uri ()</title>
<indexterm><primary>swfdec_gtk_player_new_from_uri</primary></indexterm><programlisting><link linkend="SwfdecPlayer">SwfdecPlayer</link>*       swfdec_gtk_player_new_from_uri      (const <link linkend="char">char</link> *uri);</programlisting>
<para>
Create a player to play back the given URI. If compiled with gnome-vfs
support, it will use gnome-vfs to resolve the given URI. Note that there
is no way to figure out if the referenced URI really references a file that
Swfdec can play back. If you need this, you should use <link linkend="SwfdecGtkLoader"><type>SwfdecGtkLoader</type></link>
directly and use its error property.
This function calls <link linkend="swfdec-init"><function>swfdec_init()</function></link> for you if it wasn't called before.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>uri</parameter>&nbsp;:</term>
<listitem><simpara> URI to play
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new player.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-gtk-player-get-playing" role="function"/>swfdec_gtk_player_get_playing ()</title>
<indexterm><primary>swfdec_gtk_player_get_playing</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            swfdec_gtk_player_get_playing       (<link linkend="SwfdecGtkPlayer">SwfdecGtkPlayer</link> *player);</programlisting>
<para>
Queries if the player is playing.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecGtkPlayer"><type>SwfdecGtkPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the player is playing
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-gtk-player-set-playing" role="function"/>swfdec_gtk_player_set_playing ()</title>
<indexterm><primary>swfdec_gtk_player_set_playing</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_gtk_player_set_playing       (<link linkend="SwfdecGtkPlayer">SwfdecGtkPlayer</link> *player,
                                                         <link linkend="gboolean">gboolean</link> playing);</programlisting>
<para>
Sets if <parameter>player</parameter> should be playing or not. If the player is playing, a timer 
will be attached to the default main loop that periodically calls 
<link linkend="swfdec-player-advance"><function>swfdec_player_advance()</function></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecGtkPlayer"><type>SwfdecGtkPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>playing</parameter>&nbsp;:</term>
<listitem><simpara> if the player should play or not
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-gtk-player-get-speed" role="function"/>swfdec_gtk_player_get_speed ()</title>
<indexterm><primary>swfdec_gtk_player_get_speed</primary></indexterm><programlisting><link linkend="double">double</link>              swfdec_gtk_player_get_speed         (<link linkend="SwfdecGtkPlayer">SwfdecGtkPlayer</link> *player);</programlisting>
<para>
Queries the current playback speed. If the player is currently paused, it
will report the speed that it would use if playing.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecGtkPlayer"><type>SwfdecGtkPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the current playback speed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-gtk-player-set-speed" role="function"/>swfdec_gtk_player_set_speed ()</title>
<indexterm><primary>swfdec_gtk_player_set_speed</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_gtk_player_set_speed         (<link linkend="SwfdecGtkPlayer">SwfdecGtkPlayer</link> *player,
                                                         <link linkend="double">double</link> speed);</programlisting>
<para>
Sets the new playback speed. 1.0 means the default speed, bigger values
make playback happen faster. Audio will only play back if the speed is 
1.0. Note that if the player is not playing when calling this function,
it will not automatically start.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecGtkPlayer"><type>SwfdecGtkPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>speed</parameter>&nbsp;:</term>
<listitem><simpara> the new playback speed
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-gtk-player-get-audio-enabled" role="function"/>swfdec_gtk_player_get_audio_enabled ()</title>
<indexterm><primary>swfdec_gtk_player_get_audio_enabled</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            swfdec_gtk_player_get_audio_enabled (<link linkend="SwfdecGtkPlayer">SwfdecGtkPlayer</link> *player);</programlisting>
<para>
Queries if audio playback for <parameter>player</parameter> is enabled or not.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecGtkPlayer"><type>SwfdecGtkPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if audio playback is enabled
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-gtk-player-set-audio-enabled" role="function"/>swfdec_gtk_player_set_audio_enabled ()</title>
<indexterm><primary>swfdec_gtk_player_set_audio_enabled</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_gtk_player_set_audio_enabled (<link linkend="SwfdecGtkPlayer">SwfdecGtkPlayer</link> *player,
                                                         <link linkend="gboolean">gboolean</link> enabled);</programlisting>
<para>
Enables or disables automatic audio playback.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>player</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecGtkPlayer"><type>SwfdecGtkPlayer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>enabled</parameter>&nbsp;:</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to enable audio
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="SwfdecGtkPlayer--audio-enabled"/>The <literal>&quot;audio-enabled&quot;</literal> property</title>
<indexterm><primary>SwfdecGtkPlayer:audio-enabled</primary></indexterm><programlisting>  &quot;audio-enabled&quot;            <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
<para>TRUE if automatic audio handling is enabled.</para><para>Default value: TRUE</para>
</refsect2>
<refsect2><title><anchor id="SwfdecGtkPlayer--playing"/>The <literal>&quot;playing&quot;</literal> property</title>
<indexterm><primary>SwfdecGtkPlayer:playing</primary></indexterm><programlisting>  &quot;playing&quot;                  <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
<para>TRUE if the player is playing (d'oh).</para><para>Default value: FALSE</para>
</refsect2>
<refsect2><title><anchor id="SwfdecGtkPlayer--speed"/>The <literal>&quot;speed&quot;</literal> property</title>
<indexterm><primary>SwfdecGtkPlayer:speed</primary></indexterm><programlisting>  &quot;speed&quot;                    <link linkend="gdouble">gdouble</link>               : Read / Write</programlisting>
<para>desired playback speed.</para><para>Allowed values: &gt;= G_MINDOUBLE</para>
<para>Default value: 1</para>
</refsect2>

</refsect1>





<refsect1><refsect2 /><refsect2 /></refsect1>
</refentry>