docs: mark GstSRTSink and GstSRTSrc as plugin API

Part-of: <https://gitlab.freedesktop.org/gstreamer/gstreamer/-/merge_requests/4408>
This commit is contained in:
Mathieu Duponchelle 2023-04-13 01:10:42 +02:00 committed by GStreamer Marge Bot
parent 6a27fe8955
commit 6c25caa572
3 changed files with 488 additions and 0 deletions

View file

@ -231274,6 +231274,491 @@
"value": "32"
}
]
},
"GstSRTSink": {
"hierarchy": [
"GstSRTSink",
"GstBaseSink",
"GstElement",
"GstObject",
"GInitiallyUnowned",
"GObject"
],
"interfaces": [
"GstURIHandler"
],
"kind": "object",
"properties": {
"authentication": {
"blurb": "Authenticate a connection",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "true",
"mutable": "null",
"readable": true,
"type": "gboolean",
"writable": true
},
"auto-reconnect": {
"blurb": "Automatically reconnect when connection fails",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "true",
"mutable": "null",
"readable": true,
"type": "gboolean",
"writable": true
},
"latency": {
"blurb": "Minimum latency (milliseconds)",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "125",
"max": "2147483647",
"min": "0",
"mutable": "null",
"readable": true,
"type": "gint",
"writable": true
},
"localaddress": {
"blurb": "Local address to bind",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "NULL",
"mutable": "ready",
"readable": true,
"type": "gchararray",
"writable": true
},
"localport": {
"blurb": "Local port to bind",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "7001",
"max": "65535",
"min": "0",
"mutable": "ready",
"readable": true,
"type": "guint",
"writable": true
},
"mode": {
"blurb": "SRT connection mode",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "caller (1)",
"mutable": "ready",
"readable": true,
"type": "GstSRTConnectionMode",
"writable": true
},
"passphrase": {
"blurb": "Password for the encrypted transmission",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "",
"mutable": "ready",
"readable": false,
"type": "gchararray",
"writable": true
},
"pbkeylen": {
"blurb": "Crypto key length in bytes",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "no-key (0)",
"mutable": "ready",
"readable": true,
"type": "GstSRTKeyLength",
"writable": true
},
"poll-timeout": {
"blurb": "Return poll wait after timeout milliseconds (-1 = infinite)",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "1000",
"max": "2147483647",
"min": "-1",
"mutable": "ready",
"readable": true,
"type": "gint",
"writable": true
},
"stats": {
"blurb": "SRT Statistics",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "application/x-srt-statistics, bytes-sent-total=(guint64)0;",
"mutable": "null",
"readable": true,
"type": "GstStructure",
"writable": false
},
"streamid": {
"blurb": "Stream ID for the SRT access control",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "NULL",
"mutable": "ready",
"readable": true,
"type": "gchararray",
"writable": true
},
"uri": {
"blurb": "URI in the form of srt://address:port",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "srt://127.0.0.1:7001",
"mutable": "ready",
"readable": true,
"type": "gchararray",
"writable": true
},
"wait-for-connection": {
"blurb": "Block the stream until a client connects",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "true",
"mutable": "null",
"readable": true,
"type": "gboolean",
"writable": true
}
},
"signals": {
"caller-added": {
"args": [
{
"name": "arg0",
"type": "gint"
},
{
"name": "arg1",
"type": "GSocketAddress"
}
],
"return-type": "void",
"when": "last"
},
"caller-connecting": {
"args": [
{
"name": "arg0",
"type": "GSocketAddress"
},
{
"name": "arg1",
"type": "gchararray"
}
],
"return-type": "gboolean",
"when": "last"
},
"caller-rejected": {
"args": [
{
"name": "arg0",
"type": "GSocketAddress"
},
{
"name": "arg1",
"type": "gchararray"
}
],
"return-type": "void",
"when": "last"
},
"caller-removed": {
"args": [
{
"name": "arg0",
"type": "gint"
},
{
"name": "arg1",
"type": "GSocketAddress"
}
],
"return-type": "void",
"when": "last"
}
}
},
"GstSRTSrc": {
"hierarchy": [
"GstSRTSrc",
"GstPushSrc",
"GstBaseSrc",
"GstElement",
"GstObject",
"GInitiallyUnowned",
"GObject"
],
"interfaces": [
"GstURIHandler"
],
"kind": "object",
"properties": {
"authentication": {
"blurb": "Authenticate a connection",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "true",
"mutable": "null",
"readable": true,
"type": "gboolean",
"writable": true
},
"auto-reconnect": {
"blurb": "Automatically reconnect when connection fails",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "true",
"mutable": "null",
"readable": true,
"type": "gboolean",
"writable": true
},
"keep-listening": {
"blurb": "Toggle keep-listening for connection reuse",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "false",
"mutable": "null",
"readable": true,
"type": "gboolean",
"writable": true
},
"latency": {
"blurb": "Minimum latency (milliseconds)",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "125",
"max": "2147483647",
"min": "0",
"mutable": "null",
"readable": true,
"type": "gint",
"writable": true
},
"localaddress": {
"blurb": "Local address to bind",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "NULL",
"mutable": "ready",
"readable": true,
"type": "gchararray",
"writable": true
},
"localport": {
"blurb": "Local port to bind",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "7001",
"max": "65535",
"min": "0",
"mutable": "ready",
"readable": true,
"type": "guint",
"writable": true
},
"mode": {
"blurb": "SRT connection mode",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "caller (1)",
"mutable": "ready",
"readable": true,
"type": "GstSRTConnectionMode",
"writable": true
},
"passphrase": {
"blurb": "Password for the encrypted transmission",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "",
"mutable": "ready",
"readable": false,
"type": "gchararray",
"writable": true
},
"pbkeylen": {
"blurb": "Crypto key length in bytes",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "no-key (0)",
"mutable": "ready",
"readable": true,
"type": "GstSRTKeyLength",
"writable": true
},
"poll-timeout": {
"blurb": "Return poll wait after timeout milliseconds (-1 = infinite)",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "1000",
"max": "2147483647",
"min": "-1",
"mutable": "ready",
"readable": true,
"type": "gint",
"writable": true
},
"stats": {
"blurb": "SRT Statistics",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "application/x-srt-statistics, bytes-received-total=(guint64)0;",
"mutable": "null",
"readable": true,
"type": "GstStructure",
"writable": false
},
"streamid": {
"blurb": "Stream ID for the SRT access control",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "NULL",
"mutable": "ready",
"readable": true,
"type": "gchararray",
"writable": true
},
"uri": {
"blurb": "URI in the form of srt://address:port",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "srt://127.0.0.1:7001",
"mutable": "ready",
"readable": true,
"type": "gchararray",
"writable": true
},
"wait-for-connection": {
"blurb": "Block the stream until a client connects",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "true",
"mutable": "null",
"readable": true,
"type": "gboolean",
"writable": true
}
},
"signals": {
"caller-added": {
"args": [
{
"name": "arg0",
"type": "gint"
},
{
"name": "arg1",
"type": "GSocketAddress"
}
],
"return-type": "void",
"when": "last"
},
"caller-connecting": {
"args": [
{
"name": "arg0",
"type": "GSocketAddress"
},
{
"name": "arg1",
"type": "gchararray"
}
],
"return-type": "gboolean",
"when": "last"
},
"caller-rejected": {
"args": [
{
"name": "arg0",
"type": "GSocketAddress"
},
{
"name": "arg1",
"type": "gchararray"
}
],
"return-type": "void",
"when": "last"
},
"caller-removed": {
"args": [
{
"name": "arg0",
"type": "gint"
},
{
"name": "arg1",
"type": "GSocketAddress"
}
],
"return-type": "void",
"when": "last"
}
}
}
},
"package": "GStreamer Bad Plug-ins",

View file

@ -379,6 +379,7 @@ gst_srt_sink_class_init (GstSRTSinkClass * klass)
gstbasesink_class->unlock_stop = GST_DEBUG_FUNCPTR (gst_srt_sink_unlock_stop);
gstbasesink_class->set_caps = GST_DEBUG_FUNCPTR (gst_srt_sink_set_caps);
gst_type_mark_as_plugin_api (GST_TYPE_SRT_SINK, 0);
}
static GstURIType

View file

@ -476,6 +476,8 @@ gst_srt_src_class_init (GstSRTSrcClass * klass)
gstbasesrc_class->query = GST_DEBUG_FUNCPTR (gst_srt_src_query);
gstpushsrc_class->fill = GST_DEBUG_FUNCPTR (gst_srt_src_fill);
gst_type_mark_as_plugin_api (GST_TYPE_SRT_SRC, 0);
}
static GstURIType