docs: Document basecamerabinsrc

4 files changed, 9 insertions, 258 deletions

diff --git a/docs/libs/basecamerabinsrc/index.md b/docs/libs/basecamerabinsrc/index.md
new file mode 100644
index 000000000..16093b763
--- /dev/null
+++ b/docs/libs/basecamerabinsrc/index.md
@@ -0,0 +1,7 @@
+# BaseCamerabinSrc Library
+
+This library should be linked to by getting cflags and libs from
+gstreamer-plugins-bad-{{ gst_api_version.md }}.pc and adding
+-lgstbasecamerabinsrc-{{ gst_api_version.md }} to the library flags.
+
+> NOTE: This library API is considered *unstable*
diff --git a/docs/libs/basecamerabinsrc/sitemap.txt b/docs/libs/basecamerabinsrc/sitemap.txt
new file mode 100644
index 000000000..4f91fcd8a
--- /dev/null
+++ b/docs/libs/basecamerabinsrc/sitemap.txt
@@ -0,0 +1 @@
+gi-index
diff --git a/docs/meson.build b/docs/meson.build
index d06cce138..1192e2680 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -114,6 +114,7 @@ if build_gir
         {'name': 'codecparsers', 'lib': gstcodecparsers_dep},
         {'name': 'opencv', 'lib': gstopencv_dep, 'c_source_patterns': ['*.h', '*.cpp'], 'extra_c_flags': ['-x c++']},
         {'name': 'adaptivedemux', 'lib': gstadaptivedemux_dep},
+        {'name': 'basecamerabinsrc', 'gir': basecamerabin_gir, 'lib': gstbasecamerabin_dep},
         {'name': 'webrtc', 'gir': webrtc_gir, 'lib': gstwebrtc_dep, 'suffix': 'lib'},
         {'name': 'audio', 'gir': audio_gir, 'lib': gstbadaudio_dep, 'prefix': 'bad-'},
         {'name': 'transcoder', 'gir': transcoder_gir, 'lib': gst_transcoder_dep},
diff --git a/docs/plugins/gst_plugins_cache.json b/docs/plugins/gst_plugins_cache.json
index e191e98d6..38e6eb5b2 100644
--- a/docs/plugins/gst_plugins_cache.json
+++ b/docs/plugins/gst_plugins_cache.json
@@ -2586,135 +2586,6 @@
         "filename": "gstcamerabin",
         "license": "LGPL",
         "other-types": {
-            "GstBaseCameraSrc": {
-                "hierarchy": [
-                    "GstBaseCameraSrc",
-                    "GstBin",
-                    "GstElement",
-                    "GstObject",
-                    "GInitiallyUnowned",
-                    "GObject"
-                ],
-                "interfaces": [
-                    "GstChildProxy"
-                ],
-                "kind": "object",
-                "properties": {
-                    "auto-start": {
-                        "blurb": "Automatically starts capture when going to the PAUSED state",
-                        "conditionally-available": false,
-                        "construct": false,
-                        "construct-only": false,
-                        "controllable": false,
-                        "default": "false",
-                        "mutable": "null",
-                        "readable": true,
-                        "type": "gboolean",
-                        "writable": true
-                    },
-                    "max-zoom": {
-                        "blurb": "Digital zoom factor (e.g. 1.5 means 1.5x)",
-                        "conditionally-available": false,
-                        "construct": false,
-                        "construct-only": false,
-                        "controllable": false,
-                        "default": "10",
-                        "max": "3.40282e+38",
-                        "min": "1",
-                        "mutable": "null",
-                        "readable": true,
-                        "type": "gfloat",
-                        "writable": false
-                    },
-                    "mode": {
-                        "blurb": "The capture mode (still image capture or video recording)",
-                        "conditionally-available": false,
-                        "construct": false,
-                        "construct-only": false,
-                        "controllable": false,
-                        "default": "mode-image (1)",
-                        "mutable": "null",
-                        "readable": true,
-                        "type": "GstCameraBin2Mode",
-                        "writable": true
-                    },
-                    "post-previews": {
-                        "blurb": "If capture preview images should be posted to the bus",
-                        "conditionally-available": false,
-                        "construct": false,
-                        "construct-only": false,
-                        "controllable": false,
-                        "default": "true",
-                        "mutable": "null",
-                        "readable": true,
-                        "type": "gboolean",
-                        "writable": true
-                    },
-                    "preview-caps": {
-                        "blurb": "The caps of the preview image to be posted (NULL means ANY)",
-                        "conditionally-available": false,
-                        "construct": false,
-                        "construct-only": false,
-                        "controllable": false,
-                        "default": "ANY",
-                        "mutable": "null",
-                        "readable": true,
-                        "type": "GstCaps",
-                        "writable": true
-                    },
-                    "preview-filter": {
-                        "blurb": "A custom preview filter to process preview image data",
-                        "conditionally-available": false,
-                        "construct": false,
-                        "construct-only": false,
-                        "controllable": false,
-                        "mutable": "null",
-                        "readable": true,
-                        "type": "GstElement",
-                        "writable": true
-                    },
-                    "ready-for-capture": {
-                        "blurb": "Informs this element is ready for starting another capture",
-                        "conditionally-available": false,
-                        "construct": false,
-                        "construct-only": false,
-                        "controllable": false,
-                        "default": "true",
-                        "mutable": "null",
-                        "readable": true,
-                        "type": "gboolean",
-                        "writable": false
-                    },
-                    "zoom": {
-                        "blurb": "Digital zoom factor (e.g. 1.5 means 1.5x)",
-                        "conditionally-available": false,
-                        "construct": false,
-                        "construct-only": false,
-                        "controllable": false,
-                        "default": "1",
-                        "max": "3.40282e+38",
-                        "min": "1",
-                        "mutable": "null",
-                        "readable": true,
-                        "type": "gfloat",
-                        "writable": true
-                    }
-                },
-                "signals": {
-                    "start-capture": {
-                        "action": true,
-                        "args": [],
-                        "return-type": "void",
-                        "when": "last"
-                    },
-                    "stop-capture": {
-                        "action": true,
-                        "args": [],
-                        "return-type": "void",
-                        "when": "last"
-                    }
-                }
-            },
             "GstCamFlags": {
                 "kind": "flags",
                 "values": [
@@ -218949,135 +218820,6 @@
         "filename": "gstuvch264",
         "license": "LGPL",
         "other-types": {
-            "GstBaseCameraSrc": {
-                "hierarchy": [
-                    "GstBaseCameraSrc",
-                    "GstBin",
-                    "GstElement",
-                    "GstObject",
-                    "GInitiallyUnowned",
-                    "GObject"
-                ],
-                "interfaces": [
-                    "GstChildProxy"
-                ],
-                "kind": "object",
-                "properties": {
-                    "auto-start": {
-                        "blurb": "Automatically starts capture when going to the PAUSED state",
-                        "conditionally-available": false,
-                        "construct": false,
-                        "construct-only": false,
-                        "controllable": false,
-                        "default": "false",
-                        "mutable": "null",
-                        "readable": true,
-                        "type": "gboolean",
-                        "writable": true
-                    },
-                    "max-zoom": {
-                        "blurb": "Digital zoom factor (e.g. 1.5 means 1.5x)",
-                        "conditionally-available": false,
-                        "construct": false,
-                        "construct-only": false,
-                        "controllable": false,
-                        "default": "10",
-                        "max": "3.40282e+38",
-                        "min": "1",
-                        "mutable": "null",
-                        "readable": true,
-                        "type": "gfloat",
-                        "writable": false
-                    },
-                    "mode": {
-                        "blurb": "The capture mode (still image capture or video recording)",
-                        "conditionally-available": false,
-                        "construct": false,
-                        "construct-only": false,
-                        "controllable": false,
-                        "default": "mode-video (2)",
-                        "mutable": "null",
-                        "readable": true,
-                        "type": "GstCameraBin2Mode",
-                        "writable": true
-                    },
-                    "post-previews": {
-                        "blurb": "If capture preview images should be posted to the bus",
-                        "conditionally-available": false,
-                        "construct": false,
-                        "construct-only": false,
-                        "controllable": false,
-                        "default": "true",
-                        "mutable": "null",
-                        "readable": true,
-                        "type": "gboolean",
-                        "writable": true
-                    },
-                    "preview-caps": {
-                        "blurb": "The caps of the preview image to be posted (NULL means ANY)",
-                        "conditionally-available": false,
-                        "construct": false,
-                        "construct-only": false,
-                        "controllable": false,
-                        "default": "ANY",
-                        "mutable": "null",
-                        "readable": true,
-                        "type": "GstCaps",
-                        "writable": true
-                    },
-                    "preview-filter": {
-                        "blurb": "A custom preview filter to process preview image data",
-                        "conditionally-available": false,
-                        "construct": false,
-                        "construct-only": false,
-                        "controllable": false,
-                        "mutable": "null",
-                        "readable": true,
-                        "type": "GstElement",
-                        "writable": true
-                    },
-                    "ready-for-capture": {
-                        "blurb": "Informs this element is ready for starting another capture",
-                        "conditionally-available": false,
-                        "construct": false,
-                        "construct-only": false,
-                        "controllable": false,
-                        "default": "true",
-                        "mutable": "null",
-                        "readable": true,
-                        "type": "gboolean",
-                        "writable": false
-                    },
-                    "zoom": {
-                        "blurb": "Digital zoom factor (e.g. 1.5 means 1.5x)",
-                        "conditionally-available": false,
-                        "construct": false,
-                        "construct-only": false,
-                        "controllable": false,
-                        "default": "1",
-                        "max": "3.40282e+38",
-                        "min": "1",
-                        "mutable": "null",
-                        "readable": true,
-                        "type": "gfloat",
-                        "writable": true
-                    }
-                },
-                "signals": {
-                    "start-capture": {
-                        "action": true,
-                        "args": [],
-                        "return-type": "void",
-                        "when": "last"
-                    },
-                    "stop-capture": {
-                        "action": true,
-                        "args": [],
-                        "return-type": "void",
-                        "when": "last"
-                    }
-                }
-            },
             "GstCameraBin2Mode": {
                 "kind": "enum",
                 "values": [