mirror of
https://gitlab.freedesktop.org/gstreamer/gstreamer.git
synced 2024-11-30 05:31:15 +00:00
b32ebdaabe
Original commit message from CVS: added documentation to many items moved the GST_TYPE_XXX one to the Standart section, as they do not need docs
129 lines
2.3 KiB
Text
129 lines
2.3 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>
|
|
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:
|
|
|