Skip to content

HlsEncryptionSettings

Source code in docs_src/capo_mediaconvert/types/hls_encryption_settings.py
class HlsEncryptionSettings(TypedDict, closed=True):
    constant_initialization_vector: NotRequired[
        "capo_mediaconvert.types.__string_min32_max32_pattern09a_faf32.__stringMin32Max32Pattern09aFAF32"
    ]
    """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."""
    encryption_method: NotRequired[
        "capo_mediaconvert.types.hls_encryption_type.HlsEncryptionType"
    ]
    """Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web interface also disables encryption."""
    initialization_vector_in_manifest: NotRequired[
        "capo_mediaconvert.types.hls_initialization_vector_in_manifest.HlsInitializationVectorInManifest"
    ]
    """The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the manifest. Otherwise Initialization Vector is not in the manifest."""
    offline_encrypted: NotRequired[
        "capo_mediaconvert.types.hls_offline_encrypted.HlsOfflineEncrypted"
    ]
    """Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist. This allows for offline Apple HLS FairPlay content protection."""
    speke_key_provider: NotRequired[
        "capo_mediaconvert.types.speke_key_provider.SpekeKeyProvider"
    ]
    """If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead."""
    static_key_provider: NotRequired[
        "capo_mediaconvert.types.static_key_provider.StaticKeyProvider"
    ]
    """Use these settings to set up encryption with a static key provider."""
    type: NotRequired[
        "capo_mediaconvert.types.hls_key_provider_type.HlsKeyProviderType"
    ]
    """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."""

constant_initialization_vector instance-attribute

constant_initialization_vector: NotRequired[__stringMin32Max32Pattern09aFAF32]

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.

encryption_method instance-attribute

encryption_method: NotRequired[HlsEncryptionType]

Encrypts the segments with the given encryption scheme. Leave blank to disable. Selecting 'Disabled' in the web interface also disables encryption.

initialization_vector_in_manifest instance-attribute

initialization_vector_in_manifest: NotRequired[HlsInitializationVectorInManifest]

The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks. If set to INCLUDE, Initialization Vector is listed in the manifest. Otherwise Initialization Vector is not in the manifest.

offline_encrypted instance-attribute

offline_encrypted: NotRequired[HlsOfflineEncrypted]

Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist. This allows for offline Apple HLS FairPlay content protection.

speke_key_provider instance-attribute

speke_key_provider: NotRequired[SpekeKeyProvider]

If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a SPEKE-compliant key provider. If your output group type is CMAF, use the SpekeKeyProviderCmaf settings instead.

static_key_provider instance-attribute

static_key_provider: NotRequired[StaticKeyProvider]

Use these settings to set up encryption with a static key provider.

type instance-attribute

type: NotRequired[HlsKeyProviderType]

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.