summaryrefslogtreecommitdiff
path: root/gst/videomaxrate/videomaxrate.c
diff options
context:
space:
mode:
Diffstat (limited to 'gst/videomaxrate/videomaxrate.c')
-rw-r--r--gst/videomaxrate/videomaxrate.c14
1 files changed, 14 insertions, 0 deletions
diff --git a/gst/videomaxrate/videomaxrate.c b/gst/videomaxrate/videomaxrate.c
index 52edbceec..0d7bb4f07 100644
--- a/gst/videomaxrate/videomaxrate.c
+++ b/gst/videomaxrate/videomaxrate.c
@@ -24,6 +24,20 @@
*
*/
+
+/**
+ * SECTION:element-videomaxrate
+ * @see_also: videorate
+ *
+ * This object will drop buffers that go beyond a certain buffer rate
+ * (ie frame rate). It should work with any kind of data where each buffer
+ * is independent. This currently means raw video frames and still image
+ * formats.
+ *
+ * The framerate is computed using a moving average. The period over which this
+ * average is computed is configurable using the "average-period" property.
+ */
+
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif