Pearl REST API publisher settings for MPEG-TS, RTP/UDP, and NDI

MPEG-TS, RTP/UDP, and NDI publishers use the same settings path and the same type plus common structure as the other protocols.

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

MPEG-TS UDP push (type: "mpegts-udp", block mpegts_udp) and MPEG-TS RTP/UDP push (type: "mpegts-rtp", block mpegts_rtp) both take a single port field, 1 to 65535, default 6004.

RTP/UDP push (type: "rtp-udp", block rtp_udp) takes two ports instead:

audio_port — 1 to 65535. Default 6000
video_port — 1 to 65535. Default 6002

Options shared by all three UDP-based types.

Field	Notes
`address`	Unicast or multicast destination address
`sap`	Whether to enable SAP announcement. Default `false`
`sap_ip`	SAP announcement address
`sap_channel`	SAP channel number. Default `0`
`sap_play_group`	SAP play group name, up to 50 characters
`limit_bandwidth`	Whether to cap the bandwidth rate. Default `false`
`limit_bandwidth_rate`	Bandwidth cap in kbit/s. Default `0`

NDI (type: "ndi", block ndi):

Field	Notes
`ndi_name`	NDI source name, up to 500 characters
`ndi_group`	NDI group name, up to 500 characters
`disable_audio`	Default `false`

Device differences

The ndi publisher type applies to Pearl-2 only. Pearl Mini and Pearl Nexus do not support NDI output streaming, and Pearl Nano does not support NDI or NDI|HX inputs or streaming.

An MPEG-TS UDP publisher with a bandwidth cap:

{
  "type": "mpegts-udp",
  "mpegts_udp": { "port": 6006, "limit_bandwidth": true, "limit_bandwidth_rate": 1024 },
  "common": { "enabled": true, "single_touch": true }
}