swfdecbuffer.xml

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

<para>
Tries to create a buffer for the given <parameter>filename</parameter> using a <link linkend="GMappedFile"><type>GMappedFile</type></link>. If
the creation fails, <link linkend="NULL:CAPS"><literal>NULL</literal></link> is returned and <parameter>error</parameter> is set. The error can be
any of the errors that are valid from <link linkend="g-mapped-file-new"><function>g_mapped_file_new()</function></link>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>filename</parameter>&nbsp;:</term>
<listitem><simpara> file to read
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>error</parameter>&nbsp;:</term>
<listitem><simpara> return location for a <link linkend="GError"><type>GError</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="SwfdecBuffer"><type>SwfdecBuffer</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link> on failure
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-buffer-ref" role="function"/>swfdec_buffer_ref ()</title>
<indexterm><primary>swfdec_buffer_ref</primary></indexterm><programlisting><link linkend="SwfdecBuffer">SwfdecBuffer</link>*       swfdec_buffer_ref                   (<link linkend="SwfdecBuffer">SwfdecBuffer</link> *buffer);</programlisting>
<para>
increases the reference count of <parameter>buffer</parameter> by one.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>buffer</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecBuffer"><type>SwfdecBuffer</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The passed in <parameter>buffer</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-buffer-unref" role="function"/>swfdec_buffer_unref ()</title>
<indexterm><primary>swfdec_buffer_unref</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_buffer_unref                 (<link linkend="SwfdecBuffer">SwfdecBuffer</link> *buffer);</programlisting>
<para>
Decreases the reference count of <parameter>buffer</parameter> by one. If no reference to this
buffer exists anymore, the buffer and the memory it manages are freed.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>buffer</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecBuffer"><type>SwfdecBuffer</type></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-buffer-queue-new" role="function"/>swfdec_buffer_queue_new ()</title>
<indexterm><primary>swfdec_buffer_queue_new</primary></indexterm><programlisting><link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link>*  swfdec_buffer_queue_new             (void);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-buffer-queue-clear" role="function"/>swfdec_buffer_queue_clear ()</title>
<indexterm><primary>swfdec_buffer_queue_clear</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_buffer_queue_clear           (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>queue</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-buffer-queue-free" role="function"/>swfdec_buffer_queue_free ()</title>
<indexterm><primary>swfdec_buffer_queue_free</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_buffer_queue_free            (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>queue</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-buffer-queue-get-depth" role="function"/>swfdec_buffer_queue_get_depth ()</title>
<indexterm><primary>swfdec_buffer_queue_get_depth</primary></indexterm><programlisting><link linkend="int">int</link>                 swfdec_buffer_queue_get_depth       (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>queue</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-buffer-queue-get-offset" role="function"/>swfdec_buffer_queue_get_offset ()</title>
<indexterm><primary>swfdec_buffer_queue_get_offset</primary></indexterm><programlisting><link linkend="int">int</link>                 swfdec_buffer_queue_get_offset      (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>queue</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-buffer-queue-push" role="function"/>swfdec_buffer_queue_push ()</title>
<indexterm><primary>swfdec_buffer_queue_push</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_buffer_queue_push            (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue,
                                                         <link linkend="SwfdecBuffer">SwfdecBuffer</link> *buffer);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>queue</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>buffer</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-buffer-queue-pull" role="function"/>swfdec_buffer_queue_pull ()</title>
<indexterm><primary>swfdec_buffer_queue_pull</primary></indexterm><programlisting><link linkend="SwfdecBuffer">SwfdecBuffer</link>*       swfdec_buffer_queue_pull            (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue,
                                                         unsigned <link linkend="int">int</link> length);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>queue</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>length</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-buffer-queue-pull-buffer" role="function"/>swfdec_buffer_queue_pull_buffer ()</title>
<indexterm><primary>swfdec_buffer_queue_pull_buffer</primary></indexterm><programlisting><link linkend="SwfdecBuffer">SwfdecBuffer</link>*       swfdec_buffer_queue_pull_buffer     (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>queue</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="swfdec-buffer-queue-peek" role="function"/>swfdec_buffer_queue_peek ()</title>
<indexterm><primary>swfdec_buffer_queue_peek</primary></indexterm><programlisting><link linkend="SwfdecBuffer">SwfdecBuffer</link>*       swfdec_buffer_queue_peek            (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue,
                                                         unsigned <link linkend="int">int</link> length);</programlisting>
<para>
Creates a new buffer with the first <parameter>length</parameter> bytes from <parameter>queue</parameter>, but unlike 
<link linkend="swfdec-buffer-queue-pull"><function>swfdec_buffer_queue_pull()</function></link>, does not remove them from <parameter>queue</parameter>.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>queue</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="SwfdecBufferQueue"><type>SwfdecBufferQueue</type></link> to read from
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>length</parameter>&nbsp;:</term>
<listitem><simpara> amount of bytes to peek
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> NULL if the requested amount of data wasn't available or a new 
         readonly <link linkend="SwfdecBuffer"><type>SwfdecBuffer</type></link>. Use <link linkend="swfdec-buffer-unref"><function>swfdec_buffer_unref()</function></link> after use.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>