Skip to content

Encryption

Source code in docs_src/capo_mediapackagev2/types/encryption.py
class Encryption(TypedDict, closed=True):
    constant_initialization_vector: NotRequired["str"]
    """<p>A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).</p>"""
    encryption_method: "capo_mediapackagev2.types.encryption_method.EncryptionMethod"
    """<p>The encryption method to use.</p>"""
    key_rotation_interval_seconds: NotRequired["int"]
    """<p>The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.</p> <p>The following example setting causes the service to rotate keys every thirty minutes: <code>1800</code> </p>"""
    cmaf_exclude_segment_drm_metadata: NotRequired["bool"]
    """<p>Excludes SEIG and SGPD boxes from segment metadata in CMAF containers.</p> <p>When set to <code>true</code>, MediaPackage omits these DRM metadata boxes from CMAF segments, which can improve compatibility with certain devices and players that don't support these boxes.</p> <p>Important considerations:</p> <ul> <li> <p>This setting only affects CMAF container formats</p> </li> <li> <p>Key rotation can still be handled through media playlist signaling</p> </li> <li> <p>PSSH and TENC boxes remain unaffected</p> </li> <li> <p>Default behavior is preserved when this setting is disabled</p> </li> </ul> <p>Valid values: <code>true</code> | <code>false</code> </p> <p>Default: <code>false</code> </p>"""
    speke_key_provider: "capo_mediapackagev2.types.speke_key_provider.SpekeKeyProvider"
    """<p>The parameters for the SPEKE key provider.</p>"""

cmaf_exclude_segment_drm_metadata instance-attribute

cmaf_exclude_segment_drm_metadata: NotRequired[bool]

Excludes SEIG and SGPD boxes from segment metadata in CMAF containers.

When set to true, MediaPackage omits these DRM metadata boxes from CMAF segments, which can improve compatibility with certain devices and players that don't support these boxes.

Important considerations:

  • This setting only affects CMAF container formats

  • Key rotation can still be handled through media playlist signaling

  • PSSH and TENC boxes remain unaffected

  • Default behavior is preserved when this setting is disabled

Valid values: true | false

Default: false

constant_initialization_vector instance-attribute

constant_initialization_vector: NotRequired[str]

A 128-bit, 16-byte hex value represented by a 32-character string, used in conjunction with the key for encrypting content. If you don't specify a value, then MediaPackage creates the constant initialization vector (IV).

encryption_method instance-attribute

encryption_method: EncryptionMethod

The encryption method to use.

key_rotation_interval_seconds instance-attribute

key_rotation_interval_seconds: NotRequired[int]

The frequency (in seconds) of key changes for live workflows, in which content is streamed real time. The service retrieves content keys before the live content begins streaming, and then retrieves them as needed over the lifetime of the workflow. By default, key rotation is set to 300 seconds (5 minutes), the minimum rotation interval, which is equivalent to setting it to 300. If you don't enter an interval, content keys aren't rotated.

The following example setting causes the service to rotate keys every thirty minutes: 1800

speke_key_provider instance-attribute

speke_key_provider: SpekeKeyProvider

The parameters for the SPEKE key provider.