gstreamer/docs/gst/tmpl/gstqueue.sgml
Stefan Kost 21e56edfbc put symbols in the sections.txt into the right sections (so that we dont get wrong undocumented symbols) added TITLE ...
Original commit message from CVS:
put symbols in the sections.txt into the right sections (so that we dont get wrong undocumented symbols)
added TITLE tags where they were missing
fixed section names so that gtk-doc introspection works
fixed typos in api docs and docbook docs
added some thoughts about new interfaces (to personal notes)
2004-07-21 11:32:09 +00:00

123 lines
1.9 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>
<!-- ##### STRUCT GstQueue ##### -->
<para>
</para>
<!-- ##### SIGNAL GstQueue::overrun ##### -->
<para>
</para>
@gstqueue: the object which received the signal.
<!-- ##### SIGNAL GstQueue::running ##### -->
<para>
</para>
@gstqueue: the object which received the signal.
<!-- ##### SIGNAL GstQueue::underrun ##### -->
<para>
</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: