FrameCaptureSettings

Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value FRAME_CAPTURE.

BroadcastingMedia ProcessingMedia

Properties

Name Type Description
FramerateDenominator object
FramerateNumerator object
MaxCaptures object
Quality object
View JSON Schema on GitHub

JSON Schema

mediaconvert-api-frame-capture-settings-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-mediaconvert/refs/heads/main/json-schema/mediaconvert-api-frame-capture-settings-schema.json",
  "title": "FrameCaptureSettings",
  "description": "Required when you set (Codec) under (VideoDescription)>(CodecSettings) to the value FRAME_CAPTURE.",
  "type": "object",
  "properties": {
    "FramerateDenominator": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integerMin1Max2147483647"
        },
        {
          "xml": {
            "name": "framerateDenominator"
          },
          "description": "Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.n.jpg where n is the 0-based sequence number of each Capture."
        }
      ]
    },
    "FramerateNumerator": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integerMin1Max2147483647"
        },
        {
          "xml": {
            "name": "framerateNumerator"
          },
          "description": "Frame capture will encode the first frame of the output stream, then one frame every framerateDenominator/framerateNumerator seconds. For example, settings of framerateNumerator = 1 and framerateDenominator = 3 (a rate of 1/3 frame per second) will capture the first frame, then 1 frame every 3s. Files will be named as filename.NNNNNNN.jpg where N is the 0-based frame sequence number zero padded to 7 decimal places."
        }
      ]
    },
    "MaxCaptures": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integerMin1Max10000000"
        },
        {
          "xml": {
            "name": "maxCaptures"
          },
          "description": "Maximum number of captures (encoded jpg output files)."
        }
      ]
    },
    "Quality": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integerMin1Max100"
        },
        {
          "xml": {
            "name": "quality"
          },
          "description": "JPEG Quality - a higher value equals higher quality."
        }
      ]
    }
  }
}