summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTim-Philipp Müller <tim@centricular.com>2020-07-01 12:35:32 +0100
committerTim-Philipp Müller <tim@centricular.com>2020-07-01 18:41:25 +0100
commitc229127b43c7a9ae5d11bafc2504f67691a2ea6d (patch)
tree774ecb21fde4b1f0c7141ff13a90faf895628a8b /docs
parent22a00d78ceca004ba3c933609a00e0207bb24ada (diff)
avtp: documentation fixes
Unclear why hotdoc wants 'gstavtp' as the plugin name here, that's just wrong. Add since marker and mark private subclasses as plugin API so hotdoc knows they belong to the plugin and aren't external. Fix GstAvtpAafTstampMode get_type() function.
Diffstat (limited to 'docs')
-rw-r--r--docs/plugins/gst_plugins_cache.json163
1 files changed, 162 insertions, 1 deletions
diff --git a/docs/plugins/gst_plugins_cache.json b/docs/plugins/gst_plugins_cache.json
index a89c8fe1c..cc487a4b0 100644
--- a/docs/plugins/gst_plugins_cache.json
+++ b/docs/plugins/gst_plugins_cache.json
@@ -2002,7 +2002,168 @@
},
"filename": "gstavtp",
"license": "LGPL",
- "other-types": {},
+ "other-types": {
+ "GstAvtpAafTstampMode": {
+ "kind": "enum",
+ "values": [
+ {
+ "desc": "Normal timestamping mode",
+ "name": "normal",
+ "value": "0"
+ },
+ {
+ "desc": "Sparse timestamping mode",
+ "name": "sparse",
+ "value": "1"
+ }
+ ]
+ },
+ "GstAvtpBaseDepayload": {
+ "hierarchy": [
+ "GstAvtpBaseDepayload",
+ "GstElement",
+ "GstObject",
+ "GInitiallyUnowned",
+ "GObject"
+ ],
+ "kind": "object",
+ "properties": {
+ "streamid": {
+ "blurb": "Stream ID associated with the AVTPDU",
+ "conditionally-available": false,
+ "construct": false,
+ "construct-only": false,
+ "controllable": false,
+ "default": "12302652060662169600",
+ "max": "18446744073709551615",
+ "min": "0",
+ "mutable": "paused",
+ "readable": true,
+ "type": "guint64",
+ "writable": true
+ }
+ }
+ },
+ "GstAvtpBasePayload": {
+ "hierarchy": [
+ "GstAvtpBasePayload",
+ "GstElement",
+ "GstObject",
+ "GInitiallyUnowned",
+ "GObject"
+ ],
+ "kind": "object",
+ "properties": {
+ "mtt": {
+ "blurb": "Maximum Transit Time (MTT) in nanoseconds",
+ "conditionally-available": false,
+ "construct": false,
+ "construct-only": false,
+ "controllable": false,
+ "default": "50000000",
+ "max": "-1",
+ "min": "0",
+ "mutable": "null",
+ "readable": true,
+ "type": "guint",
+ "writable": true
+ },
+ "processing-deadline": {
+ "blurb": "Maximum amount of time (in ns) the pipeline can take for processing the buffer",
+ "conditionally-available": false,
+ "construct": false,
+ "construct-only": false,
+ "controllable": false,
+ "default": "20000000",
+ "max": "18446744073709551615",
+ "min": "0",
+ "mutable": "null",
+ "readable": true,
+ "type": "guint64",
+ "writable": true
+ },
+ "streamid": {
+ "blurb": "Stream ID associated with the AVTPDU",
+ "conditionally-available": false,
+ "construct": false,
+ "construct-only": false,
+ "controllable": false,
+ "default": "12302652060662169600",
+ "max": "18446744073709551615",
+ "min": "0",
+ "mutable": "ready",
+ "readable": true,
+ "type": "guint64",
+ "writable": true
+ },
+ "tu": {
+ "blurb": "Timing Uncertainty (TU) in nanoseconds",
+ "conditionally-available": false,
+ "construct": false,
+ "construct-only": false,
+ "controllable": false,
+ "default": "1000000",
+ "max": "-1",
+ "min": "0",
+ "mutable": "null",
+ "readable": true,
+ "type": "guint",
+ "writable": true
+ }
+ }
+ },
+ "GstAvtpCrfBase": {
+ "hierarchy": [
+ "GstAvtpCrfBase",
+ "GstBaseTransform",
+ "GstElement",
+ "GstObject",
+ "GInitiallyUnowned",
+ "GObject"
+ ],
+ "kind": "object",
+ "properties": {
+ "address": {
+ "blurb": "Destination MAC address expected on the Ethernet frames",
+ "conditionally-available": false,
+ "construct": false,
+ "construct-only": false,
+ "controllable": false,
+ "default": "01:AA:AA:AA:AA:AA",
+ "mutable": "ready",
+ "readable": true,
+ "type": "gchararray",
+ "writable": true
+ },
+ "ifname": {
+ "blurb": "Network interface utilized to receive CRF AVTPDUs",
+ "conditionally-available": false,
+ "construct": false,
+ "construct-only": false,
+ "controllable": false,
+ "default": "eth0",
+ "mutable": "ready",
+ "readable": true,
+ "type": "gchararray",
+ "writable": true
+ },
+ "streamid": {
+ "blurb": "Stream ID associated with the CRF AVTPDU",
+ "conditionally-available": false,
+ "construct": false,
+ "construct-only": false,
+ "controllable": false,
+ "default": "12302652060662173696",
+ "max": "18446744073709551615",
+ "min": "0",
+ "mutable": "ready",
+ "readable": true,
+ "type": "guint64",
+ "writable": true
+ }
+ }
+ }
+ },
"package": "GStreamer Bad Plug-ins",
"source": "gst-plugins-bad",
"tracers": {},