swfdecplayer.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="SwfdecPlayer">
<refmeta>
<refentrytitle role="top_of_page">SwfdecPlayer</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>SWFDEC Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>SwfdecPlayer</refname>
<refpurpose>main playback object</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

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

<synopsis>



                    <link linkend="SwfdecPlayer-struct">SwfdecPlayer</link>;
<link linkend="void">void</link>                <link linkend="swfdec-init">swfdec_init</link>                         (void);
<link linkend="SwfdecPlayer">SwfdecPlayer</link>*       <link linkend="swfdec-player-new">swfdec_player_new</link>                   (<link linkend="SwfdecAsDebugger">SwfdecAsDebugger</link> *debugger);
<link linkend="SwfdecPlayer">SwfdecPlayer</link>*       <link linkend="swfdec-player-new-from-file">swfdec_player_new_from_file</link>         (const <link linkend="char">char</link> *filename);
<link linkend="void">void</link>                <link linkend="swfdec-player-set-loader">swfdec_player_set_loader</link>            (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="SwfdecLoader">SwfdecLoader</link> *loader);
<link linkend="void">void</link>                <link linkend="swfdec-player-set-loader-with-variables">swfdec_player_set_loader_with_variables</link>
                                                        (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="SwfdecLoader">SwfdecLoader</link> *loader,
                                                         const <link linkend="char">char</link> *variables);
<link linkend="gboolean">gboolean</link>            <link linkend="swfdec-player-is-initialized">swfdec_player_is_initialized</link>        (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player);
<link linkend="double">double</link>              <link linkend="swfdec-player-get-rate">swfdec_player_get_rate</link>              (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player);
<link linkend="void">void</link>                <link linkend="swfdec-player-get-image-size">swfdec_player_get_image_size</link>        (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="int">int</link> *width,
                                                         <link linkend="int">int</link> *height);
<link linkend="void">void</link>                <link linkend="swfdec-player-get-size">swfdec_player_get_size</link>              (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="int">int</link> *width,
                                                         <link linkend="int">int</link> *height);
<link linkend="void">void</link>                <link linkend="swfdec-player-set-size">swfdec_player_set_size</link>              (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="int">int</link> width,
                                                         <link linkend="int">int</link> height);
<link linkend="guint">guint</link>               <link linkend="swfdec-player-get-next-event">swfdec_player_get_next_event</link>        (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player);
<link linkend="guint">guint</link>               <link linkend="swfdec-player-get-background-color">swfdec_player_get_background_color</link>  (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player);
<link linkend="void">void</link>                <link linkend="swfdec-player-set-background-color">swfdec_player_set_background_color</link>  (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="guint">guint</link> color);
<link linkend="SwfdecScaleMode">SwfdecScaleMode</link>     <link linkend="swfdec-player-get-scale-mode">swfdec_player_get_scale_mode</link>        (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player);
<link linkend="void">void</link>                <link linkend="swfdec-player-set-scale-mode">swfdec_player_set_scale_mode</link>        (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="SwfdecScaleMode">SwfdecScaleMode</link> mode);
<link linkend="SwfdecAlignment">SwfdecAlignment</link>     <link linkend="swfdec-player-get-alignment">swfdec_player_get_alignment</link>         (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player);
<link linkend="void">void</link>                <link linkend="swfdec-player-set-alignment">swfdec_player_set_alignment</link>         (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="SwfdecAlignment">SwfdecAlignment</link> align);
<link linkend="void">void</link>                <link linkend="swfdec-player-render">swfdec_player_render</link>                (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="cairo-t">cairo_t</link> *cr,
                                                         <link linkend="double">double</link> x,
                                                         <link linkend="double">double</link> y,
                                                         <link linkend="double">double</link> width,
                                                         <link linkend="double">double</link> height);
<link linkend="void">void</link>                <link linkend="swfdec-player-advance">swfdec_player_advance</link>               (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="guint">guint</link> msecs);
<link linkend="gboolean">gboolean</link>            <link linkend="swfdec-player-handle-mouse">swfdec_player_handle_mouse</link>          (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="double">double</link> x,
                                                         <link linkend="double">double</link> y,
                                                         <link linkend="int">int</link> button);
<link linkend="gboolean">gboolean</link>            <link linkend="swfdec-player-key-press">swfdec_player_key_press</link>             (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="guint">guint</link> keycode,
                                                         <link linkend="guint">guint</link> character);
<link linkend="gboolean">gboolean</link>            <link linkend="swfdec-player-key-release">swfdec_player_key_release</link>           (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="guint">guint</link> keycode,
                                                         <link linkend="guint">guint</link> character);
<link linkend="void">void</link>                <link linkend="swfdec-player-render-audio">swfdec_player_render_audio</link>          (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player,
                                                         <link linkend="gint16">gint16</link> *dest,
                                                         <link linkend="guint">guint</link> start_offset,
                                                         <link linkend="guint">guint</link> n_samples);
const <link linkend="GList">GList</link>*        <link linkend="swfdec-player-get-audio">swfdec_player_get_audio</link>             (<link linkend="SwfdecPlayer">SwfdecPlayer</link> *player);

</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>
         +----SwfdecPlayer
               +----<link linkend="SwfdecGtkPlayer">SwfdecGtkPlayer</link>
</synopsis>

</refsect1>





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

  &quot;<link linkend="SwfdecPlayer--alignment">alignment</link>&quot;                <link linkend="SwfdecAlignment">SwfdecAlignment</link>       : Read / Write
  &quot;<link linkend="SwfdecPlayer--background-color">background-color</link>&quot;         <link linkend="guint">guint</link>                 : Read / Write
  &quot;<link linkend="SwfdecPlayer--cache-size">cache-size</link>&quot;               <link linkend="guint">guint</link>                 : Read
  &quot;<link linkend="SwfdecPlayer--height">height</link>&quot;                   <link linkend="gint">gint</link>                  : Read / Write
  &quot;<link linkend="SwfdecPlayer--initialized">initialized</link>&quot;              <link linkend="gboolean">gboolean</link>              : Read
  &quot;<link linkend="SwfdecPlayer--mouse-cursor">mouse-cursor</link>&quot;             <link linkend="SwfdecMouseCursor">SwfdecMouseCursor</link>     : Read
  &quot;<link linkend="SwfdecPlayer--next-event">next-event</link>&quot;               <link linkend="guint">guint</link>                 : Read
  &quot;<link linkend="SwfdecPlayer--scale-mode">scale-mode</link>&quot;               <link linkend="SwfdecScaleMode">SwfdecScaleMode</link>       : Read / Write
  &quot;<link linkend="SwfdecPlayer--width">width</link>&quot;                    <link linkend="gint">gint</link>                  : Read / Write
</synopsis>
</refsect1>

<refsect1 role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>

  &quot;<link linkend="SwfdecPlayer-advance">advance</link>&quot;                                        : Run Last
  &quot;<link linkend="SwfdecPlayer-audio-added">audio-added</link>&quot;                                    : Run Last
  &quot;<link linkend="SwfdecPlayer-audio-removed">audio-removed</link>&quot;                                  : Run Last
  &quot;<link linkend="SwfdecPlayer-fscommand">fscommand</link>&quot;                                      : Run Last
  &quot;<link linkend="SwfdecPlayer-handle-key">handle-key</link>&quot;                                     : Run Last
  &quot;<link linkend="SwfdecPlayer-handle-mouse">handle-mouse</link>&quot;                                   : Run Last
  &quot;<link linkend="SwfdecPlayer-invalidate">invalidate</link>&quot;                                     : Run Last
  &quot;<link linkend="SwfdecPlayer-launch">launch</link>&quot;                                         : Run Last
</synopsis>
</refsect1>


<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
A <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link> is the main object used for playing back Flash files through
Swfdec.
</para>
<para>
A player interacts with the outside world in a multitude of ways. The most 
important ones are described below.
</para>
<para>
Input is handled via the 
<link linkend="swfdec-SwfdecLoader">SwfdecLoader</link> class. A 
<link linkend="SwfdecLoader"><type>SwfdecLoader</type></link> is set on a new player using <link linkend="swfdec-player-set-loader"><function>swfdec_player_set_loader()</function></link>.
</para>
<para>
When the loader has provided enough data, you can start playing the file.
This is done in steps by calling <link linkend="swfdec-player-advance"><function>swfdec_player_advance()</function></link> - preferrably as 
often as <link linkend="swfdec-player-get-next-event"><function>swfdec_player_get_next_event()</function></link> indicates. Or you can provide user input
to the player by calling for example <link linkend="swfdec-player-handle-mouse"><function>swfdec_player_handle_mouse()</function></link>.
</para>
<para>
You can use <link linkend="swfdec-player-render"><function>swfdec_player_render()</function></link> to draw the current state of the player.
After that, connect to the SwfdecPlayer::invalidate signal to be notified of
changes.
</para>
<para>
Audio output is handled via the 
<link linkend="swfdec-SwfdecAudio">SwfdecAudio</link> class. One 
<link linkend="SwfdecAudio"><type>SwfdecAudio</type></link> object is created for every output using the 
SwfdecPlayer::audio-added signal.</para>
<para>

</para>
</refsect1>

<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="SwfdecPlayer-struct" role="struct"/>SwfdecPlayer</title>
<indexterm><primary>SwfdecPlayer</primary></indexterm><programlisting>typedef struct _SwfdecPlayer SwfdecPlayer;</programlisting>
<para>
This is the base object used for playing Flash files.</para>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="swfdec-init" role="function"/>swfdec_init ()</title>
<indexterm><primary>swfdec_init</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_init                         (void);</programlisting>
<para>
Initializes the Swfdec library.</para>
<para>

</para></refsect2>