ImageGenerationConfiguration

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ImageGenerationConfiguration",
  "title": "ImageGenerationConfiguration",
  "type": "object",
  "required": [
    "Status",
    "ImageSelectorType",
    "DestinationConfig",
    "SamplingInterval",
    "Format"
  ],
  "properties": {
    "Status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ConfigurationStatus"
        },
        {
          "description": "Indicates whether the <code>ContinuousImageGenerationConfigurations</code> API is enabled or disabled."
        }
      ]
    },
    "ImageSelectorType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ImageSelectorType"
        },
        {
          "description": "The origin of the Server or Producer timestamps to use to generate the images."
        }
      ]
    },
    "DestinationConfig": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ImageGenerationDestinationConfig"
        },
        {
          "description": "The structure that contains the information required to deliver images to a customer."
        }
      ]
    },
    "SamplingInterval": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SamplingInterval"
        },
        {
          "description": "The time interval in milliseconds (ms) at which the images need to be generated from the stream. The minimum value that can be provided is 33 ms, because a camera that generates content at 30 FPS would create a frame every 33.3 ms. If the timestamp range is less than the sampling interval, the Image from the <code>StartTimestamp</code> will be returned if available. "
        }
      ]
    },
    "Format": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Format"
        },
        {
          "description": "The accepted image format."
        }
      ]
    },
    "FormatConfig": {
      "allOf": [
        {
          "$ref": "#/components/schemas/FormatConfig"
        },
        {
          "description": "The list of a key-value pair structure that contains extra parameters that can be applied when the image is generated. The <code>FormatConfig</code> key is the <code>JPEGQuality</code>, which indicates the JPEG quality key to be used to generate the image. The <code>FormatConfig</code> value accepts ints from 1 to 100. If the value is 1, the image will be generated with less quality and the best compression. If the value is 100, the image will be generated with the best quality and less compression. If no value is provided, the default value of the <code>JPEGQuality</code> key will be set to 80."
        }
      ]
    },
    "WidthPixels": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WidthPixels"
        },
        {
          "description": "The width of the output image that is used in conjunction with the <code>HeightPixels</code> parameter. When both <code>WidthPixels</code> and <code>HeightPixels</code> parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the <code>WidthPixels</code> parameter is provided, its original aspect ratio will be used to calculate the <code>HeightPixels</code> ratio. If neither parameter is provided, the original image size will be returned."
        }
      ]
    },
    "HeightPixels": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HeightPixels"
        },
        {
          "description": "The height of the output image that is used in conjunction with the <code>WidthPixels</code> parameter. When both <code>HeightPixels</code> and <code>WidthPixels</code> parameters are provided, the image will be stretched to fit the specified aspect ratio. If only the <code>HeightPixels</code> parameter is provided, its original aspect ratio will be used to calculate the <code>WidthPixels</code> ratio. If neither parameter is provided, the original image size will be returned."
        }
      ]
    }
  },
  "description": "The structure that contains the information required for the KVS images delivery. If null, the configuration will be deleted from the stream."
}