doc: Add section for fakevideosink

https://bugzilla.gnome.org/show_bug.cgi?id=793624

diff --git a/docs/plugins/gst-plugins-bad-plugins-docs.sgml b/docs/plugins/gst-plugins-bad-plugins-docs.sgml
index a590060..5941a4d 100644 (file)
--- a/docs/plugins/gst-plugins-bad-plugins-docs.sgml
+++ b/docs/plugins/gst-plugins-bad-plugins-docs.sgml
@@ -51,6 +51,7 @@
     <xi:include href="xml/element-faad.xml" />
     <xi:include href="xml/element-faceblur.xml" />
     <xi:include href="xml/element-facedetect.xml" />
+    <xi:include href="xml/element-fakevideosink.xml" />
     <xi:include href="xml/element-festival.xml" />
     <xi:include href="xml/element-fisheye.xml" />
     <xi:include href="xml/element-fpsdisplaysink.xml" />

diff --git a/docs/plugins/gst-plugins-bad-plugins-sections.txt b/docs/plugins/gst-plugins-bad-plugins-sections.txt
index c1bae1d..b71f794 100644 (file)
--- a/docs/plugins/gst-plugins-bad-plugins-sections.txt
+++ b/docs/plugins/gst-plugins-bad-plugins-sections.txt
@@ -1294,6 +1294,22 @@ gst_face_detect_get_type
 </SECTION>
 
 <SECTION>
+<FILE>element-fakevideosink</FILE>
+<TITLE>fakevideosink</TITLE>
+GstFakeVideoSink
+<SUBSECTION Standard>
+GstFakeVideoSinkClass
+GST_FAKE_VIDEO_SINK
+GST_FAKE_VIDEO_SINK_CAST
+GST_IS_FAKE_VIDEO_SINK
+GST_FAKE_VIDEO_SINK_CLASS
+GST_IS_FAKE_VIDEO_SINK_CLASS
+GST_TYPE_FAKE_VIDEO_SINK
+<SUBSECTION Private>
+gst_fake_video_sink_get_type
+</SECTION>
+
+<SECTION>
 <FILE>element-festival</FILE>
 <TITLE>festival</TITLE>
 GstFestival

diff --git a/gst/debugutils/gstfakevideosink.c b/gst/debugutils/gstfakevideosink.c
index 9e3cf59..0bf0948 100644 (file)
--- a/gst/debugutils/gstfakevideosink.c
+++ b/gst/debugutils/gstfakevideosink.c
@@ -19,6 +19,24 @@
  * Boston, MA 02110-1301, USA.
  */
 
+/**
+ * SECTION:element-fakevideosink
+ * @title: fakevideosink
+ *
+ * This element is the same as fakesink but will pretend to support various
+ * allocation meta API like GstVideoMeta in order to prevent memory copies.
+ * This is useful for throughput testing and testing zero-copy path while
+ * creating a new pipeline.
+ *
+ * ## Example launch lines
+ * |[
+ * gst-launch-1.0 videotestsrc ! fakevideosink
+ * gst-launch-1.0 videotestsrc ! fpsdisplaysink text-overlay=false video-sink=fakevideosink
+ * ]|
+ *
+ * Since 1.14
+ */
+
 #include "gstfakevideosink.h"
 
 #include <gst/video/video.h>