Pearl REST API network input settings for SRT, RTSP, NDI, and web graphics

Network inputs pull a stream or a rendered page into the Pearl device as a source. Their settings blocks sit alongside the common audio and video blocks on the same input settings path.

Applies to: Pearl-2, Pearl Mini, Pearl Nexus, Pearl Nano.

SRT input (srt). As with SRT publishers, required fields depend on mode:

Field	Notes
`mode`	`caller`, `listener`, or `rendezvous`. Default `caller`
`latency`	80 to 8000 ms. Default `80`
`encryption`	`passphrase` (10 to 79 characters) plus `keylength` (`128`, `192`, or `256`), or `null`
`ts_utc_midnight_origin`	UTC midnight-based timestamps. Default `true`
`url`	Required for `caller` and `rendezvous`
`port`	Required for `listener`. 1024 to 65535
`stream_id`	Caller only, up to 512 characters
`source_port`	Caller only. `0`, or 1024 to 65535. Default `0`

Note that the default latency for an SRT input is 80 ms, while the default for an SRT publisher is 125 ms.

RTSP input (rtsp):

Field	Notes
`url`	Source URL, up to 128 characters
`username` / `password`	Credentials for the source
`transport`	`udp`, `tcp`, or `udp_multicast`

NDI input (ndi):

Field	Notes
`name`	NDI source name, up to 128 characters
`group`	NDI group the input belongs to, up to 50 characters
`extra_source_ip_addresses`	Comma-delimited IP addresses to query for discovery, up to 512 characters
`ignore_timecode`	Ignore timecode in the NDI signal. Default `false`

Set ignore_timecode to true when the NDI source sends no timecode or its timecode is unstable.

Web graphics input (web_graphics):

Field	Notes
`url`	Page URL, up to 256 characters. Required
`resolution`	Render resolution, such as `1920x1080`
`fps`	Rendering frames per second, 1 to 99. Default `30`

Device differences

Pearl Nano does not support NDI or NDI|HX inputs or streaming.
Pearl Nano supports only SRT and RTSP network inputs, one at a time.

Creating an RTSP input with UDP transport:

{
  "type": "rtsp",
  "name": "New RTSP",
  "settings": {
    "rtsp": { "url": "rtsp://10.10.10.10:8554/rtspstream", "username": "", "password": "", "transport": "udp" },
    "audio": { "delay": 0 },
    "video": { "nosignal": { "image": "", "timeout": 5 }, "hwaccel_decoding": true }
  }
}