MediaStream

{
  "$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-media-stream-schema.json",
  "title": "MediaStream",
  "description": "A single track or stream of media that contains video, audio, or ancillary data. After you add a media stream to a flow, you can associate it with sources and outputs on that flow, as long as they use the CDI protocol or the ST 2110 JPEG XS protocol. Each source or output can consist of one or many media streams.",
  "type": "object",
  "properties": {
    "Attributes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MediaStreamAttributes"
        },
        {
          "xml": {
            "name": "attributes"
          },
          "description": "Attributes that are related to the media stream."
        }
      ]
    },
    "ClockRate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "xml": {
            "name": "clockRate"
          },
          "description": "The sample rate for the stream. This value is measured in Hz."
        }
      ]
    },
    "Description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "description"
          },
          "description": "A description that can help you quickly identify what your media stream is used for."
        }
      ]
    },
    "Fmt": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "xml": {
            "name": "fmt"
          },
          "description": "The format type number (sometimes referred to as RTP payload type) of the media stream. MediaConnect assigns this value to the media stream. For ST 2110 JPEG XS outputs, you need to provide this value to the receiver."
        }
      ]
    },
    "MediaStreamId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "xml": {
            "name": "mediaStreamId"
          },
          "description": "A unique identifier for the media stream."
        }
      ]
    },
    "MediaStreamName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "mediaStreamName"
          },
          "description": "A name that helps you distinguish one media stream from another."
        }
      ]
    },
    "MediaStreamType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MediaStreamType"
        },
        {
          "xml": {
            "name": "mediaStreamType"
          },
          "description": "The type of media stream."
        }
      ]
    },
    "VideoFormat": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "xml": {
            "name": "videoFormat"
          },
          "description": "The resolution of the video."
        }
      ]
    }
  },
  "required": [
    "MediaStreamType",
    "MediaStreamId",
    "MediaStreamName",
    "Fmt"
  ]
}