mirrors/gstreamer
mirrors/gstreamer
1
1
Fork 0
mirror of https://gitlab.freedesktop.org/gstreamer/gstreamer.git synced 2025-04-26 06:54:49 +00:00
Code Issues 1 Projects Releases Wiki Activity

doc: Add signal flags information in the plugin cache

Browse source 
Updating the plugin cache file
Same behavior as g-ir as the signal flags don't have a GType associated.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/463>
This commit is contained in:
Thibault Saunier 2020-05-05 13:20:10 -04:00
parent 96ebee1dc8
commit 416d4a13e0
2 changed files with 128 additions and 24 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
docs/gst-hotdoc-plugins-scanner.c
View file

@ -274,6 +274,25 @@ _add_signals (GString * json, GObject * object)
} }
g_string_append_c (json, ']'); g_string_append_c (json, ']');
if (query->signal_flags & G_SIGNAL_RUN_FIRST)
g_string_append (json, ",\"when\": \"first\"");
else if (query->signal_flags & G_SIGNAL_RUN_LAST)
g_string_append (json, ",\"when\": \"last\"");
else if (query->signal_flags & G_SIGNAL_RUN_CLEANUP)
g_string_append (json, ",\"when\": \"cleanup\"");
if (query->signal_flags & G_SIGNAL_NO_RECURSE)
g_string_append (json, ",\"no-recurse\": true");
if (query->signal_flags & G_SIGNAL_DETAILED)
g_string_append (json, ",\"detailed\": true");
if (query->signal_flags & G_SIGNAL_ACTION)
g_string_append (json, ",\"action\": true");
if (query->signal_flags & G_SIGNAL_NO_HOOKS)
g_string_append (json, ",\"no-hooks\": true");
if (g_type_is_a (query->return_type, G_TYPE_ENUM)) { if (g_type_is_a (query->return_type, G_TYPE_ENUM)) {
g_string_append_c (json, ','); g_string_append_c (json, ',');
_serialize_enum (json, "return-values", query->return_type, NULL); _serialize_enum (json, "return-values", query->return_type, NULL);

133
docs/plugins/gst_plugins_cache.json
View file

@ -318,7 +318,7 @@
}, },
"properties": { "properties": {
"high-percent": { "high-percent": {
"blurb": "High threshold for buffering to finish. Only used if use-buffering is True", "blurb": "High threshold for buffering to finish. Emits GST_MESSAGE_BUFFERING with a value of 100%%",
"construct": false, "construct": false,
"construct-only": false, "construct-only": false,
"default": "99", "default": "99",
@ -328,7 +328,7 @@
"writable": true "writable": true
}, },
"low-percent": { "low-percent": {
"blurb": "Low threshold for buffering to start. Only used if use-buffering is True", "blurb": "Low threshold for buffering to start. Emits GST_MESSAGE_BUFFERING with a value of 0%%",
"construct": false, "construct": false,
"construct-only": false, "construct-only": false,
"default": "10", "default": "10",
@ -539,7 +539,7 @@
"writable": true "writable": true
}, },
"processing-deadline": { "processing-deadline": {
"blurb": "Maximum processing deadline in nanoseconds", "blurb": "Maximum processing time for a buffer in nanoseconds",
"construct": false, "construct": false,
"construct-only": false, "construct-only": false,
"default": "20000000", "default": "20000000",
@ -672,14 +672,16 @@
"GstBuffer", "GstBuffer",
"GstPad" "GstPad"
], ],
"retval": "void" "retval": "void",
"when": "last"
}, },
"preroll-handoff": { "preroll-handoff": {
"args": [ "args": [
"GstBuffer", "GstBuffer",
"GstPad" "GstPad"
], ],
"retval": "void" "retval": "void",
"when": "last"
} }
} }
}, },
@ -999,7 +1001,8 @@
"GstBuffer", "GstBuffer",
"GstPad" "GstPad"
], ],
"retval": "void" "retval": "void",
"when": "last"
} }
} }
}, },
@ -1103,7 +1106,7 @@
"writable": true "writable": true
}, },
"processing-deadline": { "processing-deadline": {
"blurb": "Maximum processing deadline in nanoseconds", "blurb": "Maximum processing time for a buffer in nanoseconds",
"construct": false, "construct": false,
"construct-only": false, "construct-only": false,
"default": "20000000", "default": "20000000",
@ -1430,7 +1433,7 @@
"writable": true "writable": true
}, },
"processing-deadline": { "processing-deadline": {
"blurb": "Maximum processing deadline in nanoseconds", "blurb": "Maximum processing time for a buffer in nanoseconds",
"construct": false, "construct": false,
"construct-only": false, "construct-only": false,
"default": "20000000", "default": "20000000",
@ -1898,7 +1901,8 @@
"args": [ "args": [
"GstBuffer" "GstBuffer"
], ],
"retval": "void" "retval": "void",
"when": "last"
} }
} }
}, },
@ -2068,6 +2072,36 @@
"GObject" "GObject"
], ],
"properties": { "properties": {
"current-level-buffers": {
"blurb": "Current level buffers",
"construct": false,
"construct-only": false,
"default": "0",
"max": "-1",
"min": "0",
"type-name": "guint",
"writable": false
},
"current-level-bytes": {
"blurb": "Current level bytes",
"construct": false,
"construct-only": false,
"default": "0",
"max": "-1",
"min": "0",
"type-name": "guint",
"writable": false
},
"current-level-time": {
"blurb": "Current level time",
"construct": false,
"construct-only": false,
"default": "0",
"max": "18446744073709551615",
"min": "0",
"type-name": "guint64",
"writable": false
},
"group-id": { "group-id": {
"blurb": "Group to which this pad belongs", "blurb": "Group to which this pad belongs",
"construct": false, "construct": false,
@ -2094,6 +2128,36 @@
"GObject" "GObject"
], ],
"properties": { "properties": {
"current-level-buffers": {
"blurb": "Current level buffers",
"construct": false,
"construct-only": false,
"default": "0",
"max": "-1",
"min": "0",
"type-name": "guint",
"writable": false
},
"current-level-bytes": {
"blurb": "Current level bytes",
"construct": false,
"construct-only": false,
"default": "0",
"max": "-1",
"min": "0",
"type-name": "guint",
"writable": false
},
"current-level-time": {
"blurb": "Current level time",
"construct": false,
"construct-only": false,
"default": "0",
"max": "18446744073709551615",
"min": "0",
"type-name": "guint64",
"writable": false
},
"group-id": { "group-id": {
"blurb": "Group to which this pad belongs", "blurb": "Group to which this pad belongs",
"construct": false, "construct": false,
@ -2235,6 +2299,14 @@
"type-name": "GstObject", "type-name": "GstObject",
"writable": true "writable": true
}, },
"stats": {
"blurb": "Multiqueue Statistics",
"construct": false,
"construct-only": false,
"default": "application/x-gst-multi-queue-stats;",
"type-name": "GstStructure",
"writable": false
},
"sync-by-running-time": { "sync-by-running-time": {
"blurb": "Synchronize deactivated or not-linked streams by running time", "blurb": "Synchronize deactivated or not-linked streams by running time",
"construct": false, "construct": false,
@ -2254,7 +2326,7 @@
"writable": true "writable": true
}, },
"use-buffering": { "use-buffering": {
"blurb": "Emit GST_MESSAGE_BUFFERING based on low-/high-percent thresholds", "blurb": "Emit GST_MESSAGE_BUFFERING based on low-/high-percent thresholds (0%% = low-watermark, 100%% = high-watermark)",
"construct": false, "construct": false,
"construct-only": false, "construct-only": false,
"default": "false", "default": "false",
@ -2274,27 +2346,32 @@
"signals": { "signals": {
"no-more-pads": { "no-more-pads": {
"args": [], "args": [],
"retval": "void" "retval": "void",
"when": "last"
}, },
"overrun": { "overrun": {
"args": [], "args": [],
"retval": "void" "retval": "void",
"when": "first"
}, },
"pad-added": { "pad-added": {
"args": [ "args": [
"GstPad" "GstPad"
], ],
"retval": "void" "retval": "void",
"when": "last"
}, },
"pad-removed": { "pad-removed": {
"args": [ "args": [
"GstPad" "GstPad"
], ],
"retval": "void" "retval": "void",
"when": "last"
}, },
"underrun": { "underrun": {
"args": [], "args": [],
"retval": "void" "retval": "void",
"when": "first"
} }
} }
}, },
@ -2559,19 +2636,23 @@
"signals": { "signals": {
"overrun": { "overrun": {
"args": [], "args": [],
"retval": "void" "retval": "void",
"when": "first"
}, },
"pushing": { "pushing": {
"args": [], "args": [],
"retval": "void" "retval": "void",
"when": "first"
}, },
"running": { "running": {
"args": [], "args": [],
"retval": "void" "retval": "void",
"when": "first"
}, },
"underrun": { "underrun": {
"args": [], "args": [],
"retval": "void" "retval": "void",
"when": "first"
} }
} }
}, },
@ -2778,7 +2859,7 @@
"writable": true "writable": true
}, },
"use-buffering": { "use-buffering": {
"blurb": "Emit GST_MESSAGE_BUFFERING based on low-/high-percent thresholds", "blurb": "Emit GST_MESSAGE_BUFFERING based on low-/high-percent thresholds (0%% = low-watermark, 100%% = high-watermark)",
"construct": false, "construct": false,
"construct-only": false, "construct-only": false,
"default": "false", "default": "false",
@ -2856,19 +2937,22 @@
"signals": { "signals": {
"no-more-pads": { "no-more-pads": {
"args": [], "args": [],
"retval": "void" "retval": "void",
"when": "last"
}, },
"pad-added": { "pad-added": {
"args": [ "args": [
"GstPad" "GstPad"
], ],
"retval": "void" "retval": "void",
"when": "last"
}, },
"pad-removed": { "pad-removed": {
"args": [ "args": [
"GstPad" "GstPad"
], ],
"retval": "void" "retval": "void",
"when": "last"
} }
} }
}, },
@ -3057,7 +3141,8 @@
"guint", "guint",
"GstCaps" "GstCaps"
], ],
"retval": "void" "retval": "void",
"when": "last"
} }
} }
}, },