gstreamer/docs/gst/tmpl/gstqueue.sgml
Stefan Kost cdc8ba9725 docs/gst/gstreamer-sections.txt: made some defines private
Original commit message from CVS:
* docs/gst/gstreamer-sections.txt:
made some defines private
* docs/gst/tmpl/gstconfig.sgml:
* docs/gst/tmpl/gstqueue.sgml:
* docs/gst/tmpl/gsttaglist.sgml:
* docs/gst/tmpl/gsttypes.sgml:
* docs/gst/tmpl/gstutils.sgml:
* docs/pwg/appendix-porting.xml:
* gst/base/gstbasesink.h:
* gst/base/gstbasesrc.c:
* gst/base/gstbasesrc.h:
* gst/elements/gstfakesink.c: (gst_fake_sink_class_init):
* gst/elements/gstfakesrc.c: (gst_fake_src_class_init):
* gst/gstelement.c: (gst_element_class_init):
* gst/gstpad.c: (gst_pad_class_init):
* gst/gstqueue.c: (gst_queue_class_init):
* gst/gstxml.c: (gst_xml_class_init):
documented all undocumented signal inline
* libs/gst/controller/gst-controller.h:
added padding
2005-08-15 16:57:34 +00:00

126 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>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### 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: