Transport

Attributes related to the transport stream that are used in a source or output.

BroadcastingLive VideoMediaMedia Transport

Properties

Name Type Description
CidrAllowList object
MaxBitrate object
MaxLatency object
MaxSyncBuffer object
MinLatency object
Protocol object
RemoteId object
SenderControlPort object
SenderIpAddress object
SmoothingLatency object
SourceListenerAddress object
SourceListenerPort object
StreamId object
View JSON Schema on GitHub

JSON Schema

mediaconnect-api-transport-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-mediaconnect/refs/heads/main/json-schema/mediaconnect-api-transport-schema.json",
  "title": "Transport",
  "description": "Attributes related to the transport stream that are used in a source or output.",
  "type": "object",
  "properties": {
    "CidrAllowList": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__listOf__string"
        },
        {
          "xml": {
            "name": "cidrAllowList"
          },
          "description": "The range of IP addresses that should be allowed to initiate output requests to this flow. These IP addresses should be in the form of a Classless Inter-Domain Routing (CIDR) block; for example, 10.0.0.0/16."
        }
      ]
    },
    "MaxBitrate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "xml": {
            "name": "maxBitrate"
          },
          "description": "The smoothing max bitrate (in bps) for RIST, RTP, and RTP-FEC streams."
        }
      ]
    },
    "MaxLatency": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "xml": {
            "name": "maxLatency"
          },
          "description": "The maximum latency in milliseconds. This parameter applies only to RIST-based, Zixi-based, and Fujitsu-based streams."
        }
      ]
    },
    "MaxSyncBuffer": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "xml": {
            "name": "maxSyncBuffer"
          },
          "description": "The size of the buffer (in milliseconds) to use to sync incoming source data."
        }
      ]
    },
    "MinLatency": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "xml": {
            "name": "minLatency"
          },
          "description": "The minimum latency in milliseconds for SRT-based streams. In streams that use the SRT protocol, this value that you set on your MediaConnect source or output represents the minimal potential latency of that connection. The latency of the stream is set to the highest number between the sender\u2019s minimum latency and the receiver\u2019s minimum latency."
        }
      ]
    },
    "Protocol": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Protocol"
        },
        {
          "xml": {
            "name": "protocol"
          },
          "description": "The protocol that is used by the source or output."
        }
      ]
    },
    "RemoteId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "remoteId"
          },
          "description": "The remote ID for the Zixi-pull stream."
        }
      ]
    },
    "SenderControlPort": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "xml": {
            "name": "senderControlPort"
          },
          "description": "The port that the flow uses to send outbound requests to initiate connection with the sender."
        }
      ]
    },
    "SenderIpAddress": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "senderIpAddress"
          },
          "description": "The IP address that the flow communicates with to initiate connection with the sender."
        }
      ]
    },
    "SmoothingLatency": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "xml": {
            "name": "smoothingLatency"
          },
          "description": "The smoothing latency in milliseconds for RIST, RTP, and RTP-FEC streams."
        }
      ]
    },
    "SourceListenerAddress": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "sourceListenerAddress"
          },
          "description": "Source IP or domain name for SRT-caller protocol."
        }
      ]
    },
    "SourceListenerPort": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "xml": {
            "name": "sourceListenerPort"
          },
          "description": "Source port for SRT-caller protocol."
        }
      ]
    },
    "StreamId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "streamId"
          },
          "description": "The stream ID that you want to use for this transport. This parameter applies only to Zixi and SRT caller-based streams."
        }
      ]
    }
  },
  "required": [
    "Protocol"
  ]
}