docs/gst/tmpl/gstqueue.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GstQueue
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Simple asynchronous data queue.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 Simple data queue. Data is queued till max_level buffers any subsequent buffers
  10 sent to this filter will block until free space becomes available in the buffer.
  11 The queue is typically used in conjunction with a thread.
  12 </para>
  13 <para>
  14 You can query how many buffers are queued with the level argument.
  15 </para>
  16 <para>
  17 The default queue length is set to 10.
  18 </para>
  19 <para>
  20 The queue blocks by default.
  21 </para>
  22
  23 <!-- ##### SECTION See_Also ##### -->
  24 <para>
  25
  26 </para>
  27
  28 <!-- ##### ARG GstQueue:level ##### -->
  29 <para>
  30 Get the number of buffers in the queue.
  31 </para>
  32
  33 <!-- ##### ARG GstQueue:max_level ##### -->
  34 <para>
  35 Specify the maximum number of buffers in the queue before the queue
  36 blocks.
  37 </para>
  38
  39 <!-- ##### ARG GstQueue:block ##### -->
  40 <para>
  41 Specify wether the queue blocks or not.
  42 </para>
  43