AWS SDK for C++  1.9.71
AWS SDK for C++
Public Member Functions | List of all members
Aws::MediaConvert::Model::HlsEncryptionSettings Class Reference

#include <HlsEncryptionSettings.h>

Public Member Functions

 HlsEncryptionSettings ()
 
 HlsEncryptionSettings (Aws::Utils::Json::JsonView jsonValue)
 
HlsEncryptionSettingsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetConstantInitializationVector () const
 
bool ConstantInitializationVectorHasBeenSet () const
 
void SetConstantInitializationVector (const Aws::String &value)
 
void SetConstantInitializationVector (Aws::String &&value)
 
void SetConstantInitializationVector (const char *value)
 
HlsEncryptionSettingsWithConstantInitializationVector (const Aws::String &value)
 
HlsEncryptionSettingsWithConstantInitializationVector (Aws::String &&value)
 
HlsEncryptionSettingsWithConstantInitializationVector (const char *value)
 
const HlsEncryptionTypeGetEncryptionMethod () const
 
bool EncryptionMethodHasBeenSet () const
 
void SetEncryptionMethod (const HlsEncryptionType &value)
 
void SetEncryptionMethod (HlsEncryptionType &&value)
 
HlsEncryptionSettingsWithEncryptionMethod (const HlsEncryptionType &value)
 
HlsEncryptionSettingsWithEncryptionMethod (HlsEncryptionType &&value)
 
const HlsInitializationVectorInManifestGetInitializationVectorInManifest () const
 
bool InitializationVectorInManifestHasBeenSet () const
 
void SetInitializationVectorInManifest (const HlsInitializationVectorInManifest &value)
 
void SetInitializationVectorInManifest (HlsInitializationVectorInManifest &&value)
 
HlsEncryptionSettingsWithInitializationVectorInManifest (const HlsInitializationVectorInManifest &value)
 
HlsEncryptionSettingsWithInitializationVectorInManifest (HlsInitializationVectorInManifest &&value)
 
const HlsOfflineEncryptedGetOfflineEncrypted () const
 
bool OfflineEncryptedHasBeenSet () const
 
void SetOfflineEncrypted (const HlsOfflineEncrypted &value)
 
void SetOfflineEncrypted (HlsOfflineEncrypted &&value)
 
HlsEncryptionSettingsWithOfflineEncrypted (const HlsOfflineEncrypted &value)
 
HlsEncryptionSettingsWithOfflineEncrypted (HlsOfflineEncrypted &&value)
 
const SpekeKeyProviderGetSpekeKeyProvider () const
 
bool SpekeKeyProviderHasBeenSet () const
 
void SetSpekeKeyProvider (const SpekeKeyProvider &value)
 
void SetSpekeKeyProvider (SpekeKeyProvider &&value)
 
HlsEncryptionSettingsWithSpekeKeyProvider (const SpekeKeyProvider &value)
 
HlsEncryptionSettingsWithSpekeKeyProvider (SpekeKeyProvider &&value)
 
const StaticKeyProviderGetStaticKeyProvider () const
 
bool StaticKeyProviderHasBeenSet () const
 
void SetStaticKeyProvider (const StaticKeyProvider &value)
 
void SetStaticKeyProvider (StaticKeyProvider &&value)
 
HlsEncryptionSettingsWithStaticKeyProvider (const StaticKeyProvider &value)
 
HlsEncryptionSettingsWithStaticKeyProvider (StaticKeyProvider &&value)
 
const HlsKeyProviderTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const HlsKeyProviderType &value)
 
void SetType (HlsKeyProviderType &&value)
 
HlsEncryptionSettingsWithType (const HlsKeyProviderType &value)
 
HlsEncryptionSettingsWithType (HlsKeyProviderType &&value)
 

Detailed Description

Settings for HLS encryption

See Also:

AWS API Reference

Definition at line 37 of file HlsEncryptionSettings.h.

Constructor & Destructor Documentation

◆ HlsEncryptionSettings() [1/2]

Aws::MediaConvert::Model::HlsEncryptionSettings::HlsEncryptionSettings ( )

◆ HlsEncryptionSettings() [2/2]

Aws::MediaConvert::Model::HlsEncryptionSettings::HlsEncryptionSettings ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ ConstantInitializationVectorHasBeenSet()

bool Aws::MediaConvert::Model::HlsEncryptionSettings::ConstantInitializationVectorHasBeenSet ( ) const
inline

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.

Definition at line 58 of file HlsEncryptionSettings.h.

◆ EncryptionMethodHasBeenSet()

bool Aws::MediaConvert::Model::HlsEncryptionSettings::EncryptionMethodHasBeenSet ( ) const
inline

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

Definition at line 113 of file HlsEncryptionSettings.h.

◆ GetConstantInitializationVector()

const Aws::String& Aws::MediaConvert::Model::HlsEncryptionSettings::GetConstantInitializationVector ( ) const
inline

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.

Definition at line 51 of file HlsEncryptionSettings.h.

◆ GetEncryptionMethod()

const HlsEncryptionType& Aws::MediaConvert::Model::HlsEncryptionSettings::GetEncryptionMethod ( ) const
inline

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

Definition at line 107 of file HlsEncryptionSettings.h.

◆ GetInitializationVectorInManifest()

const HlsInitializationVectorInManifest& Aws::MediaConvert::Model::HlsEncryptionSettings::GetInitializationVectorInManifest ( ) const
inline

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.

Definition at line 145 of file HlsEncryptionSettings.h.

◆ GetOfflineEncrypted()

const HlsOfflineEncrypted& Aws::MediaConvert::Model::HlsEncryptionSettings::GetOfflineEncrypted ( ) const
inline

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

Definition at line 187 of file HlsEncryptionSettings.h.

◆ GetSpekeKeyProvider()

const SpekeKeyProvider& Aws::MediaConvert::Model::HlsEncryptionSettings::GetSpekeKeyProvider ( ) const
inline

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.

Definition at line 225 of file HlsEncryptionSettings.h.

◆ GetStaticKeyProvider()

const StaticKeyProvider& Aws::MediaConvert::Model::HlsEncryptionSettings::GetStaticKeyProvider ( ) const
inline

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

Definition at line 266 of file HlsEncryptionSettings.h.

◆ GetType()

const HlsKeyProviderType& Aws::MediaConvert::Model::HlsEncryptionSettings::GetType ( ) const
inline

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.

Definition at line 299 of file HlsEncryptionSettings.h.

◆ InitializationVectorInManifestHasBeenSet()

bool Aws::MediaConvert::Model::HlsEncryptionSettings::InitializationVectorInManifestHasBeenSet ( ) const
inline

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.

Definition at line 152 of file HlsEncryptionSettings.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::MediaConvert::Model::HlsEncryptionSettings::Jsonize ( ) const

◆ OfflineEncryptedHasBeenSet()

bool Aws::MediaConvert::Model::HlsEncryptionSettings::OfflineEncryptedHasBeenSet ( ) const
inline

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

Definition at line 193 of file HlsEncryptionSettings.h.

◆ operator=()

HlsEncryptionSettings& Aws::MediaConvert::Model::HlsEncryptionSettings::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ SetConstantInitializationVector() [1/3]

void Aws::MediaConvert::Model::HlsEncryptionSettings::SetConstantInitializationVector ( Aws::String &&  value)
inline

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.

Definition at line 72 of file HlsEncryptionSettings.h.

◆ SetConstantInitializationVector() [2/3]

void Aws::MediaConvert::Model::HlsEncryptionSettings::SetConstantInitializationVector ( const Aws::String value)
inline

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.

Definition at line 65 of file HlsEncryptionSettings.h.

◆ SetConstantInitializationVector() [3/3]

void Aws::MediaConvert::Model::HlsEncryptionSettings::SetConstantInitializationVector ( const char *  value)
inline

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.

Definition at line 79 of file HlsEncryptionSettings.h.

◆ SetEncryptionMethod() [1/2]

void Aws::MediaConvert::Model::HlsEncryptionSettings::SetEncryptionMethod ( const HlsEncryptionType value)
inline

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

Definition at line 119 of file HlsEncryptionSettings.h.

◆ SetEncryptionMethod() [2/2]

void Aws::MediaConvert::Model::HlsEncryptionSettings::SetEncryptionMethod ( HlsEncryptionType &&  value)
inline

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

Definition at line 125 of file HlsEncryptionSettings.h.

◆ SetInitializationVectorInManifest() [1/2]

void Aws::MediaConvert::Model::HlsEncryptionSettings::SetInitializationVectorInManifest ( const HlsInitializationVectorInManifest value)
inline

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.

Definition at line 159 of file HlsEncryptionSettings.h.

◆ SetInitializationVectorInManifest() [2/2]

void Aws::MediaConvert::Model::HlsEncryptionSettings::SetInitializationVectorInManifest ( HlsInitializationVectorInManifest &&  value)
inline

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.

Definition at line 166 of file HlsEncryptionSettings.h.

◆ SetOfflineEncrypted() [1/2]

void Aws::MediaConvert::Model::HlsEncryptionSettings::SetOfflineEncrypted ( const HlsOfflineEncrypted value)
inline

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

Definition at line 199 of file HlsEncryptionSettings.h.

◆ SetOfflineEncrypted() [2/2]

void Aws::MediaConvert::Model::HlsEncryptionSettings::SetOfflineEncrypted ( HlsOfflineEncrypted &&  value)
inline

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

Definition at line 205 of file HlsEncryptionSettings.h.

◆ SetSpekeKeyProvider() [1/2]

void Aws::MediaConvert::Model::HlsEncryptionSettings::SetSpekeKeyProvider ( const SpekeKeyProvider value)
inline

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.

Definition at line 239 of file HlsEncryptionSettings.h.

◆ SetSpekeKeyProvider() [2/2]

void Aws::MediaConvert::Model::HlsEncryptionSettings::SetSpekeKeyProvider ( SpekeKeyProvider &&  value)
inline

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.

Definition at line 246 of file HlsEncryptionSettings.h.

◆ SetStaticKeyProvider() [1/2]

void Aws::MediaConvert::Model::HlsEncryptionSettings::SetStaticKeyProvider ( const StaticKeyProvider value)
inline

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

Definition at line 276 of file HlsEncryptionSettings.h.

◆ SetStaticKeyProvider() [2/2]

void Aws::MediaConvert::Model::HlsEncryptionSettings::SetStaticKeyProvider ( StaticKeyProvider &&  value)
inline

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

Definition at line 281 of file HlsEncryptionSettings.h.

◆ SetType() [1/2]

void Aws::MediaConvert::Model::HlsEncryptionSettings::SetType ( const HlsKeyProviderType value)
inline

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.

Definition at line 313 of file HlsEncryptionSettings.h.

◆ SetType() [2/2]

void Aws::MediaConvert::Model::HlsEncryptionSettings::SetType ( HlsKeyProviderType &&  value)
inline

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.

Definition at line 320 of file HlsEncryptionSettings.h.

◆ SpekeKeyProviderHasBeenSet()

bool Aws::MediaConvert::Model::HlsEncryptionSettings::SpekeKeyProviderHasBeenSet ( ) const
inline

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.

Definition at line 232 of file HlsEncryptionSettings.h.

◆ StaticKeyProviderHasBeenSet()

bool Aws::MediaConvert::Model::HlsEncryptionSettings::StaticKeyProviderHasBeenSet ( ) const
inline

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

Definition at line 271 of file HlsEncryptionSettings.h.

◆ TypeHasBeenSet()

bool Aws::MediaConvert::Model::HlsEncryptionSettings::TypeHasBeenSet ( ) const
inline

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.

Definition at line 306 of file HlsEncryptionSettings.h.

◆ WithConstantInitializationVector() [1/3]

HlsEncryptionSettings& Aws::MediaConvert::Model::HlsEncryptionSettings::WithConstantInitializationVector ( Aws::String &&  value)
inline

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.

Definition at line 93 of file HlsEncryptionSettings.h.

◆ WithConstantInitializationVector() [2/3]

HlsEncryptionSettings& Aws::MediaConvert::Model::HlsEncryptionSettings::WithConstantInitializationVector ( const Aws::String value)
inline

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.

Definition at line 86 of file HlsEncryptionSettings.h.

◆ WithConstantInitializationVector() [3/3]

HlsEncryptionSettings& Aws::MediaConvert::Model::HlsEncryptionSettings::WithConstantInitializationVector ( const char *  value)
inline

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.

Definition at line 100 of file HlsEncryptionSettings.h.

◆ WithEncryptionMethod() [1/2]

HlsEncryptionSettings& Aws::MediaConvert::Model::HlsEncryptionSettings::WithEncryptionMethod ( const HlsEncryptionType value)
inline

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

Definition at line 131 of file HlsEncryptionSettings.h.

◆ WithEncryptionMethod() [2/2]

HlsEncryptionSettings& Aws::MediaConvert::Model::HlsEncryptionSettings::WithEncryptionMethod ( HlsEncryptionType &&  value)
inline

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

Definition at line 137 of file HlsEncryptionSettings.h.

◆ WithInitializationVectorInManifest() [1/2]

HlsEncryptionSettings& Aws::MediaConvert::Model::HlsEncryptionSettings::WithInitializationVectorInManifest ( const HlsInitializationVectorInManifest value)
inline

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.

Definition at line 173 of file HlsEncryptionSettings.h.

◆ WithInitializationVectorInManifest() [2/2]

HlsEncryptionSettings& Aws::MediaConvert::Model::HlsEncryptionSettings::WithInitializationVectorInManifest ( HlsInitializationVectorInManifest &&  value)
inline

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.

Definition at line 180 of file HlsEncryptionSettings.h.

◆ WithOfflineEncrypted() [1/2]

HlsEncryptionSettings& Aws::MediaConvert::Model::HlsEncryptionSettings::WithOfflineEncrypted ( const HlsOfflineEncrypted value)
inline

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

Definition at line 211 of file HlsEncryptionSettings.h.

◆ WithOfflineEncrypted() [2/2]

HlsEncryptionSettings& Aws::MediaConvert::Model::HlsEncryptionSettings::WithOfflineEncrypted ( HlsOfflineEncrypted &&  value)
inline

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

Definition at line 217 of file HlsEncryptionSettings.h.

◆ WithSpekeKeyProvider() [1/2]

HlsEncryptionSettings& Aws::MediaConvert::Model::HlsEncryptionSettings::WithSpekeKeyProvider ( const SpekeKeyProvider value)
inline

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.

Definition at line 253 of file HlsEncryptionSettings.h.

◆ WithSpekeKeyProvider() [2/2]

HlsEncryptionSettings& Aws::MediaConvert::Model::HlsEncryptionSettings::WithSpekeKeyProvider ( SpekeKeyProvider &&  value)
inline

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.

Definition at line 260 of file HlsEncryptionSettings.h.

◆ WithStaticKeyProvider() [1/2]

HlsEncryptionSettings& Aws::MediaConvert::Model::HlsEncryptionSettings::WithStaticKeyProvider ( const StaticKeyProvider value)
inline

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

Definition at line 286 of file HlsEncryptionSettings.h.

◆ WithStaticKeyProvider() [2/2]

HlsEncryptionSettings& Aws::MediaConvert::Model::HlsEncryptionSettings::WithStaticKeyProvider ( StaticKeyProvider &&  value)
inline

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

Definition at line 291 of file HlsEncryptionSettings.h.

◆ WithType() [1/2]

HlsEncryptionSettings& Aws::MediaConvert::Model::HlsEncryptionSettings::WithType ( const HlsKeyProviderType value)
inline

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.

Definition at line 327 of file HlsEncryptionSettings.h.

◆ WithType() [2/2]

HlsEncryptionSettings& Aws::MediaConvert::Model::HlsEncryptionSettings::WithType ( HlsKeyProviderType &&  value)
inline

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.

Definition at line 334 of file HlsEncryptionSettings.h.


The documentation for this class was generated from the following file: