TransportSpecJsonFragment

object
allowListlist of stringsOptional

List of IP addresses that are allowed to connect, if the transport type supports it.

The following transport types can use the allowList field: SRTListener.

encryptionStandardenumOptionalDefaults to None

Encryption standard for the transport, if the transport type supports it.

The following transport types can use the encryptionStandard field: SRTCaller, SRTListener. This field cannot be modified, only set during creation.

Allowed values:NoneAES128AES192AES256
ipResourceobjectIpResourceJsonFragmentOptional

Add an IP resource reservation for the transport. This is necessary for <glossary:source>s and <glossary:destination>s that need to access a <<glossary:SaaS site>> through a public IP address or public URL.

The following transport types can use the ipResource field: SRTListener. This field cannot be modified, only set during creation.

Show 1 propertyHide 1 property
typeenumRequired

Type of IP resource reservation:

  • External means reserve a public IP address,
  • Internal means reserve an internal IP address (please contact MediaKind personnel for usage), and
  • None means don't try to reserve an IP resource.

Transports between on-prem devices don't need to explicitly reserve an IP address.

Allowed values:NoneExternalInternal
latencydoubleOptionalDefaults to 0.5

Minimum Latency, in seconds, for the transport, if the transport type supports it.

The following transport types can use the latency field: SRTCaller, SRTListener. This field cannot be modified, only set during creation.

maxBitrateintegerOptionalDefaults to 30000000

Maximum bitrate, in bits per second, expected through each individual connection to the Listener.

The following transport types can use the maxBitrate field: SRTCaller, SRTListener. This field cannot be modified, only set during creation.

maxConnectionsintegerOptionalDefaults to 10

Maximum number of connections for a Listener destination. Overrides the flow output maxConnections setting if present.

The following transport types can use the maxConnections field: SRTCaller, SRTListener. This field cannot be modified, only set during creation.

maxOverheadBandwidthintegerOptional5 to 100Defaults to 100

Maximum Overhead Bandwidth, as an integer (e.g., 100), for the transport, if the transport type supports it.

The following transport types can use the maxOverheadBandwidth field: SRTCaller, SRTListener. This field cannot be modified, only set during creation.

passPhrasestringOptionalDefaults to

Password phrase for the transport, if the transport type supports it.

The following transport types can use the passPhrase field: SRTCaller, SRTListener.

passwordstringOptional

Password for HLS pull authentication.

For sources, this field can be updated via PATCH when the transport type is HLSPullInput. For all other transport types, it can only be set during creation.

portintegerOptionalDefaults to 5000

Port for the transport, if the transport type supports it.

The following transport types need the port field: SRTListener. This field cannot be modified, only set during creation.

streamIdstringOptionalDefaults to

The SRT stream ID sent by the caller during the SRT handshake. Used by the listener to identify or route the stream. Optional.

The following transport types can use the streamId field: SRTCaller. This field cannot be modified, only set during creation.

streamKeystringOptionalDefaults to

The RTMP stream key (appended to the URL when connecting).

The following transport types need the streamKey field: RTMPPushOutput. This field cannot be modified, only set during creation.

typeenumRequired
Type of transport. This field cannot be modified, only set during creation.
Allowed values:UDPSDISRTCallerSRTListenerHLSPullInputRTMPPushOutput
urlstringOptional

The URL for the transport, if the transport type supports it.

The following transport types need the url field: SRTCaller, UDP, SDI, HLSPullInput, RTMPPushOutput.

For sources, this field can be updated via PATCH when the transport type is SRTCaller or HLSPullInput. For all other transport types, and for destinations, it can only be set during creation.

urlslist of stringsOptionalDeprecated
DEPRECATED: Use url instead. This is provided for backwards compatibility and will be removed in a future release. If urls is used, only the first URL will be considered. If both url and urls are provided, url takes precedence.
userstringOptional

Username for HLS pull authentication.

For sources, this field can be updated via PATCH when the transport type is HLSPullInput. For all other transport types, it can only be set during creation.