hlssink3: Update plugin docs

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

1 files changed, 191 insertions, 48 deletions

diff --git a/docs/plugins/gst_plugins_cache.json b/docs/plugins/gst_plugins_cache.json
index 0fd3d0301..c94e392ae 100644
--- a/docs/plugins/gst_plugins_cache.json
+++ b/docs/plugins/gst_plugins_cache.json
@@ -2157,11 +2157,127 @@
     "hlssink3": {
         "description": "GStreamer HLS (HTTP Live Streaming) Plugin",
         "elements": {
+            "hlscmafsink": {
+                "author": "Seungha Yang <seungha@centricular.com>",
+                "description": "HTTP Live Streaming CMAF Sink",
+                "hierarchy": [
+                    "GstHlsCmafSink",
+                    "GstHlsBaseSink",
+                    "GstBin",
+                    "GstElement",
+                    "GstObject",
+                    "GInitiallyUnowned",
+                    "GObject"
+                ],
+                "interfaces": [
+                    "GstChildProxy"
+                ],
+                "klass": "Sink/Muxer",
+                "pad-templates": {
+                    "sink": {
+                        "caps": "video/x-h264:\n  stream-format: { (string)avc, (string)avc3 }\n      alignment: au\n          width: [ 1, 65535 ]\n         height: [ 1, 65535 ]\nvideo/x-h265:\n  stream-format: { (string)hvc1, (string)hev1 }\n      alignment: au\n          width: [ 1, 65535 ]\n         height: [ 1, 65535 ]\naudio/mpeg:\n    mpegversion: 4\n  stream-format: raw\n       channels: [ 1, 65535 ]\n           rate: [ 1, 2147483647 ]\n",
+                        "direction": "sink",
+                        "presence": "always"
+                    }
+                },
+                "properties": {
+                    "init-location": {
+                        "blurb": "Location of the init fragment file to write",
+                        "conditionally-available": false,
+                        "construct": false,
+                        "construct-only": false,
+                        "controllable": false,
+                        "default": "init%%05d.mp4",
+                        "mutable": "null",
+                        "readable": true,
+                        "type": "gchararray",
+                        "writable": true
+                    },
+                    "latency": {
+                        "blurb": "Additional latency to allow upstream to take longer to produce buffers for the current position (in nanoseconds)",
+                        "conditionally-available": false,
+                        "construct": false,
+                        "construct-only": false,
+                        "controllable": false,
+                        "default": "7500000000",
+                        "max": "9223372036854775807",
+                        "min": "0",
+                        "mutable": "null",
+                        "readable": true,
+                        "type": "guint64",
+                        "writable": true
+                    },
+                    "location": {
+                        "blurb": "Location of the fragment file to write",
+                        "conditionally-available": false,
+                        "construct": false,
+                        "construct-only": false,
+                        "controllable": false,
+                        "default": "segment%%05d.m4s",
+                        "mutable": "null",
+                        "readable": true,
+                        "type": "gchararray",
+                        "writable": true
+                    },
+                    "playlist-type": {
+                        "blurb": "The type of the playlist to use. When VOD type is set, the playlist will be live until the pipeline ends execution.",
+                        "conditionally-available": false,
+                        "construct": false,
+                        "construct-only": false,
+                        "controllable": false,
+                        "default": "unspecified (0)",
+                        "mutable": "ready",
+                        "readable": true,
+                        "type": "GstHlsSink3PlaylistType",
+                        "writable": true
+                    },
+                    "sync": {
+                        "blurb": "Sync on the clock",
+                        "conditionally-available": false,
+                        "construct": false,
+                        "construct-only": false,
+                        "controllable": false,
+                        "default": "true",
+                        "mutable": "null",
+                        "readable": true,
+                        "type": "gboolean",
+                        "writable": true
+                    },
+                    "target-duration": {
+                        "blurb": "The target duration in seconds of a segment/file. (0 - disabled, useful for management of segment duration by the streaming server)",
+                        "conditionally-available": false,
+                        "construct": false,
+                        "construct-only": false,
+                        "controllable": false,
+                        "default": "15",
+                        "max": "-1",
+                        "min": "0",
+                        "mutable": "ready",
+                        "readable": true,
+                        "type": "guint",
+                        "writable": true
+                    }
+                },
+                "rank": "none",
+                "signals": {
+                    "get-init-stream": {
+                        "args": [
+                            {
+                                "name": "arg0",
+                                "type": "gchararray"
+                            }
+                        ],
+                        "return-type": "GOutputStream",
+                        "when": "last"
+                    }
+                }
+            },
             "hlssink3": {
                 "author": "Alessandro Decina <alessandro.d@gmail.com>, Sebastian Dröge <sebastian@centricular.com>, Rafael Caricio <rafael@caricio.com>",
                 "description": "HTTP Live Streaming sink",
                 "hierarchy": [
                     "GstHlsSink3",
+                    "GstHlsBaseSink",
                     "GstBin",
                     "GstElement",
                     "GstObject",
@@ -2172,7 +2288,6 @@
                     "GstChildProxy"
                 ],
                 "klass": "Sink/Muxer",
-                "long-name": "HTTP Live Streaming sink",
                 "pad-templates": {
                     "audio": {
                         "caps": "ANY",
@@ -2186,18 +2301,6 @@
                     }
                 },
                 "properties": {
-                    "enable-program-date-time": {
-                        "blurb": "put EXT-X-PROGRAM-DATE-TIME tag in the playlist",
-                        "conditionally-available": false,
-                        "construct": false,
-                        "construct-only": false,
-                        "controllable": false,
-                        "default": "false",
-                        "mutable": "null",
-                        "readable": true,
-                        "type": "gboolean",
-                        "writable": true
-                    },
                     "i-frames-only": {
                         "blurb": "Each video segments is single iframe, So put EXT-X-I-FRAMES-ONLY tag in the playlist",
                         "conditionally-available": false,
@@ -2222,22 +2325,20 @@
                         "type": "gchararray",
                         "writable": true
                     },
-                    "max-files": {
-                        "blurb": "Maximum number of files to keep on disk. Once the maximum is reached, old files start to be deleted to make room for new ones.",
+                    "playlist-type": {
+                        "blurb": "The type of the playlist to use. When VOD type is set, the playlist will be live until the pipeline ends execution.",
                         "conditionally-available": false,
                         "construct": false,
                         "construct-only": false,
                         "controllable": false,
-                        "default": "10",
-                        "max": "-1",
-                        "min": "0",
+                        "default": "unspecified (0)",
                         "mutable": "null",
                         "readable": true,
-                        "type": "guint",
+                        "type": "GstHlsSink3PlaylistType",
                         "writable": true
                     },
-                    "pdt-follows-pipeline-clock": {
-                        "blurb": "As there might be drift between the wallclock and pipeline clock, this controls whether the Program-Date-Time markers should follow the pipeline clock rate (true), or be skewed to match the wallclock rate (false).",
+                    "send-keyframe-requests": {
+                        "blurb": "Send keyframe requests to ensure correct fragmentation. If this is disabled then the input must have keyframes in regular intervals.",
                         "conditionally-available": false,
                         "construct": false,
                         "construct-only": false,
@@ -2248,58 +2349,81 @@
                         "type": "gboolean",
                         "writable": true
                     },
-                    "playlist-length": {
-                        "blurb": "Length of HLS playlist. To allow players to conform to section 6.3.3 of the HLS specification, this should be at least 3. If set to 0, the playlist will be infinite.",
+                    "target-duration": {
+                        "blurb": "The target duration in seconds of a segment/file. (0 - disabled, useful for management of segment duration by the streaming server)",
                         "conditionally-available": false,
                         "construct": false,
                         "construct-only": false,
                         "controllable": false,
-                        "default": "5",
+                        "default": "15",
                         "max": "-1",
                         "min": "0",
                         "mutable": "null",
                         "readable": true,
                         "type": "guint",
                         "writable": true
-                    },
-                    "playlist-location": {
-                        "blurb": "Location of the playlist to write.",
+                    }
+                },
+                "rank": "none"
+            }
+        },
+        "filename": "gsthlssink3",
+        "license": "MPL",
+        "other-types": {
+            "GstHlsBaseSink": {
+                "hierarchy": [
+                    "GstHlsBaseSink",
+                    "GstBin",
+                    "GstElement",
+                    "GstObject",
+                    "GInitiallyUnowned",
+                    "GObject"
+                ],
+                "interfaces": [
+                    "GstChildProxy"
+                ],
+                "kind": "object",
+                "properties": {
+                    "enable-endlist": {
+                        "blurb": "Write \"EXT-X-ENDLIST\" tag to manifest at the end of stream",
                         "conditionally-available": false,
                         "construct": false,
                         "construct-only": false,
                         "controllable": false,
-                        "default": "playlist.m3u8",
+                        "default": "true",
                         "mutable": "null",
                         "readable": true,
-                        "type": "gchararray",
+                        "type": "gboolean",
                         "writable": true
                     },
-                    "playlist-root": {
-                        "blurb": "Base path for the segments in the playlist file.",
+                    "enable-program-date-time": {
+                        "blurb": "put EXT-X-PROGRAM-DATE-TIME tag in the playlist",
                         "conditionally-available": false,
                         "construct": false,
                         "construct-only": false,
                         "controllable": false,
-                        "default": "NULL",
+                        "default": "false",
                         "mutable": "null",
                         "readable": true,
-                        "type": "gchararray",
+                        "type": "gboolean",
                         "writable": true
                     },
-                    "playlist-type": {
-                        "blurb": "The type of the playlist to use. When VOD type is set, the playlist will be live until the pipeline ends execution.",
+                    "max-files": {
+                        "blurb": "Maximum number of files to keep on disk. Once the maximum is reached, old files start to be deleted to make room for new ones.",
                         "conditionally-available": false,
                         "construct": false,
                         "construct-only": false,
                         "controllable": false,
-                        "default": "unspecified (0)",
+                        "default": "10",
+                        "max": "-1",
+                        "min": "0",
                         "mutable": "null",
                         "readable": true,
-                        "type": "GstHlsSink3PlaylistType",
+                        "type": "guint",
                         "writable": true
                     },
-                    "send-keyframe-requests": {
-                        "blurb": "Send keyframe requests to ensure correct fragmentation. If this is disabled then the input must have keyframes in regular intervals.",
+                    "pdt-follows-pipeline-clock": {
+                        "blurb": "As there might be drift between the wallclock and pipeline clock, this controls whether the Program-Date-Time markers should follow the pipeline clock rate (true), or be skewed to match the wallclock rate (false).",
                         "conditionally-available": false,
                         "construct": false,
                         "construct-only": false,
@@ -2310,22 +2434,45 @@
                         "type": "gboolean",
                         "writable": true
                     },
-                    "target-duration": {
-                        "blurb": "The target duration in seconds of a segment/file. (0 - disabled, useful for management of segment duration by the streaming server)",
+                    "playlist-length": {
+                        "blurb": "Length of HLS playlist. To allow players to conform to section 6.3.3 of the HLS specification, this should be at least 3. If set to 0, the playlist will be infinite.",
                         "conditionally-available": false,
                         "construct": false,
                         "construct-only": false,
                         "controllable": false,
-                        "default": "15",
+                        "default": "5",
                         "max": "-1",
                         "min": "0",
                         "mutable": "null",
                         "readable": true,
                         "type": "guint",
                         "writable": true
+                    },
+                    "playlist-location": {
+                        "blurb": "Location of the playlist to write.",
+                        "conditionally-available": false,
+                        "construct": false,
+                        "construct-only": false,
+                        "controllable": false,
+                        "default": "playlist.m3u8",
+                        "mutable": "null",
+                        "readable": true,
+                        "type": "gchararray",
+                        "writable": true
+                    },
+                    "playlist-root": {
+                        "blurb": "Base path for the segments in the playlist file.",
+                        "conditionally-available": false,
+                        "construct": false,
+                        "construct-only": false,
+                        "controllable": false,
+                        "default": "NULL",
+                        "mutable": "null",
+                        "readable": true,
+                        "type": "gchararray",
+                        "writable": true
                     }
                 },
-                "rank": "none",
                 "signals": {
                     "delete-fragment": {
                         "args": [
@@ -2358,11 +2505,7 @@
                         "when": "last"
                     }
                 }
-            }
-        },
-        "filename": "gsthlssink3",
-        "license": "MPL",
-        "other-types": {
+            },
             "GstHlsSink3PlaylistType": {
                 "kind": "enum",
                 "values": [