mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-02-17 11:45:25 +00:00
Code Issues 1 Projects Releases Wiki Activity

plugins/elements/gstmultiqueue.c: Add documentation for the signals to push our core plugin docs coverage back up to ...

Browse source 
Original commit message from CVS:
* plugins/elements/gstmultiqueue.c:
Add documentation for the signals to push our core plugin docs
coverage back up to 100%.
This commit is contained in:
Jan Schmidt 2008-05-09 14:02:53 +00:00
parent 867e9c9191
commit 4fa54750f6
3 changed files with 28 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
ChangeLog
View file

@ -1,3 +1,9 @@
2008-05-09 Jan Schmidt <jan.schmidt@sun.com>
* plugins/elements/gstmultiqueue.c:
Add documentation for the signals to push our core plugin docs
coverage back up to 100%.
2008-05-08 Ole André Vadla Ravnås <ole.andre.ravnas at tandberg com>
* gst/gstinfo.h (GST_FUNCTION):

2
common

@ -1 +1 @@
Subproject commit ba3dd2882b1611f8115f9664e3b85e1fd956b53d
Subproject commit dbf8f3aeceb6e57de097951a670cd853b4886ad8

21
plugins/elements/gstmultiqueue.c
View file

@ -272,11 +272,32 @@ gst_multi_queue_class_init (GstMultiQueueClass * klass)
GST_DEBUG_FUNCPTR (gst_multi_queue_get_property);
/* SIGNALS */
/**
* GstMultiQueue::underrun:
* @multiqueue: the multqueue instance
*
* This signal is emitted from the streaming thread when there is
* no data in any of the queues inside the multiqueue instance (underrun).
*
* This indicates either starvation or EOS from the upstream data sources.
*/
gst_multi_queue_signals[SIGNAL_UNDERRUN] =
g_signal_new ("underrun", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_FIRST,
G_STRUCT_OFFSET (GstMultiQueueClass, underrun), NULL, NULL,
g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
/**
* GstMultiQueue::overrun:
* @multiqueue: the multiqueue instance
*
* Reports that one of the queues in the multiqueue is full (overrun).
* A queue 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.
*
* This can be used as an indicator of pre-roll.
*/
gst_multi_queue_signals[SIGNAL_OVERRUN] =
g_signal_new ("overrun", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_FIRST,
G_STRUCT_OFFSET (GstMultiQueueClass, overrun), NULL, NULL,