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

   1 {
   2     "rtspclientsink": {
   3         "description": "RTSP client sink element",
   4         "elements": {
   5             "rtspclientsink": {
   6                 "author": "Jan Schmidt <jan@centricular.com>",
   7                 "description": "Send data over the network via RTSP RECORD(RFC 2326)",
   8                 "hierarchy": [
   9                     "GstRTSPClientSink",
  10                     "GstBin",
  11                     "GstElement",
  12                     "GstObject",
  13                     "GInitiallyUnowned",
  14                     "GObject"
  15                 ],
  16                 "interfaces": [
  17                     "GstChildProxy",
  18                     "GstURIHandler"
  19                 ],
  20                 "klass": "Sink/Network",
  21                 "long-name": "RTSP RECORD client",
  22                 "pad-templates": {
  23                     "sink_%%u": {
  24                         "caps": "ANY",
  25                         "direction": "sink",
  26                         "presence": "request",
  27                         "type": "GstRtspClientSinkPad"
  28                     }
  29                 },
  30                 "properties": {
  31                     "debug": {
  32                         "blurb": "Dump request and response messages to stdout",
  33                         "conditionally-available": false,
  34                         "construct": false,
  35                         "construct-only": false,
  36                         "controllable": false,
  37                         "default": "false",
  38                         "mutable": "null",
  39                         "readable": true,
  40                         "type": "gboolean",
  41                         "writable": true
  42                     },
  43                     "do-rtsp-keep-alive": {
  44                         "blurb": "Send RTSP keep alive packets, disable for old incompatible server.",
  45                         "conditionally-available": false,
  46                         "construct": false,
  47                         "construct-only": false,
  48                         "controllable": false,
  49                         "default": "true",
  50                         "mutable": "null",
  51                         "readable": true,
  52                         "type": "gboolean",
  53                         "writable": true
  54                     },
  55                     "latency": {
  56                         "blurb": "Amount of ms to buffer",
  57                         "conditionally-available": false,
  58                         "construct": false,
  59                         "construct-only": false,
  60                         "controllable": false,
  61                         "default": "2000",
  62                         "max": "-1",
  63                         "min": "0",
  64                         "mutable": "null",
  65                         "readable": true,
  66                         "type": "guint",
  67                         "writable": true
  68                     },
  69                     "location": {
  70                         "blurb": "Location of the RTSP url to read",
  71                         "conditionally-available": false,
  72                         "construct": false,
  73                         "construct-only": false,
  74                         "controllable": false,
  75                         "default": "NULL",
  76                         "mutable": "null",
  77                         "readable": true,
  78                         "type": "gchararray",
  79                         "writable": true
  80                     },
  81                     "multicast-iface": {
  82                         "blurb": "The network interface on which to join the multicast group",
  83                         "conditionally-available": false,
  84                         "construct": false,
  85                         "construct-only": false,
  86                         "controllable": false,
  87                         "default": "NULL",
  88                         "mutable": "null",
  89                         "readable": true,
  90                         "type": "gchararray",
  91                         "writable": true
  92                     },
  93                     "ntp-time-source": {
  94                         "blurb": "NTP time source for RTCP packets",
  95                         "conditionally-available": false,
  96                         "construct": false,
  97                         "construct-only": false,
  98                         "controllable": false,
  99                         "default": "ntp (0)",
 100                         "mutable": "null",
 101                         "readable": true,
 102                         "type": "GstRTSPClientSinkNtpTimeSource",
 103                         "writable": true
 104                     },
 105                     "port-range": {
 106                         "blurb": "Client port range that can be used to receive RTCP data, eg. 3000-3005 (NULL = no restrictions)",
 107                         "conditionally-available": false,
 108                         "construct": false,
 109                         "construct-only": false,
 110                         "controllable": false,
 111                         "default": "NULL",
 112                         "mutable": "null",
 113                         "readable": true,
 114                         "type": "gchararray",
 115                         "writable": true
 116                     },
 117                     "profiles": {
 118                         "blurb": "Allowed RTSP profiles",
 119                         "conditionally-available": false,
 120                         "construct": false,
 121                         "construct-only": false,
 122                         "controllable": false,
 123                         "default": "avp",
 124                         "mutable": "null",
 125                         "readable": true,
 126                         "type": "GstRTSPProfile",
 127                         "writable": true
 128                     },
 129                     "protocols": {
 130                         "blurb": "Allowed lower transport protocols",
 131                         "conditionally-available": false,
 132                         "construct": false,
 133                         "construct-only": false,
 134                         "controllable": false,
 135                         "default": "tcp+udp-mcast+udp",
 136                         "mutable": "null",
 137                         "readable": true,
 138                         "type": "GstRTSPLowerTrans",
 139                         "writable": true
 140                     },
 141                     "proxy": {
 142                         "blurb": "Proxy settings for HTTP tunneling. Format: [http://][user:passwd@]host[:port]",
 143                         "conditionally-available": false,
 144                         "construct": false,
 145                         "construct-only": false,
 146                         "controllable": false,
 147                         "default": "NULL",
 148                         "mutable": "null",
 149                         "readable": true,
 150                         "type": "gchararray",
 151                         "writable": true
 152                     },
 153                     "proxy-id": {
 154                         "blurb": "HTTP proxy URI user id for authentication",
 155                         "conditionally-available": false,
 156                         "construct": false,
 157                         "construct-only": false,
 158                         "controllable": false,
 159                         "default": "NULL",
 160                         "mutable": "null",
 161                         "readable": true,
 162                         "type": "gchararray",
 163                         "writable": true
 164                     },
 165                     "proxy-pw": {
 166                         "blurb": "HTTP proxy URI user password for authentication",
 167                         "conditionally-available": false,
 168                         "construct": false,
 169                         "construct-only": false,
 170                         "controllable": false,
 171                         "default": "NULL",
 172                         "mutable": "null",
 173                         "readable": true,
 174                         "type": "gchararray",
 175                         "writable": true
 176                     },
 177                     "retry": {
 178                         "blurb": "Max number of retries when allocating RTP ports.",
 179                         "conditionally-available": false,
 180                         "construct": false,
 181                         "construct-only": false,
 182                         "controllable": false,
 183                         "default": "20",
 184                         "max": "65535",
 185                         "min": "0",
 186                         "mutable": "null",
 187                         "readable": true,
 188                         "type": "guint",
 189                         "writable": true
 190                     },
 191                     "rtp-blocksize": {
 192                         "blurb": "RTP package size to suggest to server (0 = disabled)",
 193                         "conditionally-available": false,
 194                         "construct": false,
 195                         "construct-only": false,
 196                         "controllable": false,
 197                         "default": "0",
 198                         "max": "65536",
 199                         "min": "0",
 200                         "mutable": "null",
 201                         "readable": true,
 202                         "type": "guint",
 203                         "writable": true
 204                     },
 205                     "rtx-time": {
 206                         "blurb": "Amount of ms to buffer for retransmission. 0 disables retransmission",
 207                         "conditionally-available": false,
 208                         "construct": false,
 209                         "construct-only": false,
 210                         "controllable": false,
 211                         "default": "500",
 212                         "max": "-1",
 213                         "min": "0",
 214                         "mutable": "null",
 215                         "readable": true,
 216                         "type": "guint",
 217                         "writable": true
 218                     },
 219                     "sdes": {
 220                         "blurb": "The SDES items of this session",
 221                         "conditionally-available": false,
 222                         "construct": false,
 223                         "construct-only": false,
 224                         "controllable": false,
 225                         "mutable": "null",
 226                         "readable": true,
 227                         "type": "GstStructure",
 228                         "writable": true
 229                     },
 230                     "tcp-timeout": {
 231                         "blurb": "Fail after timeout microseconds on TCP connections (0 = disabled)",
 232                         "conditionally-available": false,
 233                         "construct": false,
 234                         "construct-only": false,
 235                         "controllable": false,
 236                         "default": "20000000",
 237                         "max": "18446744073709551615",
 238                         "min": "0",
 239                         "mutable": "null",
 240                         "readable": true,
 241                         "type": "guint64",
 242                         "writable": true
 243                     },
 244                     "timeout": {
 245                         "blurb": "Retry TCP transport after UDP timeout microseconds (0 = disabled)",
 246                         "conditionally-available": false,
 247                         "construct": false,
 248                         "construct-only": false,
 249                         "controllable": false,
 250                         "default": "5000000",
 251                         "max": "18446744073709551615",
 252                         "min": "0",
 253                         "mutable": "null",
 254                         "readable": true,
 255                         "type": "guint64",
 256                         "writable": true
 257                     },
 258                     "tls-database": {
 259                         "blurb": "TLS database with anchor certificate authorities used to validate the server certificate",
 260                         "conditionally-available": false,
 261                         "construct": false,
 262                         "construct-only": false,
 263                         "controllable": false,
 264                         "mutable": "null",
 265                         "readable": true,
 266                         "type": "GTlsDatabase",
 267                         "writable": true
 268                     },
 269                     "tls-interaction": {
 270                         "blurb": "A GTlsInteraction object to prompt the user for password or certificate",
 271                         "conditionally-available": false,
 272                         "construct": false,
 273                         "construct-only": false,
 274                         "controllable": false,
 275                         "mutable": "null",
 276                         "readable": true,
 277                         "type": "GTlsInteraction",
 278                         "writable": true
 279                     },
 280                     "tls-validation-flags": {
 281                         "blurb": "TLS certificate validation flags used to validate the server certificate",
 282                         "conditionally-available": false,
 283                         "construct": false,
 284                         "construct-only": false,
 285                         "controllable": false,
 286                         "default": "validate-all",
 287                         "mutable": "null",
 288                         "readable": true,
 289                         "type": "GTlsCertificateFlags",
 290                         "writable": true
 291                     },
 292                     "udp-buffer-size": {
 293                         "blurb": "Size of the kernel UDP receive buffer in bytes, 0=default",
 294                         "conditionally-available": false,
 295                         "construct": false,
 296                         "construct-only": false,
 297                         "controllable": false,
 298                         "default": "524288",
 299                         "max": "2147483647",
 300                         "min": "0",
 301                         "mutable": "null",
 302                         "readable": true,
 303                         "type": "gint",
 304                         "writable": true
 305                     },
 306                     "udp-reconnect": {
 307                         "blurb": "Reconnect to the server if RTSP connection is closed when doing UDP",
 308                         "conditionally-available": false,
 309                         "construct": false,
 310                         "construct-only": false,
 311                         "controllable": false,
 312                         "default": "true",
 313                         "mutable": "null",
 314                         "readable": true,
 315                         "type": "gboolean",
 316                         "writable": true
 317                     },
 318                     "user-agent": {
 319                         "blurb": "The User-Agent string to send to the server",
 320                         "conditionally-available": false,
 321                         "construct": false,
 322                         "construct-only": false,
 323                         "controllable": false,
 324                         "default": "GStreamer/1.21.2",
 325                         "mutable": "null",
 326                         "readable": true,
 327                         "type": "gchararray",
 328                         "writable": true
 329                     },
 330                     "user-id": {
 331                         "blurb": "RTSP location URI user id for authentication",
 332                         "conditionally-available": false,
 333                         "construct": false,
 334                         "construct-only": false,
 335                         "controllable": false,
 336                         "default": "NULL",
 337                         "mutable": "null",
 338                         "readable": true,
 339                         "type": "gchararray",
 340                         "writable": true
 341                     },
 342                     "user-pw": {
 343                         "blurb": "RTSP location URI user password for authentication",
 344                         "conditionally-available": false,
 345                         "construct": false,
 346                         "construct-only": false,
 347                         "controllable": false,
 348                         "default": "NULL",
 349                         "mutable": "null",
 350                         "readable": true,
 351                         "type": "gchararray",
 352                         "writable": true
 353                     }
 354                 },
 355                 "rank": "none",
 356                 "signals": {
 357                     "accept-certificate": {
 358                         "args": [
 359                             {
 360                                 "name": "arg0",
 361                                 "type": "GTlsConnection"
 362                             },
 363                             {
 364                                 "name": "arg1",
 365                                 "type": "GTlsCertificate"
 366                             },
 367                             {
 368                                 "name": "arg2",
 369                                 "type": "GTlsCertificateFlags"
 370                             }
 371                         ],
 372                         "return-type": "gboolean",
 373                         "when": "last"
 374                     },
 375                     "handle-request": {
 376                         "args": [
 377                             {
 378                                 "name": "arg0",
 379                                 "type": "GstRTSPMessage"
 380                             },
 381                             {
 382                                 "name": "arg1",
 383                                 "type": "GstRTSPMessage"
 384                             }
 385                         ],
 386                         "return-type": "void"
 387                     },
 388                     "new-manager": {
 389                         "args": [
 390                             {
 391                                 "name": "arg0",
 392                                 "type": "GstElement"
 393                             }
 394                         ],
 395                         "return-type": "void",
 396                         "when": "first"
 397                     },
 398                     "new-payloader": {
 399                         "args": [
 400                             {
 401                                 "name": "arg0",
 402                                 "type": "GstElement"
 403                             }
 404                         ],
 405                         "return-type": "void",
 406                         "when": "first"
 407                     },
 408                     "request-rtcp-key": {
 409                         "args": [
 410                             {
 411                                 "name": "arg0",
 412                                 "type": "guint"
 413                             }
 414                         ],
 415                         "return-type": "GstCaps",
 416                         "when": "last"
 417                     },
 418                     "update-sdp": {
 419                         "args": [
 420                             {
 421                                 "name": "arg0",
 422                                 "type": "GstSDPMessage"
 423                             }
 424                         ],
 425                         "return-type": "void"
 426                     }
 427                 }
 428             }
 429         },
 430         "filename": "gstrtspclientsink",
 431         "license": "LGPL",
 432         "other-types": {
 433             "GstRTSPClientSinkNtpTimeSource": {
 434                 "kind": "enum",
 435                 "values": [
 436                     {
 437                         "desc": "NTP time based on realtime clock",
 438                         "name": "ntp",
 439                         "value": "0"
 440                     },
 441                     {
 442                         "desc": "UNIX time based on realtime clock",
 443                         "name": "unix",
 444                         "value": "1"
 445                     },
 446                     {
 447                         "desc": "Running time based on pipeline clock",
 448                         "name": "running-time",
 449                         "value": "2"
 450                     },
 451                     {
 452                         "desc": "Pipeline clock time",
 453                         "name": "clock-time",
 454                         "value": "3"
 455                     }
 456                 ]
 457             },
 458             "GstRtspClientSinkPad": {
 459                 "hierarchy": [
 460                     "GstRtspClientSinkPad",
 461                     "GstGhostPad",
 462                     "GstProxyPad",
 463                     "GstPad",
 464                     "GstObject",
 465                     "GInitiallyUnowned",
 466                     "GObject"
 467                 ],
 468                 "kind": "object",
 469                 "properties": {
 470                     "payloader": {
 471                         "blurb": "The payloader element to use (NULL = default automatically selected)",
 472                         "conditionally-available": false,
 473                         "construct": false,
 474                         "construct-only": false,
 475                         "controllable": false,
 476                         "mutable": "null",
 477                         "readable": true,
 478                         "type": "GstElement",
 479                         "writable": true
 480                     },
 481                     "ulpfec-percentage": {
 482                         "blurb": "The percentage of ULP redundancy to apply",
 483                         "conditionally-available": false,
 484                         "construct": false,
 485                         "construct-only": false,
 486                         "controllable": false,
 487                         "default": "0",
 488                         "max": "100",
 489                         "min": "0",
 490                         "mutable": "null",
 491                         "readable": true,
 492                         "type": "guint",
 493                         "writable": true
 494                     }
 495                 }
 496             }
 497         },
 498         "package": "GStreamer RTSP Server Library",
 499         "source": "gst-rtsp-server",
 500         "tracers": {},
 501         "url": "Unknown package origin"
 502     }
 503 }