docs/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                 "klass": "Sink/Network",
  17                 "long-name": "RTSP RECORD client",
  18                 "name": "rtspclientsink",
  19                 "pad-templates": {
  20                     "sink_%%u": {
  21                         "caps": "ANY",
  22                         "direction": "sink",
  23                         "presence": "request"
  24                     },
  25                     "stream_%%u": {
  26                         "caps": "ANY",
  27                         "direction": "sink",
  28                         "presence": "request"
  29                     }
  30                 },
  31                 "properties": {
  32                     "async-handling": {
  33                         "blurb": "The bin will handle Asynchronous state changes",
  34                         "construct": false,
  35                         "construct-only": false,
  36                         "default": "false",
  37                         "type-name": "gboolean",
  38                         "writable": true
  39                     },
  40                     "debug": {
  41                         "blurb": "Dump request and response messages to stdout",
  42                         "construct": false,
  43                         "construct-only": false,
  44                         "default": "false",
  45                         "type-name": "gboolean",
  46                         "writable": true
  47                     },
  48                     "do-rtsp-keep-alive": {
  49                         "blurb": "Send RTSP keep alive packets, disable for old incompatible server.",
  50                         "construct": false,
  51                         "construct-only": false,
  52                         "default": "true",
  53                         "type-name": "gboolean",
  54                         "writable": true
  55                     },
  56                     "latency": {
  57                         "blurb": "Amount of ms to buffer",
  58                         "construct": false,
  59                         "construct-only": false,
  60                         "default": "2000",
  61                         "max": "-1",
  62                         "min": "0",
  63                         "type-name": "guint",
  64                         "writable": true
  65                     },
  66                     "location": {
  67                         "blurb": "Location of the RTSP url to read",
  68                         "construct": false,
  69                         "construct-only": false,
  70                         "default": "NULL",
  71                         "type-name": "gchararray",
  72                         "writable": true
  73                     },
  74                     "message-forward": {
  75                         "blurb": "Forwards all children messages",
  76                         "construct": false,
  77                         "construct-only": false,
  78                         "default": "false",
  79                         "type-name": "gboolean",
  80                         "writable": true
  81                     },
  82                     "multicast-iface": {
  83                         "blurb": "The network interface on which to join the multicast group",
  84                         "construct": false,
  85                         "construct-only": false,
  86                         "default": "NULL",
  87                         "type-name": "gchararray",
  88                         "writable": true
  89                     },
  90                     "name": {
  91                         "blurb": "The name of the object",
  92                         "construct": true,
  93                         "construct-only": false,
  94                         "default": "NULL",
  95                         "hotdoc-fixed-default": true,
  96                         "type-name": "gchararray",
  97                         "writable": true
  98                     },
  99                     "ntp-time-source": {
 100                         "blurb": "NTP time source for RTCP packets",
 101                         "construct": false,
 102                         "construct-only": false,
 103                         "default": "ntp (0)",
 104                         "enum": true,
 105                         "type-name": "GstRTSPClientSinkNtpTimeSource",
 106                         "values": [
 107                             {
 108                                 "desc": "NTP time based on realtime clock",
 109                                 "name": "ntp",
 110                                 "value": "0"
 111                             },
 112                             {
 113                                 "desc": "UNIX time based on realtime clock",
 114                                 "name": "unix",
 115                                 "value": "1"
 116                             },
 117                             {
 118                                 "desc": "Running time based on pipeline clock",
 119                                 "name": "running-time",
 120                                 "value": "2"
 121                             },
 122                             {
 123                                 "desc": "Pipeline clock time",
 124                                 "name": "clock-time",
 125                                 "value": "3"
 126                             }
 127                         ],
 128                         "writable": true
 129                     },
 130                     "parent": {
 131                         "blurb": "The parent of the object",
 132                         "construct": false,
 133                         "construct-only": false,
 134                         "type-name": "GstObject",
 135                         "writable": true
 136                     },
 137                     "port-range": {
 138                         "blurb": "Client port range that can be used to receive RTCP data, eg. 3000-3005 (NULL = no restrictions)",
 139                         "construct": false,
 140                         "construct-only": false,
 141                         "default": "NULL",
 142                         "type-name": "gchararray",
 143                         "writable": true
 144                     },
 145                     "profiles": {
 146                         "blurb": "Allowed RTSP profiles",
 147                         "construct": false,
 148                         "construct-only": false,
 149                         "default": "avp",
 150                         "type-name": "GstRTSPProfile",
 151                         "values": [
 152                             {
 153                                 "desc": "GST_RTSP_PROFILE_UNKNOWN",
 154                                 "name": "unknown",
 155                                 "value": "0x00000000"
 156                             },
 157                             {
 158                                 "desc": "GST_RTSP_PROFILE_AVP",
 159                                 "name": "avp",
 160                                 "value": "0x00000001"
 161                             },
 162                             {
 163                                 "desc": "GST_RTSP_PROFILE_SAVP",
 164                                 "name": "savp",
 165                                 "value": "0x00000002"
 166                             },
 167                             {
 168                                 "desc": "GST_RTSP_PROFILE_AVPF",
 169                                 "name": "avpf",
 170                                 "value": "0x00000004"
 171                             },
 172                             {
 173                                 "desc": "GST_RTSP_PROFILE_SAVPF",
 174                                 "name": "savpf",
 175                                 "value": "0x00000008"
 176                             }
 177                         ],
 178                         "writable": true
 179                     },
 180                     "protocols": {
 181                         "blurb": "Allowed lower transport protocols",
 182                         "construct": false,
 183                         "construct-only": false,
 184                         "default": "tcp+udp-mcast+udp",
 185                         "type-name": "GstRTSPLowerTrans",
 186                         "values": [
 187                             {
 188                                 "desc": "GST_RTSP_LOWER_TRANS_UNKNOWN",
 189                                 "name": "unknown",
 190                                 "value": "0x00000000"
 191                             },
 192                             {
 193                                 "desc": "GST_RTSP_LOWER_TRANS_UDP",
 194                                 "name": "udp",
 195                                 "value": "0x00000001"
 196                             },
 197                             {
 198                                 "desc": "GST_RTSP_LOWER_TRANS_UDP_MCAST",
 199                                 "name": "udp-mcast",
 200                                 "value": "0x00000002"
 201                             },
 202                             {
 203                                 "desc": "GST_RTSP_LOWER_TRANS_TCP",
 204                                 "name": "tcp",
 205                                 "value": "0x00000004"
 206                             },
 207                             {
 208                                 "desc": "GST_RTSP_LOWER_TRANS_HTTP",
 209                                 "name": "http",
 210                                 "value": "0x00000010"
 211                             },
 212                             {
 213                                 "desc": "GST_RTSP_LOWER_TRANS_TLS",
 214                                 "name": "tls",
 215                                 "value": "0x00000020"
 216                             }
 217                         ],
 218                         "writable": true
 219                     },
 220                     "proxy": {
 221                         "blurb": "Proxy settings for HTTP tunneling. Format: [http://][user:passwd@]host[:port]",
 222                         "construct": false,
 223                         "construct-only": false,
 224                         "default": "NULL",
 225                         "type-name": "gchararray",
 226                         "writable": true
 227                     },
 228                     "proxy-id": {
 229                         "blurb": "HTTP proxy URI user id for authentication",
 230                         "construct": false,
 231                         "construct-only": false,
 232                         "default": "NULL",
 233                         "type-name": "gchararray",
 234                         "writable": true
 235                     },
 236                     "proxy-pw": {
 237                         "blurb": "HTTP proxy URI user password for authentication",
 238                         "construct": false,
 239                         "construct-only": false,
 240                         "default": "NULL",
 241                         "type-name": "gchararray",
 242                         "writable": true
 243                     },
 244                     "retry": {
 245                         "blurb": "Max number of retries when allocating RTP ports.",
 246                         "construct": false,
 247                         "construct-only": false,
 248                         "default": "20",
 249                         "max": "65535",
 250                         "min": "0",
 251                         "type-name": "guint",
 252                         "writable": true
 253                     },
 254                     "rtp-blocksize": {
 255                         "blurb": "RTP package size to suggest to server (0 = disabled)",
 256                         "construct": false,
 257                         "construct-only": false,
 258                         "default": "0",
 259                         "max": "65536",
 260                         "min": "0",
 261                         "type-name": "guint",
 262                         "writable": true
 263                     },
 264                     "rtx-time": {
 265                         "blurb": "Amount of ms to buffer for retransmission. 0 disables retransmission",
 266                         "construct": false,
 267                         "construct-only": false,
 268                         "default": "500",
 269                         "max": "-1",
 270                         "min": "0",
 271                         "type-name": "guint",
 272                         "writable": true
 273                     },
 274                     "sdes": {
 275                         "blurb": "The SDES items of this session",
 276                         "construct": false,
 277                         "construct-only": false,
 278                         "type-name": "GstStructure",
 279                         "writable": true
 280                     },
 281                     "tcp-timeout": {
 282                         "blurb": "Fail after timeout microseconds on TCP connections (0 = disabled)",
 283                         "construct": false,
 284                         "construct-only": false,
 285                         "default": "20000000",
 286                         "max": "18446744073709551615",
 287                         "min": "0",
 288                         "type-name": "guint64",
 289                         "writable": true
 290                     },
 291                     "timeout": {
 292                         "blurb": "Retry TCP transport after UDP timeout microseconds (0 = disabled)",
 293                         "construct": false,
 294                         "construct-only": false,
 295                         "default": "5000000",
 296                         "max": "18446744073709551615",
 297                         "min": "0",
 298                         "type-name": "guint64",
 299                         "writable": true
 300                     },
 301                     "tls-database": {
 302                         "blurb": "TLS database with anchor certificate authorities used to validate the server certificate",
 303                         "construct": false,
 304                         "construct-only": false,
 305                         "type-name": "GTlsDatabase",
 306                         "writable": true
 307                     },
 308                     "tls-interaction": {
 309                         "blurb": "A GTlsInteraction object to prompt the user for password or certificate",
 310                         "construct": false,
 311                         "construct-only": false,
 312                         "type-name": "GTlsInteraction",
 313                         "writable": true
 314                     },
 315                     "tls-validation-flags": {
 316                         "blurb": "TLS certificate validation flags used to validate the server certificate",
 317                         "construct": false,
 318                         "construct-only": false,
 319                         "default": "validate-all",
 320                         "type-name": "GTlsCertificateFlags",
 321                         "values": [
 322                             {
 323                                 "desc": "G_TLS_CERTIFICATE_UNKNOWN_CA",
 324                                 "name": "unknown-ca",
 325                                 "value": "0x00000001"
 326                             },
 327                             {
 328                                 "desc": "G_TLS_CERTIFICATE_BAD_IDENTITY",
 329                                 "name": "bad-identity",
 330                                 "value": "0x00000002"
 331                             },
 332                             {
 333                                 "desc": "G_TLS_CERTIFICATE_NOT_ACTIVATED",
 334                                 "name": "not-activated",
 335                                 "value": "0x00000004"
 336                             },
 337                             {
 338                                 "desc": "G_TLS_CERTIFICATE_EXPIRED",
 339                                 "name": "expired",
 340                                 "value": "0x00000008"
 341                             },
 342                             {
 343                                 "desc": "G_TLS_CERTIFICATE_REVOKED",
 344                                 "name": "revoked",
 345                                 "value": "0x00000010"
 346                             },
 347                             {
 348                                 "desc": "G_TLS_CERTIFICATE_INSECURE",
 349                                 "name": "insecure",
 350                                 "value": "0x00000020"
 351                             },
 352                             {
 353                                 "desc": "G_TLS_CERTIFICATE_GENERIC_ERROR",
 354                                 "name": "generic-error",
 355                                 "value": "0x00000040"
 356                             },
 357                             {
 358                                 "desc": "G_TLS_CERTIFICATE_VALIDATE_ALL",
 359                                 "name": "validate-all",
 360                                 "value": "0x0000007f"
 361                             }
 362                         ],
 363                         "writable": true
 364                     },
 365                     "udp-buffer-size": {
 366                         "blurb": "Size of the kernel UDP receive buffer in bytes, 0=default",
 367                         "construct": false,
 368                         "construct-only": false,
 369                         "default": "524288",
 370                         "max": "2147483647",
 371                         "min": "0",
 372                         "type-name": "gint",
 373                         "writable": true
 374                     },
 375                     "udp-reconnect": {
 376                         "blurb": "Reconnect to the server if RTSP connection is closed when doing UDP",
 377                         "construct": false,
 378                         "construct-only": false,
 379                         "default": "true",
 380                         "type-name": "gboolean",
 381                         "writable": true
 382                     },
 383                     "user-agent": {
 384                         "unstable-values": true,
 385                         "blurb": "The User-Agent string to send to the server",
 386                         "construct": false,
 387                         "construct-only": false,
 388                         "default": "GStreamer/@GSTREAMER_VERSION@",
 389                         "type-name": "gchararray",
 390                         "writable": true
 391                     },
 392                     "user-id": {
 393                         "blurb": "RTSP location URI user id for authentication",
 394                         "construct": false,
 395                         "construct-only": false,
 396                         "default": "NULL",
 397                         "type-name": "gchararray",
 398                         "writable": true
 399                     },
 400                     "user-pw": {
 401                         "blurb": "RTSP location URI user password for authentication",
 402                         "construct": false,
 403                         "construct-only": false,
 404                         "default": "NULL",
 405                         "type-name": "gchararray",
 406                         "writable": true
 407                     }
 408                 },
 409                 "rank": "none",
 410                 "signals": {
 411                     "accept-certificate": {
 412                         "args": [
 413                             "GTlsConnection",
 414                             "GTlsCertificate",
 415                             "GTlsCertificateFlags"
 416                         ],
 417                         "retval": "gboolean"
 418                     },
 419                     "handle-request": {
 420                         "args": [
 421                             "gpointer",
 422                             "gpointer"
 423                         ],
 424                         "retval": "void"
 425                     },
 426                     "new-manager": {
 427                         "args": [
 428                             "GstElement"
 429                         ],
 430                         "retval": "void"
 431                     },
 432                     "new-payloader": {
 433                         "args": [
 434                             "GstElement"
 435                         ],
 436                         "retval": "void"
 437                     },
 438                     "request-rtcp-key": {
 439                         "args": [
 440                             "guint"
 441                         ],
 442                         "retval": "GstCaps"
 443                     }
 444                 }
 445             }
 446         },
 447         "filename": "gstrtspclientsink",
 448         "license": "LGPL",
 449         "package": "GStreamer RTSP Server Library git",
 450         "source": "gst-rtsp-server",
 451         "url": "Unknown package origin"
 452     }
 453 }