Update docs for quinn elements

Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-plugins-rs/-/merge_requests/1634>
This commit is contained in:
Sanchayan Maity 2024-09-17 12:24:37 +05:30 committed by GStreamer Marge Bot
parent 5c829e6ca8
commit 46f1fb4430
2 changed files with 133 additions and 0 deletions

View file

@ -36,6 +36,7 @@ You will find the following plugins in this repository:
- `quinn`: Transfer data over the network using QUIC
- `quinnquicsink`/`quinnquicsrc`: Send and receive data using QUIC
- `quinnquicmux`/`quinnquicdemux`: Multiplex and de-multiplex streams and datagram using QUIC
- `raptorq`: Encoder/decoder element for RaptorQ RTP FEC mechanism.

View file

@ -5080,6 +5080,67 @@
"quinn": {
"description": "GStreamer Plugin for QUIC",
"elements": {
"quinnquicdemux": {
"author": "Sanchayan Maity <sanchayan@asymptotic.io>",
"description": "Demultiplexes multiple streams and datagram for QUIC",
"hierarchy": [
"GstQuinnQuicDemux",
"GstElement",
"GstObject",
"GInitiallyUnowned",
"GObject"
],
"klass": "Source/Network/QUIC",
"pad-templates": {
"datagram": {
"caps": "ANY",
"direction": "src",
"presence": "sometimes"
},
"sink": {
"caps": "ANY",
"direction": "sink",
"presence": "always"
},
"stream_%%u": {
"caps": "ANY",
"direction": "src",
"presence": "sometimes"
}
},
"rank": "none"
},
"quinnquicmux": {
"author": "Sanchayan Maity <sanchayan@asymptotic.io>",
"description": "Multiplexes multiple streams and datagram for QUIC",
"hierarchy": [
"GstQuinnQuicMux",
"GstElement",
"GstObject",
"GInitiallyUnowned",
"GObject"
],
"klass": "Source/Network/QUIC",
"pad-templates": {
"datagram": {
"caps": "ANY",
"direction": "sink",
"presence": "request"
},
"src": {
"caps": "ANY",
"direction": "src",
"presence": "always"
},
"stream_%%u": {
"caps": "ANY",
"direction": "sink",
"presence": "request",
"type": "QuinnQuicMuxPad"
}
},
"rank": "none"
},
"quinnquicsink": {
"author": "Sanchayan Maity <sanchayan@asymptotic.io>",
"description": "Send data over the network via QUIC",
@ -5255,6 +5316,20 @@
"type": "guint64",
"writable": true
},
"max-concurrent-uni-streams": {
"blurb": "Maximum number of incoming unidirectional streams that may be open concurrently",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "32",
"max": "18446744073709551615",
"min": "0",
"mutable": "null",
"readable": true,
"type": "guint64",
"writable": true
},
"max-udp-payload-size": {
"blurb": "Maximum UDP payload size accepted from peers (excluding UDP and IP overhead)",
"conditionally-available": false,
@ -5333,6 +5408,20 @@
"type": "gboolean",
"writable": true
},
"send-window": {
"blurb": "Maximum number of bytes to transmit to a peer without acknowledgment",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "10000000",
"max": "18446744073709551615",
"min": "0",
"mutable": "null",
"readable": true,
"type": "guint64",
"writable": true
},
"server-address": {
"blurb": "Address of the QUIC server to connect to e.g. 127.0.0.1",
"conditionally-available": false,
@ -5431,6 +5520,7 @@
"description": "Receive data over the network via QUIC",
"hierarchy": [
"GstQuinnQuicSrc",
"GstPushSrc",
"GstBaseSrc",
"GstElement",
"GstObject",
@ -5575,6 +5665,20 @@
"type": "guint64",
"writable": true
},
"max-concurrent-uni-streams": {
"blurb": "Maximum number of incoming unidirectional streams that may be open concurrently",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "32",
"max": "18446744073709551615",
"min": "0",
"mutable": "null",
"readable": true,
"type": "guint64",
"writable": true
},
"max-udp-payload-size": {
"blurb": "Maximum UDP payload size accepted from peers (excluding UDP and IP overhead)",
"conditionally-available": false,
@ -5629,6 +5733,20 @@
"type": "gchararray",
"writable": true
},
"receive-window": {
"blurb": "Maximum number of bytes the peer may transmit across all streams of a connection before becoming blocked",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "4611686018427387903",
"max": "4611686018427387903",
"min": "0",
"mutable": "null",
"readable": true,
"type": "guint64",
"writable": true
},
"role": {
"blurb": "QUIC connection role to use.",
"conditionally-available": false,
@ -5703,6 +5821,20 @@
"type": "GstStructure",
"writable": false
},
"stream-receive-window": {
"blurb": "Maximum number of bytes the peer may transmit without ACK on any one stream before becoming blocked",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "1250000",
"max": "4611686018427387903",
"min": "0",
"mutable": "null",
"readable": true,
"type": "guint64",
"writable": true
},
"timeout": {
"blurb": "Value in seconds to timeout QUIC endpoint requests (0 = No timeout).",
"conditionally-available": false,