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
This commit is contained in:
Sam Thursfield 2017-01-23 14:30:20 +00:00 committed by Tim-Philipp Müller
parent c4be7eca5d
commit f1324f9cb0

View file

@ -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