gstreamer/docs/gst/tmpl/gstqueue.sgml
Stefan Kost a34f2613f9 more tests (and fixes) for the controller more docs for the controller integrated companies docs for the adapter
Original commit message from CVS:
more tests (and fixes) for the controller
more docs for the controller
integrated companies docs for the adapter
2005-08-05 10:02:44 +00:00

132 lines
2.4 KiB
Text

<!-- ##### SECTION Title ##### -->
GstQueue
<!-- ##### SECTION Short_Description ##### -->
Simple asynchronous data queue.
<!-- ##### SECTION Long_Description ##### -->
<para>
Simple data queue. Data is queued till max_level buffers any subsequent buffers
sent to this filter will block until free space becomes available in the buffer.
The queue is typically used in conjunction with a thread.
</para>
<para>
You can query how many buffers are queued with the level argument.
</para>
<para>
The default queue length is set to 100.
</para>
<para>
The queue blocks by default.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### STRUCT GstQueue ##### -->
<para>
</para>
<!-- ##### SIGNAL GstQueue::overrun ##### -->
<para>
Reports that the buffer became full (overrun).
A buffer is full if the total amount of data inside it (num-buffers, time,
size) is higher than the boundary values which can be set through the GObject
properties.
</para>
@gstqueue: the object which received the signal.
<!-- ##### SIGNAL GstQueue::running ##### -->
<para>
</para>
@gstqueue: the object which received the signal.
<!-- ##### SIGNAL GstQueue::underrun ##### -->
<para>
Reports that the buffer became empty (underrun).
A buffer is empty if the total amount of data inside it (num-buffers, time,
size) is lower than the boundary values which can be set through the GObject
properties.
</para>
@gstqueue: the object which received the signal.
<!-- ##### ARG GstQueue:block-timeout ##### -->
<para>
</para>
<!-- ##### ARG GstQueue:current-level-buffers ##### -->
<para>
</para>
<!-- ##### ARG GstQueue:current-level-bytes ##### -->
<para>
</para>
<!-- ##### ARG GstQueue:current-level-time ##### -->
<para>
</para>
<!-- ##### ARG GstQueue:leaky ##### -->
<para>
</para>
<!-- ##### ARG GstQueue:max-size-buffers ##### -->
<para>
</para>
<!-- ##### ARG GstQueue:max-size-bytes ##### -->
<para>
</para>
<!-- ##### ARG GstQueue:max-size-time ##### -->
<para>
</para>
<!-- ##### ARG GstQueue:may-deadlock ##### -->
<para>
</para>
<!-- ##### ARG GstQueue:min-threshold-buffers ##### -->
<para>
</para>
<!-- ##### ARG GstQueue:min-threshold-bytes ##### -->
<para>
</para>
<!-- ##### ARG GstQueue:min-threshold-time ##### -->
<para>
</para>
<!-- ##### STRUCT GstQueueSize ##### -->
<para>
</para>
@buffers:
@bytes:
@time: