Source Object Model

The source object model differs when used in API requests and responses.

POST API Requests

Use the following source model when issuing the Create a Source and Update a Source API requests (and the legacy Create a Route and Update a Route requests). Definition of each source depends on the source protocol.

UDP or RTP Source

Name	Type	Description
name	string	Name of source for route. (Unique name with length 1-60.)
tags	string[]	Source tags array.
id	string	Optional when creating source, required when updating. Source ID.
address	string	IP address of route source. (0.0.0.0 for unicast.)
protocol	string	Source protocol: udp or rtp
port	number	Port number of route source: 1–65535.
networkInterface	string	Optional. Network interface name. (Empty string if auto.)
retainHeader	Boolean	Optional. RTP only. To retain headers for RTP tunneling through SRT.
sourceAddress	string	Optional. IGMP v3 source address.
fec	string	Optional. For RTP inputs, PRO-MPEG FEC enable: none or prompeg. Note PRO-MPEG FEC is available only on Haivision SRT Gateway.
rtpReceiverClass	string	RTP only. If using RTP Redundancy (SMTE-2022-7), select the RTP receiver class: low, moderate, or high.
rtpNetworkBondingParams	object	RTP only. See RTP Network Bonding Parameters Model.

RTP Network Bonding Parameters Model

In RTP sources with RTP Redundancy enabled, the following RTP Network Bonding Parameters model is used as part of the request to a Update a Source API command for each defined network path.

Name	Type	Description
address	string	IP address of route source. “0.0.0.0” if unicast.
port	number	Port number of route source: 1–65535.
networkInterface	string	Network interface name. (Empty string if auto.)
sourceAddress	string	IGMP v3 source address.

SRT Source

Name	Type	Description
name	string	Name of source for route. (Unique name with length 1-60.)
tags	string[]	Source tags array.
id	string	Optional when creating source, required when updating. Source ID.
address	string	IP address of route source. (0.0.0.0 for listener.) If SRT path redundancy is used, this value is not needed. The srtNetworkBondingParams object contains the individual address assignments.
protocol	string	Source protocol: srt
port	number	Port number of route source: 1–65535. If SRT path redundancy is used, this value is not needed. The srtNetworkBondingParams object contains the individual port assignments.
networkInterface	string	Optional. Network interface name. (Empty string if auto.) If SRT path redundancy is used, this value is not needed. The srtNetworkBondingParams object contains the individual network interfaces.
srtPassPhrase	string	Optional. SRT passphrase.
srtLatency	number	Optional. SRT latency.
srtRcvBuf	number	Optional. SRT receive buffer size in bytes.
srtMode	string	Optional. SRT mode: caller, listener, or rendezvous.
srtGroupMode	string	Optional. SRT path redundancy mode: none, broadcast, backup, or any.
srtNetworkBondingParams	object list	If srtGroupMode is not set to none, array of SRT network bonding parameters.
srtStreamID	string	Optional. SRT Caller mode only. Stream ID string to identify the listener. Note Only available for Haivision SRT Gateway.
useFec	Boolean	Optional. SRT Caller mode only. If FEC is enabled: true or false
srtFecCols	number	Optional. SRT Caller mode only. If FEC is enabled, number of columns.
srtFecRows	number	Optional. SRT Caller mode only. If FEC is enabled, number of rows.
srtFecLayout	string	Optional. SRT Caller mode only. If FEC is enabled, FEC layout: saircase or even.
srtFecArq	string	Optional. SRT Caller mode only. If FEC is enabled, FEC ARQ: never or onreq.
srtCryptoMode	string	SRT crypto mode: auto, aes-ctr, or aes-gcm

SRT Network Bonding Parameters Model

In SRT Listener or Caller mode with srtGroup mode not set to none, use the following SRT Network Bonding Parameters model when issuing the Create a Route and Update a Route API requests for each defined network path.

Name	Type	Description
address	string	IP address of route source.
port	number	Port number of route source: 1–65535.
networkInterface	string	Network interface name. (Empty string if auto.)

RTMP Source

Name	Type	Description
name	string	Name of source for route. (Unique name with length 1-60.)
tags	string[]	Source tags array.
id	string	Optional when creating source, required when updating. Source ID.
address	string	Optional in publisher mode, required in consumer mode. IP address of route source.
protocol	string	Source protocol: rtmp
port	number	Port number of route source: 1–65535.
application	string	RTMP source application
networkInterface	string	Optional. Network interface name. (Empty string if auto.)
streamName	string	RTMP stream name
rtmpMode	string	RTMP mode: PUBLISHER or CONSUMER.

RTSP Source

Name	Type	Description
name	string	Name of source for route. (Unique name with length 1-60.)
tags	string[]	Source tags array.
id	string	Optional when creating source, required when updating. Source ID.
address	string	IP address of route source.
protocol	string	Source protocol: rtsp
port	number	Port number of route source: 1–65535.
networkInterface	string	Optional. Network interface name. (Empty string if auto.)
fec	string	Optional. FEC enable: none or vf
username	string	Optional. RTSP username.
password	string	Optional. RTSP password.

GET API Responses

The following source model is returned after issuing the Get List of Sources API command (and the legacy Get Device Configuration and Get Route Configuration commands) and various commands when the Route Object Model (v2) is returned. Definition of each source depends on the source protocol.