From: Mathieu Duponchelle <mathieu@centricular.com>
Date: Wed, 17 Feb 2021 23:36:43 +0000 (+0100)
Subject: videomixer: document as deprecated
X-Git-Tag: 1.19.3~509^2~294
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=e71648e214d2995d5555cd0e1e9a91db6180781f;p=platform%2Fupstream%2Fgstreamer.git

videomixer: document as deprecated

Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-plugins-good/-/merge_requests/878>
---

diff --git a/docs/gst_plugins_cache.json b/docs/gst_plugins_cache.json
index 2139d87..a62a5a9 100644
--- a/docs/gst_plugins_cache.json
+++ b/docs/gst_plugins_cache.json
@@ -25138,7 +25138,7 @@
         "elements": {
             "videomixer": {
                 "author": "Wim Taymans <wim@fluendo.com>, Sebastian Dröge <sebastian.droege@collabora.co.uk>",
-                "description": "Mix multiple video streams",
+                "description": "Deprecated by compositor. Mix multiple video streams",
                 "hierarchy": [
                     "GstVideoMixer2",
                     "GstElement",
diff --git a/gst/videomixer/videomixer2.c b/gst/videomixer/videomixer2.c
index d225abb..0ecc0c9 100644
--- a/gst/videomixer/videomixer2.c
+++ b/gst/videomixer/videomixer2.c
@@ -22,6 +22,9 @@
  * SECTION:element-videomixer
  * @title: videomixer
  *
+ * IMPORTANT: #videomixer is deprecated in favor of #compositor, please do not
+ * use this element in newly-written code!
+ *
  * Videomixer can accept AYUV, ARGB and BGRA video streams. For each of the requested
  * sink pads it will compare the incoming geometry and framerate to define the
  * output parameters. Indeed output video frames will have the geometry of the
@@ -2230,7 +2233,8 @@ gst_videomixer2_class_init (GstVideoMixer2Class * klass)
 
   gst_element_class_set_static_metadata (gstelement_class, "Video mixer 2",
       "Filter/Editor/Video/Compositor",
-      "Mix multiple video streams", "Wim Taymans <wim@fluendo.com>, "
+      "Deprecated by compositor. Mix multiple video streams",
+      "Wim Taymans <wim@fluendo.com>, "
       "Sebastian Dröge <sebastian.droege@collabora.co.uk>");
 
   /* Register the pad class */