← Back to branch summary

~ubuntu-branches/ubuntu/intrepid/swfdec0.6/intrepid

« back to all changes in this revision

Viewing changes to doc/xml/SwfdecBuffer.xml

  • Committer: Bazaar Package Importer
  • Author(s): Santiago Garcia Mantinan
  • Date: 2008-07-29 23:30:05 UTC
  • mfrom: (1.1.3 upstream) (3.1.1 lenny)
  • Revision ID: james.westby@ubuntu.com-20080729233005-k05tu7pnfyb8vcog
Tags: 0.6.8-1
* New upstream version. Fixes several crashes.
* Setting urgency as high to try to get all these fixes to lenny.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/xml/SwfdecBuffer.xml
3
3
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
4
<refentry id="swfdec-SwfdecBuffer">
5
5
<refmeta>
6
 
<refentrytitle role="top_of_page">SwfdecBuffer</refentrytitle>
 
6
<refentrytitle role="top_of_page" id="swfdec-SwfdecBuffer.top_of_page">SwfdecBuffer</refentrytitle>
7
7
<manvolnum>3</manvolnum>
8
8
<refmiscinfo>SWFDEC Library</refmiscinfo>
9
9
</refmeta>
14
14
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
15
15
</refnamediv>
16
16
 
17
 
<refsynopsisdiv role="synopsis">
 
17
<refsynopsisdiv id="swfdec-SwfdecBuffer.synopsis" role="synopsis">
18
18
<title role="synopsis.title">Synopsis</title>
19
19
 
20
20
<synopsis>
21
21
 
22
22
#include &lt;swfdec/swfdec.h&gt;
23
23
 
24
 
 
25
24
                    <link linkend="SwfdecBuffer">SwfdecBuffer</link>;
26
25
                    <link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link>;
27
26
<link linkend="void">void</link>                (<link linkend="SwfdecBufferFreeFunc">*SwfdecBufferFreeFunc</link>)             (<link linkend="gpointer">gpointer</link> *priv,
59
58
<link linkend="SwfdecBuffer">SwfdecBuffer</link>*       <link linkend="swfdec-buffer-queue-peek-buffer">swfdec_buffer_queue_peek_buffer</link>     (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue);
60
59
<link linkend="void">void</link>                <link linkend="swfdec-buffer-queue-flush">swfdec_buffer_queue_flush</link>           (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue,
61
60
                                                         <link linkend="gsize">gsize</link> n_bytes);
62
 
 
63
61
</synopsis>
64
62
</refsynopsisdiv>
65
63
 
71
69
 
72
70
 
73
71
 
74
 
<refsect1 role="desc">
 
72
<refsect1 id="swfdec-SwfdecBuffer.description" role="desc">
75
73
<title role="desc.title">Description</title>
76
74
<para>
77
75
This section describes how memory is to be handled when interacting with the 
83
81
</para>
84
82
</refsect1>
85
83
 
86
 
<refsect1 role="details">
 
84
<refsect1 id="swfdec-SwfdecBuffer.details" role="details">
87
85
<title role="details.title">Details</title>
88
 
<refsect2>
89
 
<title><anchor id="SwfdecBuffer" role="struct"/>SwfdecBuffer</title>
90
 
<indexterm><primary>SwfdecBuffer</primary></indexterm><programlisting>typedef struct {
 
86
<refsect2 id="SwfdecBuffer" role="struct">
 
87
<title>SwfdecBuffer</title>
 
88
<indexterm zone="SwfdecBuffer"><primary>SwfdecBuffer</primary></indexterm><programlisting>typedef struct {
91
89
  unsigned char *       data;           /* memory region (consider as read only) */
92
90
  gsize                 length;         /* length of the memory region pointer do by @data */
93
91
} SwfdecBuffer;
115
113
</simpara></listitem>
116
114
</varlistentry>
117
115
</variablelist></refsect2>
118
 
<refsect2>
119
 
<title><anchor id="SwfdecBufferQueue" role="struct"/>SwfdecBufferQueue</title>
120
 
<indexterm><primary>SwfdecBufferQueue</primary></indexterm><programlisting>typedef struct {
 
116
<refsect2 id="SwfdecBufferQueue" role="struct">
 
117
<title>SwfdecBufferQueue</title>
 
118
<indexterm zone="SwfdecBufferQueue"><primary>SwfdecBufferQueue</primary></indexterm><programlisting>typedef struct {
121
119
} SwfdecBufferQueue;
122
120
</programlisting>
123
121
<para>
128
126
<para>
129
127
 
130
128
</para></refsect2>
131
 
<refsect2>
132
 
<title><anchor id="SwfdecBufferFreeFunc" role="function"/>SwfdecBufferFreeFunc ()</title>
133
 
<indexterm><primary>SwfdecBufferFreeFunc</primary></indexterm><programlisting><link linkend="void">void</link>                (*SwfdecBufferFreeFunc)             (<link linkend="gpointer">gpointer</link> *priv,
 
129
<refsect2 id="SwfdecBufferFreeFunc" role="function">
 
130
<title>SwfdecBufferFreeFunc ()</title>
 
131
<indexterm zone="SwfdecBufferFreeFunc"><primary>SwfdecBufferFreeFunc</primary></indexterm><programlisting><link linkend="void">void</link>                (*SwfdecBufferFreeFunc)             (<link linkend="gpointer">gpointer</link> *priv,
134
132
                                                         unsigned <link linkend="char">char</link> *data);</programlisting>
135
133
<para>
136
134
This is the function prototype for the function that is called for freeing
145
143
<listitem><simpara> The data to free
146
144
</simpara></listitem></varlistentry>
147
145
</variablelist></refsect2>
148
 
<refsect2>
149
 
<title><anchor id="swfdec-buffer-new" role="function"/>swfdec_buffer_new ()</title>
150
 
<indexterm><primary>swfdec_buffer_new</primary></indexterm><programlisting><link linkend="SwfdecBuffer">SwfdecBuffer</link>*       swfdec_buffer_new                   (<link linkend="gsize">gsize</link> size);</programlisting>
 
146
<refsect2 id="swfdec-buffer-new" role="function">
 
147
<title>swfdec_buffer_new ()</title>
 
148
<indexterm zone="swfdec-buffer-new"><primary>swfdec_buffer_new</primary></indexterm><programlisting><link linkend="SwfdecBuffer">SwfdecBuffer</link>*       swfdec_buffer_new                   (<link linkend="gsize">gsize</link> size);</programlisting>
151
149
<para>
152
150
Creates a new buffer and allocates new memory of <parameter>size</parameter> bytes to be used with 
153
151
the buffer.</para>
160
158
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="SwfdecBuffer"><type>SwfdecBuffer</type></link> with buffer->data pointing to new data
161
159
</simpara></listitem></varlistentry>
162
160
</variablelist></refsect2>
163
 
<refsect2>
164
 
<title><anchor id="swfdec-buffer-new0" role="function"/>swfdec_buffer_new0 ()</title>
165
 
<indexterm><primary>swfdec_buffer_new0</primary></indexterm><programlisting><link linkend="SwfdecBuffer">SwfdecBuffer</link>*       swfdec_buffer_new0                  (<link linkend="gsize">gsize</link> size);</programlisting>
 
161
<refsect2 id="swfdec-buffer-new0" role="function">
 
162
<title>swfdec_buffer_new0 ()</title>
 
163
<indexterm zone="swfdec-buffer-new0"><primary>swfdec_buffer_new0</primary></indexterm><programlisting><link linkend="SwfdecBuffer">SwfdecBuffer</link>*       swfdec_buffer_new0                  (<link linkend="gsize">gsize</link> size);</programlisting>
166
164
<para>
167
165
Createsa new buffer just like <link linkend="swfdec-buffer-new"><function>swfdec_buffer_new()</function></link>, but ensures 
168
166
that the returned data gets initialized to be 0.</para>
175
173
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="SwfdecBuffer"><type>SwfdecBuffer</type></link> with buffer->data pointing to new data
176
174
</simpara></listitem></varlistentry>
177
175
</variablelist></refsect2>
178
 
<refsect2>
179
 
<title><anchor id="swfdec-buffer-new-full" role="function"/>swfdec_buffer_new_full ()</title>
180
 
<indexterm><primary>swfdec_buffer_new_full</primary></indexterm><programlisting><link linkend="SwfdecBuffer">SwfdecBuffer</link>*       swfdec_buffer_new_full              (unsigned <link linkend="char">char</link> *data,
 
176
<refsect2 id="swfdec-buffer-new-full" role="function">
 
177
<title>swfdec_buffer_new_full ()</title>
 
178
<indexterm zone="swfdec-buffer-new-full"><primary>swfdec_buffer_new_full</primary></indexterm><programlisting><link linkend="SwfdecBuffer">SwfdecBuffer</link>*       swfdec_buffer_new_full              (unsigned <link linkend="char">char</link> *data,
181
179
                                                         <link linkend="gsize">gsize</link> size,
182
180
                                                         <link linkend="SwfdecBufferFreeFunc">SwfdecBufferFreeFunc</link> free_func,
183
181
                                                         <link linkend="gpointer">gpointer</link> priv);</programlisting>
203
201
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="SwfdecBuffer"><type>SwfdecBuffer</type></link> pointing to <parameter>data</parameter>
204
202
</simpara></listitem></varlistentry>
205
203
</variablelist></refsect2>
206
 
<refsect2>
207
 
<title><anchor id="swfdec-buffer-new-static" role="macro"/>swfdec_buffer_new_static()</title>
208
 
<indexterm><primary>swfdec_buffer_new_static</primary></indexterm><programlisting>#define             swfdec_buffer_new_static(data, size)</programlisting>
 
204
<refsect2 id="swfdec-buffer-new-static" role="macro">
 
205
<title>swfdec_buffer_new_static()</title>
 
206
<indexterm zone="swfdec-buffer-new-static"><primary>swfdec_buffer_new_static</primary></indexterm><programlisting>#define             swfdec_buffer_new_static(data, size)</programlisting>
209
207
<para>
210
208
Creates a buffer for static data.</para>
211
209
<para>
218
216
<listitem><simpara> size of <parameter>data</parameter> in bytes
219
217
</simpara></listitem></varlistentry>
220
218
</variablelist></refsect2>
221
 
<refsect2>
222
 
<title><anchor id="swfdec-buffer-new-for-data" role="function"/>swfdec_buffer_new_for_data ()</title>
223
 
<indexterm><primary>swfdec_buffer_new_for_data</primary></indexterm><programlisting><link linkend="SwfdecBuffer">SwfdecBuffer</link>*       swfdec_buffer_new_for_data          (unsigned <link linkend="char">char</link> *data,
 
219
<refsect2 id="swfdec-buffer-new-for-data" role="function">
 
220
<title>swfdec_buffer_new_for_data ()</title>
 
221
<indexterm zone="swfdec-buffer-new-for-data"><primary>swfdec_buffer_new_for_data</primary></indexterm><programlisting><link linkend="SwfdecBuffer">SwfdecBuffer</link>*       swfdec_buffer_new_for_data          (unsigned <link linkend="char">char</link> *data,
224
222
                                                         <link linkend="gsize">gsize</link> size);</programlisting>
225
223
<para>
226
224
Takes ownership of <parameter>data</parameter> and creates a new buffer managing it.</para>
236
234
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="SwfdecBuffer"><type>SwfdecBuffer</type></link> pointing to <parameter>data</parameter>
237
235
</simpara></listitem></varlistentry>
238
236
</variablelist></refsect2>
239
 
<refsect2>
240
 
<title><anchor id="swfdec-buffer-new-subbuffer" role="function"/>swfdec_buffer_new_subbuffer ()</title>
241
 
<indexterm><primary>swfdec_buffer_new_subbuffer</primary></indexterm><programlisting><link linkend="SwfdecBuffer">SwfdecBuffer</link>*       swfdec_buffer_new_subbuffer         (<link linkend="SwfdecBuffer">SwfdecBuffer</link> *buffer,
 
237
<refsect2 id="swfdec-buffer-new-subbuffer" role="function">
 
238
<title>swfdec_buffer_new_subbuffer ()</title>
 
239
<indexterm zone="swfdec-buffer-new-subbuffer"><primary>swfdec_buffer_new_subbuffer</primary></indexterm><programlisting><link linkend="SwfdecBuffer">SwfdecBuffer</link>*       swfdec_buffer_new_subbuffer         (<link linkend="SwfdecBuffer">SwfdecBuffer</link> *buffer,
242
240
                                                         <link linkend="gsize">gsize</link> offset,
243
241
                                                         <link linkend="gsize">gsize</link> length);</programlisting>
244
242
<para>
259
257
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new <link linkend="SwfdecBuffer"><type>SwfdecBuffer</type></link> managing the indicated region.
260
258
</simpara></listitem></varlistentry>
261
259
</variablelist></refsect2>
262
 
<refsect2>
263
 
<title><anchor id="swfdec-buffer-new-from-file" role="function"/>swfdec_buffer_new_from_file ()</title>
264
 
<indexterm><primary>swfdec_buffer_new_from_file</primary></indexterm><programlisting><link linkend="SwfdecBuffer">SwfdecBuffer</link>*       swfdec_buffer_new_from_file         (const <link linkend="char">char</link> *filename,
 
260
<refsect2 id="swfdec-buffer-new-from-file" role="function">
 
261
<title>swfdec_buffer_new_from_file ()</title>
 
262
<indexterm zone="swfdec-buffer-new-from-file"><primary>swfdec_buffer_new_from_file</primary></indexterm><programlisting><link linkend="SwfdecBuffer">SwfdecBuffer</link>*       swfdec_buffer_new_from_file         (const <link linkend="char">char</link> *filename,
265
263
                                                         <link linkend="GError">GError</link> **error);</programlisting>
266
264
<para>
267
265
Creates a buffer containing the contents of the given file. If loading the
279
277
<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
280
278
</simpara></listitem></varlistentry>
281
279
</variablelist></refsect2>
282
 
<refsect2>
283
 
<title><anchor id="swfdec-buffer-ref" role="function"/>swfdec_buffer_ref ()</title>
284
 
<indexterm><primary>swfdec_buffer_ref</primary></indexterm><programlisting><link linkend="SwfdecBuffer">SwfdecBuffer</link>*       swfdec_buffer_ref                   (<link linkend="SwfdecBuffer">SwfdecBuffer</link> *buffer);</programlisting>
 
280
<refsect2 id="swfdec-buffer-ref" role="function">
 
281
<title>swfdec_buffer_ref ()</title>
 
282
<indexterm zone="swfdec-buffer-ref"><primary>swfdec_buffer_ref</primary></indexterm><programlisting><link linkend="SwfdecBuffer">SwfdecBuffer</link>*       swfdec_buffer_ref                   (<link linkend="SwfdecBuffer">SwfdecBuffer</link> *buffer);</programlisting>
285
283
<para>
286
284
increases the reference count of <parameter>buffer</parameter> by one.</para>
287
285
<para>
293
291
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The passed in <parameter>buffer</parameter>.
294
292
</simpara></listitem></varlistentry>
295
293
</variablelist></refsect2>
296
 
<refsect2>
297
 
<title><anchor id="swfdec-buffer-unref" role="function"/>swfdec_buffer_unref ()</title>
298
 
<indexterm><primary>swfdec_buffer_unref</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_buffer_unref                 (<link linkend="SwfdecBuffer">SwfdecBuffer</link> *buffer);</programlisting>
 
294
<refsect2 id="swfdec-buffer-unref" role="function">
 
295
<title>swfdec_buffer_unref ()</title>
 
296
<indexterm zone="swfdec-buffer-unref"><primary>swfdec_buffer_unref</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_buffer_unref                 (<link linkend="SwfdecBuffer">SwfdecBuffer</link> *buffer);</programlisting>
299
297
<para>
300
298
Decreases the reference count of <parameter>buffer</parameter> by one. If no reference to this
301
299
buffer exists anymore, the buffer and the memory it manages are freed.</para>
306
304
<listitem><simpara> a <link linkend="SwfdecBuffer"><type>SwfdecBuffer</type></link>
307
305
</simpara></listitem></varlistentry>
308
306
</variablelist></refsect2>
309
 
<refsect2>
310
 
<title><anchor id="swfdec-buffer-get-super" role="function"/>swfdec_buffer_get_super ()</title>
311
 
<indexterm><primary>swfdec_buffer_get_super</primary></indexterm><programlisting><link linkend="SwfdecBuffer">SwfdecBuffer</link>*       swfdec_buffer_get_super             (<link linkend="SwfdecBuffer">SwfdecBuffer</link> *buffer);</programlisting>
 
307
<refsect2 id="swfdec-buffer-get-super" role="function">
 
308
<title>swfdec_buffer_get_super ()</title>
 
309
<indexterm zone="swfdec-buffer-get-super"><primary>swfdec_buffer_get_super</primary></indexterm><programlisting><link linkend="SwfdecBuffer">SwfdecBuffer</link>*       swfdec_buffer_get_super             (<link linkend="SwfdecBuffer">SwfdecBuffer</link> *buffer);</programlisting>
312
310
<para>
313
311
Returns the largest buffer that contains the memory pointed to by <parameter>buffer</parameter>.
314
312
This will either be the passed <parameter>buffer</parameter> itself, or if the buffer was created
323
321
         by <parameter>buffer</parameter>.
324
322
</simpara></listitem></varlistentry>
325
323
</variablelist></refsect2>
326
 
<refsect2>
327
 
<title><anchor id="swfdec-buffer-queue-new" role="function"/>swfdec_buffer_queue_new ()</title>
328
 
<indexterm><primary>swfdec_buffer_queue_new</primary></indexterm><programlisting><link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link>*  swfdec_buffer_queue_new             (void);</programlisting>
 
324
<refsect2 id="swfdec-buffer-queue-new" role="function">
 
325
<title>swfdec_buffer_queue_new ()</title>
 
326
<indexterm zone="swfdec-buffer-queue-new"><primary>swfdec_buffer_queue_new</primary></indexterm><programlisting><link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link>*  swfdec_buffer_queue_new             (void);</programlisting>
329
327
<para>
330
328
Creates a new empty buffer queue.</para>
331
329
<para>
334
332
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> a new buffer queue. Use <link linkend="swfdec-buffer-queue-unref"><function>swfdec_buffer_queue_unref()</function></link> to free it.
335
333
</simpara></listitem></varlistentry>
336
334
</variablelist></refsect2>
337
 
<refsect2>
338
 
<title><anchor id="swfdec-buffer-queue-clear" role="function"/>swfdec_buffer_queue_clear ()</title>
339
 
<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>
 
335
<refsect2 id="swfdec-buffer-queue-clear" role="function">
 
336
<title>swfdec_buffer_queue_clear ()</title>
 
337
<indexterm zone="swfdec-buffer-queue-clear"><primary>swfdec_buffer_queue_clear</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_buffer_queue_clear           (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue);</programlisting>
340
338
<para>
341
339
Resets <parameter>queue</parameter> into to initial state. All buffers it contains will be 
342
340
released and the offset will be reset to 0.</para>
347
345
<listitem><simpara> a <link linkend="SwfdecBufferQueue"><type>SwfdecBufferQueue</type></link>
348
346
</simpara></listitem></varlistentry>
349
347
</variablelist></refsect2>
350
 
<refsect2>
351
 
<title><anchor id="swfdec-buffer-queue-ref" role="function"/>swfdec_buffer_queue_ref ()</title>
352
 
<indexterm><primary>swfdec_buffer_queue_ref</primary></indexterm><programlisting><link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link>*  swfdec_buffer_queue_ref             (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue);</programlisting>
 
348
<refsect2 id="swfdec-buffer-queue-ref" role="function">
 
349
<title>swfdec_buffer_queue_ref ()</title>
 
350
<indexterm zone="swfdec-buffer-queue-ref"><primary>swfdec_buffer_queue_ref</primary></indexterm><programlisting><link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link>*  swfdec_buffer_queue_ref             (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue);</programlisting>
353
351
<para>
354
352
increases the reference count of <parameter>queue</parameter> by one.</para>
355
353
<para>
361
359
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The passed in <parameter>queue</parameter>.
362
360
</simpara></listitem></varlistentry>
363
361
</variablelist></refsect2>
364
 
<refsect2>
365
 
<title><anchor id="swfdec-buffer-queue-unref" role="function"/>swfdec_buffer_queue_unref ()</title>
366
 
<indexterm><primary>swfdec_buffer_queue_unref</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_buffer_queue_unref           (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue);</programlisting>
 
362
<refsect2 id="swfdec-buffer-queue-unref" role="function">
 
363
<title>swfdec_buffer_queue_unref ()</title>
 
364
<indexterm zone="swfdec-buffer-queue-unref"><primary>swfdec_buffer_queue_unref</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_buffer_queue_unref           (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue);</programlisting>
367
365
<para>
368
366
Decreases the reference count of <parameter>queue</parameter> by one. If no reference 
369
367
to this buffer exists anymore, the buffer and the memory 
375
373
<listitem><simpara> a <link linkend="SwfdecBufferQueue"><type>SwfdecBufferQueue</type></link>
376
374
</simpara></listitem></varlistentry>
377
375
</variablelist></refsect2>
378
 
<refsect2>
379
 
<title><anchor id="swfdec-buffer-queue-get-depth" role="function"/>swfdec_buffer_queue_get_depth ()</title>
380
 
<indexterm><primary>swfdec_buffer_queue_get_depth</primary></indexterm><programlisting><link linkend="gsize">gsize</link>               swfdec_buffer_queue_get_depth       (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue);</programlisting>
 
376
<refsect2 id="swfdec-buffer-queue-get-depth" role="function">
 
377
<title>swfdec_buffer_queue_get_depth ()</title>
 
378
<indexterm zone="swfdec-buffer-queue-get-depth"><primary>swfdec_buffer_queue_get_depth</primary></indexterm><programlisting><link linkend="gsize">gsize</link>               swfdec_buffer_queue_get_depth       (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue);</programlisting>
381
379
<para>
382
380
Returns the number of bytes currently in <parameter>queue</parameter>.</para>
383
381
<para>
389
387
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> amount of bytes in <parameter>queue</parameter>.
390
388
</simpara></listitem></varlistentry>
391
389
</variablelist></refsect2>
392
 
<refsect2>
393
 
<title><anchor id="swfdec-buffer-queue-get-offset" role="function"/>swfdec_buffer_queue_get_offset ()</title>
394
 
<indexterm><primary>swfdec_buffer_queue_get_offset</primary></indexterm><programlisting><link linkend="gsize">gsize</link>               swfdec_buffer_queue_get_offset      (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue);</programlisting>
 
390
<refsect2 id="swfdec-buffer-queue-get-offset" role="function">
 
391
<title>swfdec_buffer_queue_get_offset ()</title>
 
392
<indexterm zone="swfdec-buffer-queue-get-offset"><primary>swfdec_buffer_queue_get_offset</primary></indexterm><programlisting><link linkend="gsize">gsize</link>               swfdec_buffer_queue_get_offset      (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue);</programlisting>
395
393
<para>
396
394
Queries the amount of bytes that has already been pulled out of
397
395
<parameter>queue</parameter> using functions like <link linkend="swfdec-buffer-queue-pull"><function>swfdec_buffer_queue_pull()</function></link>.</para>
404
402
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> Number of bytes that were already pulled from this queue.
405
403
</simpara></listitem></varlistentry>
406
404
</variablelist></refsect2>
407
 
<refsect2>
408
 
<title><anchor id="swfdec-buffer-queue-push" role="function"/>swfdec_buffer_queue_push ()</title>
409
 
<indexterm><primary>swfdec_buffer_queue_push</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_buffer_queue_push            (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue,
 
405
<refsect2 id="swfdec-buffer-queue-push" role="function">
 
406
<title>swfdec_buffer_queue_push ()</title>
 
407
<indexterm zone="swfdec-buffer-queue-push"><primary>swfdec_buffer_queue_push</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_buffer_queue_push            (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue,
410
408
                                                         <link linkend="SwfdecBuffer">SwfdecBuffer</link> *buffer);</programlisting>
411
409
<para>
412
410
Appends the given <parameter>buffer</parameter> to the buffers already in <parameter>queue</parameter>. This function
422
420
<listitem><simpara> <link linkend="SwfdecBuffer"><type>SwfdecBuffer</type></link> to append to <parameter>queue</parameter>
423
421
</simpara></listitem></varlistentry>
424
422
</variablelist></refsect2>
425
 
<refsect2>
426
 
<title><anchor id="swfdec-buffer-queue-pull" role="function"/>swfdec_buffer_queue_pull ()</title>
427
 
<indexterm><primary>swfdec_buffer_queue_pull</primary></indexterm><programlisting><link linkend="SwfdecBuffer">SwfdecBuffer</link>*       swfdec_buffer_queue_pull            (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue,
 
423
<refsect2 id="swfdec-buffer-queue-pull" role="function">
 
424
<title>swfdec_buffer_queue_pull ()</title>
 
425
<indexterm zone="swfdec-buffer-queue-pull"><primary>swfdec_buffer_queue_pull</primary></indexterm><programlisting><link linkend="SwfdecBuffer">SwfdecBuffer</link>*       swfdec_buffer_queue_pull            (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue,
428
426
                                                         <link linkend="gsize">gsize</link> length);</programlisting>
429
427
<para>
430
428
If enough data is still available in <parameter>queue</parameter>, the first <parameter>length</parameter> bytes are 
443
441
<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>
444
442
</simpara></listitem></varlistentry>
445
443
</variablelist></refsect2>
446
 
<refsect2>
447
 
<title><anchor id="swfdec-buffer-queue-pull-buffer" role="function"/>swfdec_buffer_queue_pull_buffer ()</title>
448
 
<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>
 
444
<refsect2 id="swfdec-buffer-queue-pull-buffer" role="function">
 
445
<title>swfdec_buffer_queue_pull_buffer ()</title>
 
446
<indexterm zone="swfdec-buffer-queue-pull-buffer"><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>
449
447
<para>
450
448
Pulls the first buffer out of <parameter>queue</parameter> and returns it. This function is 
451
449
equivalent to calling <link linkend="swfdec-buffer-queue-pull"><function>swfdec_buffer_queue_pull()</function></link> with the size of the
459
457
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The first buffer in <parameter>queue</parameter> or <link linkend="NULL:CAPS"><literal>NULL</literal></link> if <parameter>queue</parameter> is empty.
460
458
</simpara></listitem></varlistentry>
461
459
</variablelist></refsect2>
462
 
<refsect2>
463
 
<title><anchor id="swfdec-buffer-queue-peek" role="function"/>swfdec_buffer_queue_peek ()</title>
464
 
<indexterm><primary>swfdec_buffer_queue_peek</primary></indexterm><programlisting><link linkend="SwfdecBuffer">SwfdecBuffer</link>*       swfdec_buffer_queue_peek            (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue,
 
460
<refsect2 id="swfdec-buffer-queue-peek" role="function">
 
461
<title>swfdec_buffer_queue_peek ()</title>
 
462
<indexterm zone="swfdec-buffer-queue-peek"><primary>swfdec_buffer_queue_peek</primary></indexterm><programlisting><link linkend="SwfdecBuffer">SwfdecBuffer</link>*       swfdec_buffer_queue_peek            (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue,
465
463
                                                         <link linkend="gsize">gsize</link> length);</programlisting>
466
464
<para>
467
465
Creates a new buffer with the first <parameter>length</parameter> bytes from <parameter>queue</parameter>, but unlike 
479
477
         readonly <link linkend="SwfdecBuffer"><type>SwfdecBuffer</type></link>. Use <link linkend="swfdec-buffer-unref"><function>swfdec_buffer_unref()</function></link> after use.
480
478
</simpara></listitem></varlistentry>
481
479
</variablelist></refsect2>
482
 
<refsect2>
483
 
<title><anchor id="swfdec-buffer-queue-peek-buffer" role="function"/>swfdec_buffer_queue_peek_buffer ()</title>
484
 
<indexterm><primary>swfdec_buffer_queue_peek_buffer</primary></indexterm><programlisting><link linkend="SwfdecBuffer">SwfdecBuffer</link>*       swfdec_buffer_queue_peek_buffer     (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue);</programlisting>
 
480
<refsect2 id="swfdec-buffer-queue-peek-buffer" role="function">
 
481
<title>swfdec_buffer_queue_peek_buffer ()</title>
 
482
<indexterm zone="swfdec-buffer-queue-peek-buffer"><primary>swfdec_buffer_queue_peek_buffer</primary></indexterm><programlisting><link linkend="SwfdecBuffer">SwfdecBuffer</link>*       swfdec_buffer_queue_peek_buffer     (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue);</programlisting>
485
483
<para>
486
484
Gets the first buffer out of <parameter>queue</parameter> and returns it. This function is 
487
485
equivalent to calling <link linkend="swfdec-buffer-queue-peek"><function>swfdec_buffer_queue_peek()</function></link> with the size of the
496
494
         <link linkend="swfdec-buffer-unref"><function>swfdec_buffer_unref()</function></link> after use.
497
495
</simpara></listitem></varlistentry>
498
496
</variablelist></refsect2>
499
 
<refsect2>
500
 
<title><anchor id="swfdec-buffer-queue-flush" role="function"/>swfdec_buffer_queue_flush ()</title>
501
 
<indexterm><primary>swfdec_buffer_queue_flush</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_buffer_queue_flush           (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue,
 
497
<refsect2 id="swfdec-buffer-queue-flush" role="function">
 
498
<title>swfdec_buffer_queue_flush ()</title>
 
499
<indexterm zone="swfdec-buffer-queue-flush"><primary>swfdec_buffer_queue_flush</primary></indexterm><programlisting><link linkend="void">void</link>                swfdec_buffer_queue_flush           (<link linkend="SwfdecBufferQueue">SwfdecBufferQueue</link> *queue,
502
500
                                                         <link linkend="gsize">gsize</link> n_bytes);</programlisting>
503
501
<para>
504
502
Removes the first <parameter>n_bytes</parameter> bytes from the queue.</para>
518
516
 
519
517
 
520
518
 
521
 
 
522
 
<refsect1><refsect2 /><refsect2 /></refsect1>
523
519
</refentry>