summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Dufresne <nicolas.dufresne@collabora.com>2018-02-21 11:41:40 -0500
committerNicolas Dufresne <nicolas.dufresne@collabora.com>2018-02-21 12:27:39 -0500
commita73e5eba55d5b18eb0da14328fa7b0a456d8c84b (patch)
treecb38e630d0dfde3395eb42ecd402158693af44d2
parentf0c676c0f9aca859ed6c2fe4ebabb8dce5bb162c (diff)
doc: Add section for fakevideosink
https://bugzilla.gnome.org/show_bug.cgi?id=793624
-rw-r--r--docs/plugins/gst-plugins-bad-plugins-docs.sgml1
-rw-r--r--docs/plugins/gst-plugins-bad-plugins-sections.txt16
-rw-r--r--gst/debugutils/gstfakevideosink.c18
3 files changed, 35 insertions, 0 deletions
diff --git a/docs/plugins/gst-plugins-bad-plugins-docs.sgml b/docs/plugins/gst-plugins-bad-plugins-docs.sgml
index a590060c1..5941a4d30 100644
--- 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 c1bae1d63..b71f7945b 100644
--- 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 9e3cf59b9..0bf0948eb 100644
--- 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>