Struct Encryption

#[non_exhaustive]
pub struct Encryption {
    pub constant_initialization_vector: Option<String>,
    pub encryption_method: Option<EncryptionMethod>,
    pub key_rotation_interval_seconds: Option<i32>,
    pub cmaf_exclude_segment_drm_metadata: Option<bool>,
    pub speke_key_provider: Option<SpekeKeyProvider>,
}

The parameters for encrypting content.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

constant_initialization_vector: Option<String>

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: Option<EncryptionMethod>

The encryption method to use.

key_rotation_interval_seconds: Option<i32>

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

cmaf_exclude_segment_drm_metadata: Option<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

speke_key_provider: Option<SpekeKeyProvider>

The parameters for the SPEKE key provider.

Implementations

impl Encryption

pub fn constant_initialization_vector(&self) -> Option<&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).

pub fn encryption_method(&self) -> Option<&EncryptionMethod>

The encryption method to use.

pub fn key_rotation_interval_seconds(&self) -> Option<i32>

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

pub fn cmaf_exclude_segment_drm_metadata(&self) -> Option<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

pub fn speke_key_provider(&self) -> Option<&SpekeKeyProvider>

The parameters for the SPEKE key provider.

impl Encryption

pub fn builder() -> EncryptionBuilder

Creates a new builder-style object to manufacture Encryption.

Trait Implementations

impl Clone for Encryption

fn clone(&self) -> Encryption

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Encryption

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Encryption

fn eq(&self, other: &Encryption) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Encryption