summaryrefslogtreecommitdiff
path: root/gst
diff options
context:
space:
mode:
authorSam Thursfield <sam.thursfield@codethink.co.uk>2017-01-23 14:30:20 +0000
committerTim-Philipp Müller <tim@centricular.com>2018-01-12 00:49:20 +0000
commitf1324f9cb05593d272b171fbd38ccf7692f4d96b (patch)
treebe9853c940659d247a298c948a12c72db1c77946 /gst
parentc4be7eca5d87babb941843e677e237b305d7e9f2 (diff)
videotestsrc: Document the num-buffers property
It's not obvious from the existing docs that this option exists, nor that it can be used to give a pipeline an exact length in video frames. https://bugzilla.gnome.org/show_bug.cgi?id=777647
Diffstat (limited to 'gst')
-rw-r--r--gst/videotestsrc/gstvideotestsrc.c4
1 files changed, 4 insertions, 0 deletions
diff --git a/gst/videotestsrc/gstvideotestsrc.c b/gst/videotestsrc/gstvideotestsrc.c
index 93d0b1320..d7e034720 100644
--- a/gst/videotestsrc/gstvideotestsrc.c
+++ b/gst/videotestsrc/gstvideotestsrc.c
@@ -26,6 +26,10 @@
* of formats. The video test data produced can be controlled with the "pattern"
* property.
*
+ * By default the videotestsrc will generate data indefinitely, but if the
+ * #GstBaseSrc:num-buffers property is non-zero it will instead generate a
+ * fixed number of video frames and then send EOS.
+ *
* ## Example launch line
* |[
* gst-launch-1.0 -v videotestsrc pattern=snow ! video/x-raw,width=1280,height=720 ! autovideosink