Destinations Object Model
The destinations object model differs when used in API requests and responses.
POST API Requests
Use the following destinations model when issuing the Create a Route and Update a Route API requests. Definition of each destination depends on the protocol.
| Name | Type | Description |
|---|---|---|
| name | string | Name of destination for route. (Unique name with length 1-60.) |
| id | string | Optional when creating destination, required when updating. Destination ID. |
| address | string | IP address of route destination. |
| protocol | string | Destination protocol: udp or rtp. |
| port | number | Port number of route destination: 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. |
| action | string | Optional. Destination action: start, stop, or none. |
| mtu | number | Optional. Destination MTU. Range = 280–1500. |
| ttl | number | Optional. Destination TTL. Range = 1–255. |
| tos | number | Optional. Destination ToS. Range = 0–255. |
| fec | string | Optional.
|
| prompegFecLevel | string | Optional. RTP only. PRO-MPEG FEC level: a or b. |
| prompegFecIsBlockAligned | Boolean | Optional. RTP only. PRO-MPEG FEC if block is aligned: true or false. |
| prompegFecColumns | number | Optional. RTP only. PRO-MPEG FEC number of columns: 1–20. |
| prompegFecRows | number | Optional. RTP only. PRO-MPEG FEC number of rows: 4–20. |
| shaping | Boolean | Optional. Destination shaping: true or false. |
| maxBitrate | number | Optional. Destination maximum bitrate. |
| Name | Type | Description |
|---|---|---|
| name | string | Name of destination for route. (Unique name with length 1-60.) |
| id | string | Optional when creating destination, required when updating. Destination ID. |
| address | string | IP address of route destination. (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 | Destination protocol: srt. |
| port | number | Port number of route destination: 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 interface names. |
| retainHeader | Boolean | Optional. To retain headers for RTP tunneling through SRT. |
| action | string | Optional. Destination action: start, stop, or none. |
| mtu | number | Optional. Destination MTU. Range = 280–1500. If SRT path redundancy is used, this value is not needed. The srtNetworkBondingParams object contains the individual MTU values. |
| ttl | number | Optional. Destination TTL. Range = 1–255. If SRT path redundancy is used, this value is not needed. The srtNetworkBondingParams object contains the individual TTL values. |
| tos | number | Optional. Destination ToS. Range = 0–255. If SRT path redundancy is used, this value is not needed. The srtNetworkBondingParams object contains the individual ToS values. |
| srtEncryption | string | Optional. Encryption mode: AES128, AES256, or None. |
| srtPassPhrase | string | Optional. SRT Passphrase. |
srtLatency | number | Optional. SRT latency. |
| srtMode | string | Optional. SRT mode: caller, listener, or rendezvous. |
| srtOverhead | string | Optional. Overhead used for SRT. |
| srtStreamID | string | Optional. SRT Caller mode only. Stream ID string to identify the listener. Note Only available for Haivision SRT Gateway. |
| useFec | Boolean | SRT Caller mode with path redundancy disabled only. Enable FEC: true or false |
| srtFecCols | number | If useFEC is enabled, number of columns. |
| srtFecRows | number | If useFEC is enabled, number of rows. |
| srtFecLayout | string | If useFEC is enabled, FEC layout: saircase or even. |
| srtFecArq | string | If useFEC is enabled, FEC ARQ: never or onreq. |
| srtConnectionLimit | string | SRT Listener mode only. SRT Caller connection limit. |
| srtGroupMode | string | Optional. SRT path redundancy mode: none, broadcast, backup, or any. |
| srtMaxRexmitBandwidth | string | Optional. Additional bandwidth that is used to accommodate recovery of lost packets, including the SRT header. Note We recommend using a value equal to 25% of your source stream’s bitrate. The value entered in this field is rounded up to the nearest byte value, so you may see a difference in the SRT statistics. |
| 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 srtGroupmode not set to none, use the following SRT Network Bonding Parameters destinations 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 destination. |
| port | number | Port number of route destination: 1–65535. |
| networkInterface | string | Network interface name. (Empty string if auto.) |
| mtu | number | Optional. Destination MTU. Range = 280–1500 |
| ttl | number | Optional. Destination TTL. Range = 1–255. |
| tos | number | Optional. Destination ToS. Range = 0–255. |
GET API Responses
The following destinations model is returned after issuing the Get Device Configuration and Get Route Configuration API commands. Definition of each destination depends on the protocol.
| Name | Type | Description |
|---|---|---|
| name | string | Name of destination for route. |
| id | string | Destination ID. |
| address | string | IP address of route destination. (0.0.0.0 for unicast.) |
| protocol | string | Destination protocol: udp or rtp. |
| port | number | Port number of route destination: 1–65535. |
| networkInterface | string | Network interface name. (Empty string if auto.) |
| retainHeader | Boolean | RTP only. To retain headers for RTP tunneling through SRT. |
| mtu | number | Destination MTU. Range = 280–1500 |
| ttl | number | Destination TTL. Range = 1–255. |
| tos | number | Destination ToS. Range = 0–255. |
| fec | string | Optional.
|
| prompegFecLevel | string | Optional. RTP only. PRO-MPEG FEC level: a or b. |
| prompegFecIsBlockAligned | Boolean | Optional. RTP only. PRO-MPEG FEC if block is aligned: true or false. |
| prompegFecColumns | number | Optional. RTP only. PRO-MPEG FEC number of columns: 1–20. |
| prompegFecRows | number | Optional. RTP only. PRO-MPEG FEC number of rows: 4–20. |
| shaping | Boolean | Destination shaping: true or false. |
| maxBitrate | number | Destination maximum bitrate. |
| state | string | Destination state: disconnected, connecting, connection established, or connected. |
| summaryStatusCode | string | Destination status summary code: warn, error, ok, or unknown. |
| summaryStatusDetails | string | Destination status details. |
| started | Boolean | If destination is started: true or false. |
| Name | Type | Description |
|---|---|---|
| name | string | Name of destination for route. |
| id | string | Destination ID. |
| address | string | IP address of route destination. (0.0.0.0 for listener.) If path redundancy is used, pipe-delimited string of addresses. |
| protocol | string | Destination protocol: srt. |
| port | number or string | Port number of route destination: 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 network interfaces. |
| retainHeader | Boolean | Optional. To retain headers for RTP tunneling through SRT. |
| mtu | number or string | Destination MTU. Range = 280–1500. If path redundancy is used, pipe-delimited string of MTU values. |
| ttl | number or string | Destination TTL. Range = 1–255. If path redundancy is used, pipe-delimited string of TTL values. |
| tos | number or string | Destination ToS. Range = 0–255. If path redundancy is used, pipe-delimited string of ToS values. |
| srtEncryption | string | Encryption mode: AES128, AES256, or None. |
| srtPassPhrase | string | SRT Passphrase. |
| 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: staircase or even. |
| srtFecArq | string | SRT Caller mode only. If FEC is enabled, FEC ARQ: never or onreq. |
| srtConnectionLimit | string | SRT Listener mode only. SRT Caller connection limit. |
srtLatency | number | SRT latency. |
| mode | string | SRT mode: caller, listener, or rendezvous. |
| srtOverhead | string | Overhead used for SRT. |
| state | string | Destination state: disconnected, connecting, connection established, or connected. |
| summaryStatusCode | string | Destination status summary code: warn, error, ok, or unknown. |
| summaryStatusDetails | string | Destination status details. |
| started | Boolean | If destination is started: true or false. |
| srtStreamID | string | SRT Caller mode only. Stream ID string to identify the listener. Note Only available for Haivision SRT Gateway. |
| srtGroupMode | string | SRT path redundancy mode: none, broadcast, backup, or any. |
| srtMaxRexmitBandwidth | string | Additional bandwidth that is used to accommodate recovery of lost packets, including the SRT header. Note We recommend using a value equal to 25% of your source stream’s bitrate. The value entered in this field is rounded up to the nearest byte value, so you may see a difference in the SRT statistics. |
| 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 srtGroupMode 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 destination. |
| port | number | Port number of route destination: 1–65535. |
| networkInterface | string | Network interface name. (Empty string if auto.) |
| mtu | number | Optional. Destination MTU. Range = 280–1500 |
| ttl | number | Optional. Destination TTL. Range = 1–255. |
| tos | number | Optional. Destination ToS. Range = 0–255. |