Amazon MediaConvert · JSON Structure

Mediaconvert Api Cmaf Encryption Settings Structure

Settings for CMAF encryption

Type: object Properties: 6
BroadcastingMedia ProcessingMedia

CmafEncryptionSettings is a JSON Structure definition published by Amazon MediaConvert, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

ConstantInitializationVector EncryptionMethod InitializationVectorInManifest SpekeKeyProvider StaticKeyProvider Type

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-mediaconvert/refs/heads/main/json-structure/mediaconvert-api-cmaf-encryption-settings-structure.json",
  "name": "CmafEncryptionSettings",
  "type": "object",
  "description": "Settings for CMAF encryption",
  "properties": {
    "ConstantInitializationVector": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__stringMin32Max32Pattern09aFAF32"
        },
        {
          "xml": {
            "name": "constantInitializationVector"
          },
          "description": "This is a 128-bit, 16-byte hex value represented by a 32-character text string. If this parameter is not set then the Initialization Vector will follow the segment number by default."
        }
      ]
    },
    "EncryptionMethod": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CmafEncryptionType"
        },
        {
          "xml": {
            "name": "encryptionMethod"
          },
          "description": "Specify the encryption scheme that you want the service to use when encrypting your CMAF segments. Choose AES-CBC subsample (SAMPLE-AES) or AES_CTR (AES-CTR)."
        }
      ]
    },
    "InitializationVectorInManifest": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CmafInitializationVectorInManifest"
        },
        {
          "xml": {
            "name": "initializationVectorInManifest"
          },
          "description": "When you use DRM with CMAF outputs, choose whether the service writes the 128-bit encryption initialization vector in the HLS and DASH manifests."
        }
      ]
    },
    "SpekeKeyProvider": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SpekeKeyProviderCmaf"
        },
        {
          "xml": {
            "name": "spekeKeyProvider"
          },
          "description": "If your output group type is CMAF, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is HLS, DASH, or Microsoft Smooth, use the SpekeKeyProvider settings instead."
        }
      ]
    },
    "StaticKeyProvider": {
      "allOf": [
        {
          "$ref": "#/components/schemas/StaticKeyProvider"
        },
        {
          "xml": {
            "name": "staticKeyProvider"
          },
          "description": "Use these settings to set up encryption with a static key provider."
        }
      ]
    },
    "Type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CmafKeyProviderType"
        },
        {
          "xml": {
            "name": "type"
          },
          "description": "Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard. For more information about SPEKE, see https://docs.aws.amazon.com/speke/latest/documentation/what-is-speke.html."
        }
      ]
    }
  }
}