com.amazonaws.services.mediaconvert.model

Class HlsEncryptionSettings

java.lang.Object

com.amazonaws.services.mediaconvert.model.HlsEncryptionSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class HlsEncryptionSettings
extends Object
implements Serializable, Cloneable, StructuredPojo

Settings for HLS encryption

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
HlsEncryptionSettings()

Method Summary

Modifier and Type	Method and Description
HlsEncryptionSettings	clone()
boolean	equals(Object obj)
String	getConstantInitializationVector() This is a 128-bit, 16-byte hex value represented by a 32-character text string.
String	getEncryptionMethod() Encrypts the segments with the given encryption scheme.
String	getInitializationVectorInManifest() The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks.
String	getOfflineEncrypted() Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist.
SpekeKeyProvider	getSpekeKeyProvider() If your output group type is HLS, DASH, or Microsoft Smooth, use these settings when doing DRM encryption with a SPEKE-compliant key provider.
StaticKeyProvider	getStaticKeyProvider() Use these settings to set up encryption with a static key provider.
String	getType() Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setConstantInitializationVector(String constantInitializationVector) This is a 128-bit, 16-byte hex value represented by a 32-character text string.
void	setEncryptionMethod(String encryptionMethod) Encrypts the segments with the given encryption scheme.
void	setInitializationVectorInManifest(String initializationVectorInManifest) The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks.
void	setOfflineEncrypted(String offlineEncrypted) Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist.
void	setSpekeKeyProvider(SpekeKeyProvider 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.
void	setStaticKeyProvider(StaticKeyProvider staticKeyProvider) Use these settings to set up encryption with a static key provider.
void	setType(String type) Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard.
String	toString() Returns a string representation of this object.
HlsEncryptionSettings	withConstantInitializationVector(String constantInitializationVector) This is a 128-bit, 16-byte hex value represented by a 32-character text string.
HlsEncryptionSettings	withEncryptionMethod(HlsEncryptionType encryptionMethod) Encrypts the segments with the given encryption scheme.
HlsEncryptionSettings	withEncryptionMethod(String encryptionMethod) Encrypts the segments with the given encryption scheme.
HlsEncryptionSettings	withInitializationVectorInManifest(HlsInitializationVectorInManifest initializationVectorInManifest) The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks.
HlsEncryptionSettings	withInitializationVectorInManifest(String initializationVectorInManifest) The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks.
HlsEncryptionSettings	withOfflineEncrypted(HlsOfflineEncrypted offlineEncrypted) Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist.
HlsEncryptionSettings	withOfflineEncrypted(String offlineEncrypted) Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist.
HlsEncryptionSettings	withSpekeKeyProvider(SpekeKeyProvider 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.
HlsEncryptionSettings	withStaticKeyProvider(StaticKeyProvider staticKeyProvider) Use these settings to set up encryption with a static key provider.
HlsEncryptionSettings	withType(HlsKeyProviderType type) Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard.
HlsEncryptionSettings	withType(String type) Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

HlsEncryptionSettings

public HlsEncryptionSettings()

Method Detail

setConstantInitializationVector

public void setConstantInitializationVector(String constantInitializationVector)

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.

Parameters:

constantInitializationVector - 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.

getConstantInitializationVector

public String getConstantInitializationVector()

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.

Returns:

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.

withConstantInitializationVector

public HlsEncryptionSettings withConstantInitializationVector(String constantInitializationVector)

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.

Parameters:

constantInitializationVector - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEncryptionMethod

public void setEncryptionMethod(String encryptionMethod)

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

Parameters:

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

See Also:

HlsEncryptionType

getEncryptionMethod

public String getEncryptionMethod()

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

Returns:

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

See Also:

HlsEncryptionType

withEncryptionMethod

public HlsEncryptionSettings withEncryptionMethod(String encryptionMethod)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HlsEncryptionType

withEncryptionMethod

public HlsEncryptionSettings withEncryptionMethod(HlsEncryptionType encryptionMethod)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HlsEncryptionType

setInitializationVectorInManifest

public void setInitializationVectorInManifest(String initializationVectorInManifest)

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.

Parameters:

initializationVectorInManifest - 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.

See Also:

HlsInitializationVectorInManifest

getInitializationVectorInManifest

public String getInitializationVectorInManifest()

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.

Returns:

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.

See Also:

HlsInitializationVectorInManifest

withInitializationVectorInManifest

public HlsEncryptionSettings withInitializationVectorInManifest(String initializationVectorInManifest)

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.

Parameters:

initializationVectorInManifest - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HlsInitializationVectorInManifest

withInitializationVectorInManifest

public HlsEncryptionSettings withInitializationVectorInManifest(HlsInitializationVectorInManifest initializationVectorInManifest)

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.

Parameters:

initializationVectorInManifest - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HlsInitializationVectorInManifest

setOfflineEncrypted

public void setOfflineEncrypted(String offlineEncrypted)

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

Parameters:

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

See Also:

HlsOfflineEncrypted

getOfflineEncrypted

public String getOfflineEncrypted()

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

Returns:

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

See Also:

HlsOfflineEncrypted

withOfflineEncrypted

public HlsEncryptionSettings withOfflineEncrypted(String offlineEncrypted)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HlsOfflineEncrypted

withOfflineEncrypted

public HlsEncryptionSettings withOfflineEncrypted(HlsOfflineEncrypted offlineEncrypted)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HlsOfflineEncrypted

setSpekeKeyProvider

public void setSpekeKeyProvider(SpekeKeyProvider 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.

Parameters:

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.

getSpekeKeyProvider

public SpekeKeyProvider getSpekeKeyProvider()

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.

Returns:

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.

withSpekeKeyProvider

public HlsEncryptionSettings withSpekeKeyProvider(SpekeKeyProvider 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setStaticKeyProvider

public void setStaticKeyProvider(StaticKeyProvider staticKeyProvider)

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

Parameters:

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

getStaticKeyProvider

public StaticKeyProvider getStaticKeyProvider()

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

Returns:

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

withStaticKeyProvider

public HlsEncryptionSettings withStaticKeyProvider(StaticKeyProvider staticKeyProvider)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setType

public void setType(String type)

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.

Parameters:

type - 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.

See Also:

HlsKeyProviderType

getType

public String getType()

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.

Returns:

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.

See Also:

HlsKeyProviderType

withType

public HlsEncryptionSettings withType(String type)

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.

Parameters:

type - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HlsKeyProviderType

withType

public HlsEncryptionSettings withType(HlsKeyProviderType type)

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.

Parameters:

type - 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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

HlsKeyProviderType

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public HlsEncryptionSettings clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.