swfdec-swfdecbuffer.html

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

</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2606951"></a><h3>
<a name="swfdec-buffer-queue-unref"></a>swfdec_buffer_queue_unref ()</h3>
<a class="indexterm" name="id2606963"></a><pre class="programlisting">void                swfdec_buffer_queue_unref           (<a href="swfdec-SwfdecBuffer.html#SwfdecBufferQueue">SwfdecBufferQueue</a> *queue);</pre>
<p>
Decreases the reference count of <em class="parameter"><code>queue</code></em> by one. If no reference 
to this buffer exists anymore, the buffer and the memory 
it manages are freed.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>queue</code></em>&#160;:</span></td>
<td> a <a href="swfdec-SwfdecBuffer.html#SwfdecBufferQueue"><span class="type">SwfdecBufferQueue</span></a>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2607028"></a><h3>
<a name="swfdec-buffer-queue-get-depth"></a>swfdec_buffer_queue_get_depth ()</h3>
<a class="indexterm" name="id2607041"></a><pre class="programlisting">guint               swfdec_buffer_queue_get_depth       (<a href="swfdec-SwfdecBuffer.html#SwfdecBufferQueue">SwfdecBufferQueue</a> *queue);</pre>
<p>
Returns the number of bytes currently in <em class="parameter"><code>queue</code></em>.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>queue</code></em>&#160;:</span></td>
<td> a <a href="swfdec-SwfdecBuffer.html#SwfdecBufferQueue"><span class="type">SwfdecBufferQueue</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> amount of bytes in <em class="parameter"><code>queue</code></em>.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2607122"></a><h3>
<a name="swfdec-buffer-queue-get-offset"></a>swfdec_buffer_queue_get_offset ()</h3>
<a class="indexterm" name="id2607135"></a><pre class="programlisting">guint               swfdec_buffer_queue_get_offset      (<a href="swfdec-SwfdecBuffer.html#SwfdecBufferQueue">SwfdecBufferQueue</a> *queue);</pre>
<p>
Queries the amount of bytes that has already been pulled out of
<em class="parameter"><code>queue</code></em> using functions like <a href="swfdec-SwfdecBuffer.html#swfdec-buffer-queue-pull"><code class="function">swfdec_buffer_queue_pull()</code></a>.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>queue</code></em>&#160;:</span></td>
<td> a <a href="swfdec-SwfdecBuffer.html#SwfdecBufferQueue"><span class="type">SwfdecBufferQueue</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> Number of bytes that were already pulled from this queue.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2607220"></a><h3>
<a name="swfdec-buffer-queue-push"></a>swfdec_buffer_queue_push ()</h3>
<a class="indexterm" name="id2607231"></a><pre class="programlisting">void                swfdec_buffer_queue_push            (<a href="swfdec-SwfdecBuffer.html#SwfdecBufferQueue">SwfdecBufferQueue</a> *queue,
                                                         <a href="swfdec-SwfdecBuffer.html#SwfdecBuffer">SwfdecBuffer</a> *buffer);</pre>
<p>
Appends the given <em class="parameter"><code>buffer</code></em> to the buffers already in <em class="parameter"><code>queue</code></em>. This function
will take ownership of the given <em class="parameter"><code>buffer</code></em>. Use <a href="swfdec-SwfdecBuffer.html#swfdec-buffer-ref"><code class="function">swfdec_buffer_ref()</code></a> before
calling this function to keep a reference.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>queue</code></em>&#160;:</span></td>
<td> a <a href="swfdec-SwfdecBuffer.html#SwfdecBufferQueue"><span class="type">SwfdecBufferQueue</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>buffer</code></em>&#160;:</span></td>
<td> <a href="swfdec-SwfdecBuffer.html#SwfdecBuffer"><span class="type">SwfdecBuffer</span></a> to append to <em class="parameter"><code>queue</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2607352"></a><h3>
<a name="swfdec-buffer-queue-pull"></a>swfdec_buffer_queue_pull ()</h3>
<a class="indexterm" name="id2607363"></a><pre class="programlisting"><a href="swfdec-SwfdecBuffer.html#SwfdecBuffer">SwfdecBuffer</a>*       swfdec_buffer_queue_pull            (<a href="swfdec-SwfdecBuffer.html#SwfdecBufferQueue">SwfdecBufferQueue</a> *queue,
                                                         guint length);</pre>
<p>
If enough data is still available in <em class="parameter"><code>queue</code></em>, the first <em class="parameter"><code>length</code></em> bytes are 
put into a new buffer and that buffer is returned. The <em class="parameter"><code>length</code></em> bytes are
removed from the head of the queue. If not enough data is available, <code class="literal">NULL</code>
is returned.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>queue</code></em>&#160;:</span></td>
<td> a <a href="swfdec-SwfdecBuffer.html#SwfdecBufferQueue"><span class="type">SwfdecBufferQueue</span></a>
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>length</code></em>&#160;:</span></td>
<td> amount of bytes to pull
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a new <a href="swfdec-SwfdecBuffer.html#SwfdecBuffer"><span class="type">SwfdecBuffer</span></a> or <code class="literal">NULL</code>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2607499"></a><h3>
<a name="swfdec-buffer-queue-pull-buffer"></a>swfdec_buffer_queue_pull_buffer ()</h3>
<a class="indexterm" name="id2607512"></a><pre class="programlisting"><a href="swfdec-SwfdecBuffer.html#SwfdecBuffer">SwfdecBuffer</a>*       swfdec_buffer_queue_pull_buffer     (<a href="swfdec-SwfdecBuffer.html#SwfdecBufferQueue">SwfdecBufferQueue</a> *queue);</pre>
<p>
Pulls the first buffer out of <em class="parameter"><code>queue</code></em> and returns it. This function is 
equivalent to calling <a href="swfdec-SwfdecBuffer.html#swfdec-buffer-queue-pull"><code class="function">swfdec_buffer_queue_pull()</code></a> with the size of the
first buffer in it.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>queue</code></em>&#160;:</span></td>
<td> a <a href="swfdec-SwfdecBuffer.html#SwfdecBufferQueue"><span class="type">SwfdecBufferQueue</span></a>
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> The first buffer in <em class="parameter"><code>queue</code></em> or <code class="literal">NULL</code> if <em class="parameter"><code>queue</code></em> is empty.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id2607618"></a><h3>
<a name="swfdec-buffer-queue-peek"></a>swfdec_buffer_queue_peek ()</h3>
<a class="indexterm" name="id2607629"></a><pre class="programlisting"><a href="swfdec-SwfdecBuffer.html#SwfdecBuffer">SwfdecBuffer</a>*       swfdec_buffer_queue_peek            (<a href="swfdec-SwfdecBuffer.html#SwfdecBufferQueue">SwfdecBufferQueue</a> *queue,
                                                         guint length);</pre>
<p>
Creates a new buffer with the first <em class="parameter"><code>length</code></em> bytes from <em class="parameter"><code>queue</code></em>, but unlike 
<a href="swfdec-SwfdecBuffer.html#swfdec-buffer-queue-pull"><code class="function">swfdec_buffer_queue_pull()</code></a>, does not remove them from <em class="parameter"><code>queue</code></em>.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><span class="term"><em class="parameter"><code>queue</code></em>&#160;:</span></td>
<td> a <a href="swfdec-SwfdecBuffer.html#SwfdecBufferQueue"><span class="type">SwfdecBufferQueue</span></a> to read from
</td>
</tr>
<tr>
<td><span class="term"><em class="parameter"><code>length</code></em>&#160;:</span></td>
<td> amount of bytes to peek
</td>
</tr>
<tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> NULL if the requested amount of data wasn't available or a new 
         readonly <a href="swfdec-SwfdecBuffer.html#SwfdecBuffer"><span class="type">SwfdecBuffer</span></a>. Use <a href="swfdec-SwfdecBuffer.html#swfdec-buffer-unref"><code class="function">swfdec_buffer_unref()</code></a> after use.
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id2614470"></a><div class="refsect2" lang="en"><a name="id2614471"></a></div>
<hr>
<div class="refsect2" lang="en"><a name="id2614472"></a></div>
</div>
</div>
</body>
</html>