gstreamer/subprojects/gst-rtsp-server/docs/gst_plugins_cache.json

503 lines
21 KiB
JSON
Raw Normal View History

2018-10-22 09:29:24 +00:00
{
"rtspclientsink": {
"description": "RTSP client sink element",
"elements": {
"rtspclientsink": {
"author": "Jan Schmidt <jan@centricular.com>",
"description": "Send data over the network via RTSP RECORD(RFC 2326)",
"hierarchy": [
"GstRTSPClientSink",
"GstBin",
"GstElement",
"GstObject",
"GInitiallyUnowned",
"GObject"
],
2020-05-27 14:00:05 +00:00
"interfaces": [
"GstChildProxy",
"GstURIHandler"
],
2018-10-22 09:29:24 +00:00
"klass": "Sink/Network",
"long-name": "RTSP RECORD client",
"pad-templates": {
"sink_%%u": {
"caps": "ANY",
"direction": "sink",
2020-05-27 14:00:05 +00:00
"presence": "request",
"type": "GstRtspClientSinkPad"
2018-10-22 09:29:24 +00:00
}
},
"properties": {
"debug": {
"blurb": "Dump request and response messages to stdout",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2018-10-22 09:29:24 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2018-10-22 09:29:24 +00:00
"default": "false",
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "gboolean",
2018-10-22 09:29:24 +00:00
"writable": true
},
"do-rtsp-keep-alive": {
"blurb": "Send RTSP keep alive packets, disable for old incompatible server.",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2018-10-22 09:29:24 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2018-10-22 09:29:24 +00:00
"default": "true",
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "gboolean",
2018-10-22 09:29:24 +00:00
"writable": true
},
"latency": {
"blurb": "Amount of ms to buffer",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2018-10-22 09:29:24 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2018-10-22 09:29:24 +00:00
"default": "2000",
"max": "-1",
"min": "0",
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "guint",
2018-10-22 09:29:24 +00:00
"writable": true
},
"location": {
"blurb": "Location of the RTSP url to read",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2018-10-22 09:29:24 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2018-10-22 09:29:24 +00:00
"default": "NULL",
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "gchararray",
2018-10-22 09:29:24 +00:00
"writable": true
},
"multicast-iface": {
"blurb": "The network interface on which to join the multicast group",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2018-10-22 09:29:24 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2018-10-22 09:29:24 +00:00
"default": "NULL",
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "gchararray",
2018-10-22 09:29:24 +00:00
"writable": true
},
"ntp-time-source": {
"blurb": "NTP time source for RTCP packets",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2018-10-22 09:29:24 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2018-10-22 09:29:24 +00:00
"default": "ntp (0)",
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "GstRTSPClientSinkNtpTimeSource",
2018-10-22 09:29:24 +00:00
"writable": true
},
"port-range": {
"blurb": "Client port range that can be used to receive RTCP data, eg. 3000-3005 (NULL = no restrictions)",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2018-10-22 09:29:24 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2018-10-22 09:29:24 +00:00
"default": "NULL",
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "gchararray",
2018-10-22 09:29:24 +00:00
"writable": true
},
"profiles": {
"blurb": "Allowed RTSP profiles",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2018-10-22 09:29:24 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2018-10-22 09:29:24 +00:00
"default": "avp",
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "GstRTSPProfile",
2018-10-22 09:29:24 +00:00
"writable": true
},
"protocols": {
"blurb": "Allowed lower transport protocols",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2018-10-22 09:29:24 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2018-10-22 09:29:24 +00:00
"default": "tcp+udp-mcast+udp",
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "GstRTSPLowerTrans",
2018-10-22 09:29:24 +00:00
"writable": true
},
"proxy": {
"blurb": "Proxy settings for HTTP tunneling. Format: [http://][user:passwd@]host[:port]",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2018-10-22 09:29:24 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2018-10-22 09:29:24 +00:00
"default": "NULL",
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "gchararray",
2018-10-22 09:29:24 +00:00
"writable": true
},
"proxy-id": {
"blurb": "HTTP proxy URI user id for authentication",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2018-10-22 09:29:24 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2018-10-22 09:29:24 +00:00
"default": "NULL",
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "gchararray",
2018-10-22 09:29:24 +00:00
"writable": true
},
"proxy-pw": {
"blurb": "HTTP proxy URI user password for authentication",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2018-10-22 09:29:24 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2018-10-22 09:29:24 +00:00
"default": "NULL",
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "gchararray",
2018-10-22 09:29:24 +00:00
"writable": true
},
"retry": {
"blurb": "Max number of retries when allocating RTP ports.",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2018-10-22 09:29:24 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2018-10-22 09:29:24 +00:00
"default": "20",
"max": "65535",
"min": "0",
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "guint",
2018-10-22 09:29:24 +00:00
"writable": true
},
"rtp-blocksize": {
"blurb": "RTP package size to suggest to server (0 = disabled)",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2018-10-22 09:29:24 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2018-10-22 09:29:24 +00:00
"default": "0",
"max": "65536",
"min": "0",
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "guint",
2018-10-22 09:29:24 +00:00
"writable": true
},
"rtx-time": {
"blurb": "Amount of ms to buffer for retransmission. 0 disables retransmission",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2018-10-22 09:29:24 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2018-10-22 09:29:24 +00:00
"default": "500",
"max": "-1",
"min": "0",
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "guint",
2018-10-22 09:29:24 +00:00
"writable": true
},
"sdes": {
"blurb": "The SDES items of this session",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2018-10-22 09:29:24 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "GstStructure",
2018-10-22 09:29:24 +00:00
"writable": true
},
"tcp-timeout": {
"blurb": "Fail after timeout microseconds on TCP connections (0 = disabled)",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2018-10-22 09:29:24 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2018-10-22 09:29:24 +00:00
"default": "20000000",
"max": "18446744073709551615",
"min": "0",
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "guint64",
2018-10-22 09:29:24 +00:00
"writable": true
},
"timeout": {
"blurb": "Retry TCP transport after UDP timeout microseconds (0 = disabled)",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2018-10-22 09:29:24 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2018-10-22 09:29:24 +00:00
"default": "5000000",
"max": "18446744073709551615",
"min": "0",
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "guint64",
2018-10-22 09:29:24 +00:00
"writable": true
},
"tls-database": {
"blurb": "TLS database with anchor certificate authorities used to validate the server certificate",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2018-10-22 09:29:24 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "GTlsDatabase",
2018-10-22 09:29:24 +00:00
"writable": true
},
"tls-interaction": {
"blurb": "A GTlsInteraction object to prompt the user for password or certificate",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2018-10-22 09:29:24 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "GTlsInteraction",
2018-10-22 09:29:24 +00:00
"writable": true
},
"tls-validation-flags": {
"blurb": "TLS certificate validation flags used to validate the server certificate",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2018-10-22 09:29:24 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2018-10-22 09:29:24 +00:00
"default": "validate-all",
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "GTlsCertificateFlags",
2018-10-22 09:29:24 +00:00
"writable": true
},
"udp-buffer-size": {
"blurb": "Size of the kernel UDP receive buffer in bytes, 0=default",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2018-10-22 09:29:24 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2018-10-22 09:29:24 +00:00
"default": "524288",
"max": "2147483647",
"min": "0",
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "gint",
2018-10-22 09:29:24 +00:00
"writable": true
},
"udp-reconnect": {
"blurb": "Reconnect to the server if RTSP connection is closed when doing UDP",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2018-10-22 09:29:24 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2018-10-22 09:29:24 +00:00
"default": "true",
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "gboolean",
2018-10-22 09:29:24 +00:00
"writable": true
},
"user-agent": {
"blurb": "The User-Agent string to send to the server",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2018-10-22 09:29:24 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2021-11-03 18:44:03 +00:00
"default": "GStreamer/1.19.3.1",
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "gchararray",
2018-10-22 09:29:24 +00:00
"writable": true
},
"user-id": {
"blurb": "RTSP location URI user id for authentication",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2018-10-22 09:29:24 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2018-10-22 09:29:24 +00:00
"default": "NULL",
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "gchararray",
2018-10-22 09:29:24 +00:00
"writable": true
},
"user-pw": {
"blurb": "RTSP location URI user password for authentication",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2018-10-22 09:29:24 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2018-10-22 09:29:24 +00:00
"default": "NULL",
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "gchararray",
2018-10-22 09:29:24 +00:00
"writable": true
}
},
"rank": "none",
"signals": {
"accept-certificate": {
"args": [
2020-05-27 14:00:05 +00:00
{
"name": "arg0",
"type": "GTlsConnection"
},
{
"name": "arg1",
"type": "GTlsCertificate"
},
{
"name": "arg2",
"type": "GTlsCertificateFlags"
}
2018-10-22 09:29:24 +00:00
],
2020-05-27 14:00:05 +00:00
"return-type": "gboolean",
"when": "last"
2018-10-22 09:29:24 +00:00
},
"handle-request": {
"args": [
2020-05-27 14:00:05 +00:00
{
"name": "arg0",
"type": "GstRTSPMessage"
2020-05-27 14:00:05 +00:00
},
{
"name": "arg1",
"type": "GstRTSPMessage"
2020-05-27 14:00:05 +00:00
}
2018-10-22 09:29:24 +00:00
],
2020-05-27 14:00:05 +00:00
"return-type": "void"
2018-10-22 09:29:24 +00:00
},
"new-manager": {
"args": [
2020-05-27 14:00:05 +00:00
{
"name": "arg0",
"type": "GstElement"
}
2018-10-22 09:29:24 +00:00
],
2020-05-27 14:00:05 +00:00
"return-type": "void",
"when": "first"
2018-10-22 09:29:24 +00:00
},
"new-payloader": {
"args": [
2020-05-27 14:00:05 +00:00
{
"name": "arg0",
"type": "GstElement"
}
2018-10-22 09:29:24 +00:00
],
2020-05-27 14:00:05 +00:00
"return-type": "void",
"when": "first"
2018-10-22 09:29:24 +00:00
},
"request-rtcp-key": {
"args": [
2020-05-27 14:00:05 +00:00
{
"name": "arg0",
"type": "guint"
}
2018-10-22 09:29:24 +00:00
],
2020-05-27 14:00:05 +00:00
"return-type": "GstCaps",
"when": "last"
},
"update-sdp": {
"args": [
{
"name": "arg0",
"type": "GstSDPMessage"
}
],
"return-type": "void"
2018-10-22 09:29:24 +00:00
}
}
}
},
"filename": "gstrtspclientsink",
2018-10-22 09:29:24 +00:00
"license": "LGPL",
2020-05-27 14:00:05 +00:00
"other-types": {
"GstRTSPClientSinkNtpTimeSource": {
"kind": "enum",
"values": [
{
"desc": "NTP time based on realtime clock",
"name": "ntp",
"value": "0"
},
{
"desc": "UNIX time based on realtime clock",
"name": "unix",
"value": "1"
},
{
"desc": "Running time based on pipeline clock",
"name": "running-time",
"value": "2"
},
{
"desc": "Pipeline clock time",
"name": "clock-time",
"value": "3"
}
]
},
"GstRtspClientSinkPad": {
"hierarchy": [
"GstRtspClientSinkPad",
"GstGhostPad",
"GstProxyPad",
"GstPad",
"GstObject",
"GInitiallyUnowned",
"GObject"
],
"kind": "object",
"properties": {
"payloader": {
"blurb": "The payloader element to use (NULL = default automatically selected)",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2020-05-27 14:00:05 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "GstElement",
"writable": true
},
"ulpfec-percentage": {
"blurb": "The percentage of ULP redundancy to apply",
2020-06-08 14:59:34 +00:00
"conditionally-available": false,
2020-05-27 14:00:05 +00:00
"construct": false,
"construct-only": false,
2020-06-08 14:59:34 +00:00
"controllable": false,
2020-05-27 14:00:05 +00:00
"default": "0",
"max": "100",
"min": "0",
2020-06-09 19:21:24 +00:00
"mutable": "null",
2020-05-27 14:00:05 +00:00
"readable": true,
"type": "guint",
"writable": true
}
}
}
},
2020-06-19 18:24:38 +00:00
"package": "GStreamer RTSP Server Library",
2018-10-22 09:29:24 +00:00
"source": "gst-rtsp-server",
2020-05-27 14:00:05 +00:00
"tracers": {},
2018-10-22 09:29:24 +00:00
"url": "Unknown package origin"
}
}