qroverlay: Generate documentation

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

1 files changed, 232 insertions, 0 deletions

diff --git a/docs/plugins/gst_plugins_cache.json b/docs/plugins/gst_plugins_cache.json
index 5a8bea093..7b8580a89 100644
--- a/docs/plugins/gst_plugins_cache.json
+++ b/docs/plugins/gst_plugins_cache.json
@@ -214801,6 +214801,238 @@
         "tracers": {},
         "url": "Unknown package origin"
     },
+    "qroverlay": {
+        "description": "libqrencode qroverlay plugin",
+        "elements": {
+            "debugqroverlay": {
+                "author": "Anthony Violo <anthony.violo@ubicast.eu>",
+                "description": "Overlay Qrcodes over each buffer with buffer information and custom data",
+                "hierarchy": [
+                    "GstDebugQROverlay",
+                    "GstBaseQROverlay",
+                    "GstVideoFilter",
+                    "GstBaseTransform",
+                    "GstElement",
+                    "GstObject",
+                    "GInitiallyUnowned",
+                    "GObject"
+                ],
+                "klass": "Qrcode overlay containing buffer information",
+                "long-name": "qroverlay",
+                "pad-templates": {
+                    "sink": {
+                        "caps": "video/x-raw:\n         format: { I420 }\n      framerate: [ 0/1, 2147483647/1 ]\n          width: [ 16, 2147483647 ]\n         height: [ 16, 2147483647 ]\n",
+                        "direction": "sink",
+                        "presence": "always"
+                    },
+                    "src": {
+                        "caps": "video/x-raw:\n         format: { I420 }\n      framerate: [ 0/1, 2147483647/1 ]\n          width: [ 16, 2147483647 ]\n         height: [ 16, 2147483647 ]\n",
+                        "direction": "src",
+                        "presence": "always"
+                    }
+                },
+                "properties": {
+                    "extra-data-array": {
+                        "blurb": "List of comma separated values that the extra data value will be  cycled from at each interval, example array structure : \"240,480,720,960,1200,1440,1680,1920\"",
+                        "conditionally-available": false,
+                        "construct": false,
+                        "construct-only": false,
+                        "controllable": false,
+                        "default": "NULL",
+                        "mutable": "null",
+                        "readable": true,
+                        "type": "gchararray",
+                        "writable": true
+                    },
+                    "extra-data-interval-buffers": {
+                        "blurb": "Extra data append into the Qrcode at the first buffer of each  interval",
+                        "conditionally-available": false,
+                        "construct": false,
+                        "construct-only": false,
+                        "controllable": false,
+                        "default": "60",
+                        "max": "9223372036854775807",
+                        "min": "0",
+                        "mutable": "null",
+                        "readable": true,
+                        "type": "gint64",
+                        "writable": true
+                    },
+                    "extra-data-name": {
+                        "blurb": "Json key name for extra append data",
+                        "conditionally-available": false,
+                        "construct": false,
+                        "construct-only": false,
+                        "controllable": false,
+                        "default": "NULL",
+                        "mutable": "null",
+                        "readable": true,
+                        "type": "gchararray",
+                        "writable": true
+                    },
+                    "extra-data-span-buffers": {
+                        "blurb": "Numbers of consecutive buffers that the extra data will be inserted  (counting the first buffer)",
+                        "conditionally-available": false,
+                        "construct": false,
+                        "construct-only": false,
+                        "controllable": false,
+                        "default": "1",
+                        "max": "9223372036854775807",
+                        "min": "0",
+                        "mutable": "null",
+                        "readable": true,
+                        "type": "gint64",
+                        "writable": true
+                    }
+                },
+                "rank": "none"
+            },
+            "qroverlay": {
+                "author": "Thibault Saunier <tsaunier@igalia.com>",
+                "description": "Overlay Qrcodes over each buffer with data passed in",
+                "hierarchy": [
+                    "GstQROverlay",
+                    "GstBaseQROverlay",
+                    "GstVideoFilter",
+                    "GstBaseTransform",
+                    "GstElement",
+                    "GstObject",
+                    "GInitiallyUnowned",
+                    "GObject"
+                ],
+                "klass": "Qrcode overlay containing random data",
+                "long-name": "qroverlay",
+                "pad-templates": {
+                    "sink": {
+                        "caps": "video/x-raw:\n         format: { I420 }\n      framerate: [ 0/1, 2147483647/1 ]\n          width: [ 16, 2147483647 ]\n         height: [ 16, 2147483647 ]\n",
+                        "direction": "sink",
+                        "presence": "always"
+                    },
+                    "src": {
+                        "caps": "video/x-raw:\n         format: { I420 }\n      framerate: [ 0/1, 2147483647/1 ]\n          width: [ 16, 2147483647 ]\n         height: [ 16, 2147483647 ]\n",
+                        "direction": "src",
+                        "presence": "always"
+                    }
+                },
+                "properties": {
+                    "data": {
+                        "blurb": "Data to write in the QRCode to be overlaid",
+                        "conditionally-available": false,
+                        "construct": false,
+                        "construct-only": false,
+                        "controllable": true,
+                        "default": "NULL",
+                        "mutable": "playing",
+                        "readable": true,
+                        "type": "gchararray",
+                        "writable": true
+                    }
+                },
+                "rank": "none"
+            }
+        },
+        "filename": "gstqroverlay",
+        "license": "LGPL",
+        "other-types": {
+            "GstBaseQROverlay": {
+                "hierarchy": [
+                    "GstBaseQROverlay",
+                    "GstVideoFilter",
+                    "GstBaseTransform",
+                    "GstElement",
+                    "GstObject",
+                    "GInitiallyUnowned",
+                    "GObject"
+                ],
+                "kind": "object",
+                "properties": {
+                    "pixel-size": {
+                        "blurb": "Pixel size of each Qrcode pixel",
+                        "conditionally-available": false,
+                        "construct": false,
+                        "construct-only": false,
+                        "controllable": false,
+                        "default": "3",
+                        "max": "100",
+                        "min": "1",
+                        "mutable": "null",
+                        "readable": true,
+                        "type": "gfloat",
+                        "writable": true
+                    },
+                    "qrcode-error-correction": {
+                        "blurb": "qrcode-error-correction",
+                        "conditionally-available": false,
+                        "construct": false,
+                        "construct-only": false,
+                        "controllable": false,
+                        "default": "Approx 15%% (1)",
+                        "mutable": "null",
+                        "readable": true,
+                        "type": "GstQrcodeOverlayCorrection",
+                        "writable": true
+                    },
+                    "x": {
+                        "blurb": "X position (in percent of the width)",
+                        "conditionally-available": false,
+                        "construct": false,
+                        "construct-only": false,
+                        "controllable": false,
+                        "default": "50",
+                        "max": "100",
+                        "min": "0",
+                        "mutable": "null",
+                        "readable": true,
+                        "type": "gfloat",
+                        "writable": true
+                    },
+                    "y": {
+                        "blurb": "Y position (in percent of the height)",
+                        "conditionally-available": false,
+                        "construct": false,
+                        "construct-only": false,
+                        "controllable": false,
+                        "default": "50",
+                        "max": "100",
+                        "min": "0",
+                        "mutable": "null",
+                        "readable": true,
+                        "type": "gfloat",
+                        "writable": true
+                    }
+                }
+            },
+            "GstQrcodeOverlayCorrection": {
+                "kind": "enum",
+                "values": [
+                    {
+                        "desc": "Level L",
+                        "name": "Approx 7%%",
+                        "value": "0"
+                    },
+                    {
+                        "desc": "Level M",
+                        "name": "Approx 15%%",
+                        "value": "1"
+                    },
+                    {
+                        "desc": "Level Q",
+                        "name": "Approx 25%%",
+                        "value": "2"
+                    },
+                    {
+                        "desc": "Level H",
+                        "name": "Approx 30%%",
+                        "value": "3"
+                    }
+                ]
+            }
+        },
+        "package": "GStreamer Bad Plug-ins",
+        "source": "gst-plugins-bad",
+        "tracers": {},
+        "url": "Unknown package origin"
+    },
     "removesilence": {
         "description": "Removes silence from an audio stream",
         "elements": {