HlsImageBasedTrickPlaySettings

Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED

BroadcastingMedia ProcessingMedia

Properties

Name Type Description
IntervalCadence object
ThumbnailHeight object
ThumbnailInterval object
ThumbnailWidth object
TileHeight object
TileWidth object
View JSON Schema on GitHub

JSON Schema

mediaconvert-api-hls-image-based-trick-play-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-hls-image-based-trick-play-settings-schema.json",
  "title": "HlsImageBasedTrickPlaySettings",
  "description": "Tile and thumbnail settings applicable when imageBasedTrickPlay is ADVANCED",
  "type": "object",
  "properties": {
    "IntervalCadence": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HlsIntervalCadence"
        },
        {
          "xml": {
            "name": "intervalCadence"
          },
          "description": "The cadence MediaConvert follows for generating thumbnails. If set to FOLLOW_IFRAME, MediaConvert generates thumbnails for each IDR frame in the output (matching the GOP cadence). If set to FOLLOW_CUSTOM, MediaConvert generates thumbnails according to the interval you specify in thumbnailInterval."
        }
      ]
    },
    "ThumbnailHeight": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integerMin2Max4096"
        },
        {
          "xml": {
            "name": "thumbnailHeight"
          },
          "description": "Height of each thumbnail within each tile image, in pixels. Leave blank to maintain aspect ratio with thumbnail width. If following the aspect ratio would lead to a total tile height greater than 4096, then the job will be rejected. Must be divisible by 2."
        }
      ]
    },
    "ThumbnailInterval": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__doubleMin0Max2147483647"
        },
        {
          "xml": {
            "name": "thumbnailInterval"
          },
          "description": "Enter the interval, in seconds, that MediaConvert uses to generate thumbnails. If the interval you enter doesn't align with the output frame rate, MediaConvert automatically rounds the interval to align with the output frame rate. For example, if the output frame rate is 29.97 frames per second and you enter 5, MediaConvert uses a 150 frame interval to generate thumbnails."
        }
      ]
    },
    "ThumbnailWidth": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integerMin8Max4096"
        },
        {
          "xml": {
            "name": "thumbnailWidth"
          },
          "description": "Width of each thumbnail within each tile image, in pixels. Default is 312. Must be divisible by 8."
        }
      ]
    },
    "TileHeight": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integerMin1Max2048"
        },
        {
          "xml": {
            "name": "tileHeight"
          },
          "description": "Number of thumbnails in each column of a tile image. Set a value between 2 and 2048. Must be divisible by 2."
        }
      ]
    },
    "TileWidth": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integerMin1Max512"
        },
        {
          "xml": {
            "name": "tileWidth"
          },
          "description": "Number of thumbnails in each row of a tile image. Set a value between 1 and 512."
        }
      ]
    }
  }
}