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                     "publish-clock-mode": {
 178                         "blurb": "Clock publishing mode according to RFC7273",
 179                         "conditionally-available": false,
 180                         "construct": false,
 181                         "construct-only": false,
 182                         "controllable": false,
 183                         "default": "clock (1)",
 184                         "mutable": "null",
 185                         "readable": true,
 186                         "type": "GstRTSPPublishClockMode",
 187                         "writable": true
 188                     },
 189                     "retry": {
 190                         "blurb": "Max number of retries when allocating RTP ports.",
 191                         "conditionally-available": false,
 192                         "construct": false,
 193                         "construct-only": false,
 194                         "controllable": false,
 195                         "default": "20",
 196                         "max": "65535",
 197                         "min": "0",
 198                         "mutable": "null",
 199                         "readable": true,
 200                         "type": "guint",
 201                         "writable": true
 202                     },
 203                     "rtp-blocksize": {
 204                         "blurb": "RTP package size to suggest to server (0 = disabled)",
 205                         "conditionally-available": false,
 206                         "construct": false,
 207                         "construct-only": false,
 208                         "controllable": false,
 209                         "default": "0",
 210                         "max": "65536",
 211                         "min": "0",
 212                         "mutable": "null",
 213                         "readable": true,
 214                         "type": "guint",
 215                         "writable": true
 216                     },
 217                     "rtx-time": {
 218                         "blurb": "Amount of ms to buffer for retransmission. 0 disables retransmission",
 219                         "conditionally-available": false,
 220                         "construct": false,
 221                         "construct-only": false,
 222                         "controllable": false,
 223                         "default": "500",
 224                         "max": "-1",
 225                         "min": "0",
 226                         "mutable": "null",
 227                         "readable": true,
 228                         "type": "guint",
 229                         "writable": true
 230                     },
 231                     "sdes": {
 232                         "blurb": "The SDES items of this session",
 233                         "conditionally-available": false,
 234                         "construct": false,
 235                         "construct-only": false,
 236                         "controllable": false,
 237                         "mutable": "null",
 238                         "readable": true,
 239                         "type": "GstStructure",
 240                         "writable": true
 241                     },
 242                     "tcp-timeout": {
 243                         "blurb": "Fail after timeout microseconds on TCP connections (0 = disabled)",
 244                         "conditionally-available": false,
 245                         "construct": false,
 246                         "construct-only": false,
 247                         "controllable": false,
 248                         "default": "20000000",
 249                         "max": "18446744073709551615",
 250                         "min": "0",
 251                         "mutable": "null",
 252                         "readable": true,
 253                         "type": "guint64",
 254                         "writable": true
 255                     },
 256                     "timeout": {
 257                         "blurb": "Retry TCP transport after UDP timeout microseconds (0 = disabled)",
 258                         "conditionally-available": false,
 259                         "construct": false,
 260                         "construct-only": false,
 261                         "controllable": false,
 262                         "default": "5000000",
 263                         "max": "18446744073709551615",
 264                         "min": "0",
 265                         "mutable": "null",
 266                         "readable": true,
 267                         "type": "guint64",
 268                         "writable": true
 269                     },
 270                     "tls-database": {
 271                         "blurb": "TLS database with anchor certificate authorities used to validate the server certificate",
 272                         "conditionally-available": false,
 273                         "construct": false,
 274                         "construct-only": false,
 275                         "controllable": false,
 276                         "mutable": "null",
 277                         "readable": true,
 278                         "type": "GTlsDatabase",
 279                         "writable": true
 280                     },
 281                     "tls-interaction": {
 282                         "blurb": "A GTlsInteraction object to prompt the user for password or certificate",
 283                         "conditionally-available": false,
 284                         "construct": false,
 285                         "construct-only": false,
 286                         "controllable": false,
 287                         "mutable": "null",
 288                         "readable": true,
 289                         "type": "GTlsInteraction",
 290                         "writable": true
 291                     },
 292                     "tls-validation-flags": {
 293                         "blurb": "TLS certificate validation flags used to validate the server certificate",
 294                         "conditionally-available": false,
 295                         "construct": false,
 296                         "construct-only": false,
 297                         "controllable": false,
 298                         "default": "validate-all",
 299                         "mutable": "null",
 300                         "readable": true,
 301                         "type": "GTlsCertificateFlags",
 302                         "writable": true
 303                     },
 304                     "udp-buffer-size": {
 305                         "blurb": "Size of the kernel UDP receive buffer in bytes, 0=default",
 306                         "conditionally-available": false,
 307                         "construct": false,
 308                         "construct-only": false,
 309                         "controllable": false,
 310                         "default": "524288",
 311                         "max": "2147483647",
 312                         "min": "0",
 313                         "mutable": "null",
 314                         "readable": true,
 315                         "type": "gint",
 316                         "writable": true
 317                     },
 318                     "udp-reconnect": {
 319                         "blurb": "Reconnect to the server if RTSP connection is closed when doing UDP",
 320                         "conditionally-available": false,
 321                         "construct": false,
 322                         "construct-only": false,
 323                         "controllable": false,
 324                         "default": "true",
 325                         "mutable": "null",
 326                         "readable": true,
 327                         "type": "gboolean",
 328                         "writable": true
 329                     },
 330                     "user-agent": {
 331                         "blurb": "The User-Agent string to send to the server",
 332                         "conditionally-available": false,
 333                         "construct": false,
 334                         "construct-only": false,
 335                         "controllable": false,
 336                         "default": "GStreamer/1.22.3.1",
 337                         "mutable": "null",
 338                         "readable": true,
 339                         "type": "gchararray",
 340                         "writable": true
 341                     },
 342                     "user-id": {
 343                         "blurb": "RTSP location URI user id 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                     "user-pw": {
 355                         "blurb": "RTSP location URI user password for authentication",
 356                         "conditionally-available": false,
 357                         "construct": false,
 358                         "construct-only": false,
 359                         "controllable": false,
 360                         "default": "NULL",
 361                         "mutable": "null",
 362                         "readable": true,
 363                         "type": "gchararray",
 364                         "writable": true
 365                     }
 366                 },
 367                 "rank": "none",
 368                 "signals": {
 369                     "accept-certificate": {
 370                         "args": [
 371                             {
 372                                 "name": "arg0",
 373                                 "type": "GTlsConnection"
 374                             },
 375                             {
 376                                 "name": "arg1",
 377                                 "type": "GTlsCertificate"
 378                             },
 379                             {
 380                                 "name": "arg2",
 381                                 "type": "GTlsCertificateFlags"
 382                             }
 383                         ],
 384                         "return-type": "gboolean",
 385                         "when": "last"
 386                     },
 387                     "handle-request": {
 388                         "args": [
 389                             {
 390                                 "name": "arg0",
 391                                 "type": "GstRTSPMessage"
 392                             },
 393                             {
 394                                 "name": "arg1",
 395                                 "type": "GstRTSPMessage"
 396                             }
 397                         ],
 398                         "return-type": "void"
 399                     },
 400                     "new-manager": {
 401                         "args": [
 402                             {
 403                                 "name": "arg0",
 404                                 "type": "GstElement"
 405                             }
 406                         ],
 407                         "return-type": "void",
 408                         "when": "first"
 409                     },
 410                     "new-payloader": {
 411                         "args": [
 412                             {
 413                                 "name": "arg0",
 414                                 "type": "GstElement"
 415                             }
 416                         ],
 417                         "return-type": "void",
 418                         "when": "first"
 419                     },
 420                     "request-rtcp-key": {
 421                         "args": [
 422                             {
 423                                 "name": "arg0",
 424                                 "type": "guint"
 425                             }
 426                         ],
 427                         "return-type": "GstCaps",
 428                         "when": "last"
 429                     },
 430                     "update-sdp": {
 431                         "args": [
 432                             {
 433                                 "name": "arg0",
 434                                 "type": "GstSDPMessage"
 435                             }
 436                         ],
 437                         "return-type": "void"
 438                     }
 439                 }
 440             }
 441         },
 442         "filename": "gstrtspclientsink",
 443         "license": "LGPL",
 444         "other-types": {
 445             "GstRTSPClientSinkNtpTimeSource": {
 446                 "kind": "enum",
 447                 "values": [
 448                     {
 449                         "desc": "NTP time based on realtime clock",
 450                         "name": "ntp",
 451                         "value": "0"
 452                     },
 453                     {
 454                         "desc": "UNIX time based on realtime clock",
 455                         "name": "unix",
 456                         "value": "1"
 457                     },
 458                     {
 459                         "desc": "Running time based on pipeline clock",
 460                         "name": "running-time",
 461                         "value": "2"
 462                     },
 463                     {
 464                         "desc": "Pipeline clock time",
 465                         "name": "clock-time",
 466                         "value": "3"
 467                     }
 468                 ]
 469             },
 470             "GstRtspClientSinkPad": {
 471                 "hierarchy": [
 472                     "GstRtspClientSinkPad",
 473                     "GstGhostPad",
 474                     "GstProxyPad",
 475                     "GstPad",
 476                     "GstObject",
 477                     "GInitiallyUnowned",
 478                     "GObject"
 479                 ],
 480                 "kind": "object",
 481                 "properties": {
 482                     "payloader": {
 483                         "blurb": "The payloader element to use (NULL = default automatically selected)",
 484                         "conditionally-available": false,
 485                         "construct": false,
 486                         "construct-only": false,
 487                         "controllable": false,
 488                         "mutable": "null",
 489                         "readable": true,
 490                         "type": "GstElement",
 491                         "writable": true
 492                     },
 493                     "ulpfec-percentage": {
 494                         "blurb": "The percentage of ULP redundancy to apply",
 495                         "conditionally-available": false,
 496                         "construct": false,
 497                         "construct-only": false,
 498                         "controllable": false,
 499                         "default": "0",
 500                         "max": "100",
 501                         "min": "0",
 502                         "mutable": "null",
 503                         "readable": true,
 504                         "type": "guint",
 505                         "writable": true
 506                     }
 507                 }
 508             }
 509         },
 510         "package": "GStreamer RTSP Server Library",
 511         "source": "gst-rtsp-server",
 512         "tracers": {},
 513         "url": "Unknown package origin"
 514     }
 515 }