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

<refnamediv>
<refname>SwfdecAudio</refname>
<refpurpose>object used for audio output</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

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

<synopsis>



                    <link linkend="SwfdecAudio-struct">SwfdecAudio</link>;
<link linkend="void">void</link>                <link linkend="swfdec-audio-render">swfdec_audio_render</link>                 (<link linkend="SwfdecAudio">SwfdecAudio</link> *audio,
                                                         <link linkend="gint16">gint16</link> *dest,
                                                         <link linkend="guint">guint</link> start_offset,
                                                         <link linkend="guint">guint</link> n_samples);

</synopsis>
</refsynopsisdiv>

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

  <link linkend="GObject">GObject</link>
   +----SwfdecAudio
</synopsis>

</refsect1>








<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
SwfdecAudio is the way audio output is provided by a <link linkend="SwfdecPlayer"><type>SwfdecPlayer</type></link>. See
its documentation on how to access <link linkend="SwfdecAudio"><type>SwfdecAudio</type></link> objects.
</para>
<para>
An audio object gives access to one audio stream played inside a player.
You are responsible for outputting this data, swfdec does not try to do this
for you.
</para>
<para>
Audio data is always provided in 16bit host-endian stereo. If the data was
encoded into a different format originally, Swfdec will already have decoded 
it. The data is always referenced relative to the player. Sample 0 
references the first sample to be played at the current position. If the 
player gets iterated, sample 0 changes. There is no way to access samples
belonging to a previous state.</para>
<para>

</para>
</refsect1>

<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="SwfdecAudio-struct" role="struct"/>SwfdecAudio</title>
<indexterm><primary>SwfdecAudio</primary></indexterm><programlisting>typedef struct _SwfdecAudio SwfdecAudio;</programlisting>
<para>
This object is used for audio output. It is an abstract class.</para>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="swfdec-audio-render" role="function"/>swfdec_audio_render ()</title>
<indexterm><primary>swfdec_audio_render</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_audio_render                 (<link linkend="SwfdecAudio">SwfdecAudio</link> *audio,
                                                         <link linkend="gint16">gint16</link> *dest,
                                                         <link linkend="guint">guint</link> start_offset,
                                                         <link linkend="guint">guint</link> n_samples);</programlisting>
<para>
Renders the samples from <parameter>audio</parameter> into the area pointed to by <parameter>dest</parameter>. The data 
is added to <parameter>dest</parameter>, so you probably want to initialize <parameter>dest</parameter> to silence 
before calling this function.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>audio</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecAudio"><type>SwfdecAudio</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>dest</parameter>&nbsp;:</term>
<listitem><simpara> memory area to render to
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>start_offset</parameter>&nbsp;:</term>
<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>

</refsect1>



<refsect1>
<title>See Also</title>
SwfdecPlayer
</refsect1>


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