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 Route, Update a Route, and Start or Stop a Route's Destination API requests. Definition of each source depends on the source protocol.
| Name | Type | Description |
|---|---|---|
| name | string | Name of source for route. (Unique name with length 1-60.) |
| 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. PRO-MPEG FEC is available only on Haivision SRT Gateway. |
| Name | Type | Description |
|---|---|---|
| name | string | Name of source for route. (Unique name with length 1-60.) |
| 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. |
| srtMode | string | Optional. SRT mode: caller, listener, or rendezvous. |
| srtRcvBuf | number | Optional. SRT receive buffer size in bytes. |
| 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. |
| 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. |
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, Update a Route, and Start or Stop a Route's Destination 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.) |
GET API Responses
The following source model is returned after issuing the Get Device Configuration and Get Route Configuration API commands. Definition of each source depends on the source protocol.
| Name | Type | Description |
|---|---|---|
| name | string | Name of source for route. |
| id | string | 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 | Network interface name. (Empty string if auto.) |
| retainHeader | Boolean | RTP only. To retain headers for RTP tunneling through SRT. |
| sourceAddress | string | IGMP v3 source address. |
| fec | string | RTP only. Optional. For RTP inputs, PRO-MPEG FEC enable: none or prompeg. Note PRO-MPEG FEC is available only on Haivision SRT Gateway. |
| state | string | Source state: disconnected, connecting, connection established, or connected. |
| summaryStatusCode | string | Source status summary code: warn, error, ok, or unknown. |
| summaryStatusDetails | string | Source status details. |
| Name | Type | Description |
|---|---|---|
| name | string | Name of source for route. |
| id | string | Source ID. |
| address | string | IP address of route source. (0.0.0.0 for listener.) If path redundancy is used, pipe-delimited string of addresses. |
| protocol | string | Source protocol: srt |
| port | number or string | Port number of route source: 1–65535. If path redundancy is used, pipe-delimited string of ports. |
| networkInterface | string | Network interface name. (Empty string if auto.) If path redundancy is used, pipe-delimited string of interface names. |
| srtPassPhrase | string | SRT Passphrase. |
| srtLatency | number | SRT latency. |
| srtRcvBuf | number | SRT receive buffer size in bytes. |
| srtStreamID | string | SRT Caller mode only. Stream ID string to identify the listener. Note Only available for Haivision SRT Gateway. |
| useFec | Boolean | SRT Caller mode only. If FEC is enabled: true or false. |
| srtFecCols | number | SRT Caller mode only. If FEC is enabled, number of columns. |
| srtFecRows | number | SRT Caller mode only. If FEC is enabled, number of rows. |
| srtFecLayout | string | SRT Caller mode only. If FEC is enabled, FEC layout: saircase or even. |
| srtFecArq | string | SRT Caller mode only. If FEC is enabled, FEC ARQ: never or onreq. |
| mode | string | SRT mode: caller, listener, or rendezvous. |
| state | string | Source state: disconnected, connecting, connection established, or connected. |
| summaryStatusCode | string | Source status summary code: warn, error, ok, or unknown. |
| summaryStatusDetails | string | Source status details. |
| srtGroupMode | string | SRT path redundancy mode: none, broadcast, backup, or any. Note Backup mode is an experimental feature and will be fully supported in a future version. |
| srtNetworkBondingParams | object list | If srtGroupMode is not set to none, array of SRT network bonding parameters. |
SRT Network Bonding Parameters Model
In SRT Listener or Caller mode with srtGroup mode not set to none, the following SRT Network Bonding Parameters model is returned as part of the response to a Get Device Configuration or Get Route Configuration API command 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.) |