software.amazon.awssdk.services.mediaconvert.model

Class HlsEncryptionSettings

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.HlsEncryptionSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<HlsEncryptionSettings.Builder,HlsEncryptionSettings>

@Generated(value="software.amazon.awssdk:codegen")
public final class HlsEncryptionSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<HlsEncryptionSettings.Builder,HlsEncryptionSettings>

Settings for HLS encryption

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HlsEncryptionSettings.Builder

Method Summary

Modifier and Type	Method and Description
static HlsEncryptionSettings.Builder	builder()
String	constantInitializationVector() This is a 128-bit, 16-byte hex value represented by a 32-character text string.
HlsEncryptionType	encryptionMethod() Encrypts the segments with the given encryption scheme.
String	encryptionMethodAsString() Encrypts the segments with the given encryption scheme.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
HlsInitializationVectorInManifest	initializationVectorInManifest() The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks.
String	initializationVectorInManifestAsString() The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks.
HlsOfflineEncrypted	offlineEncrypted() Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist.
String	offlineEncryptedAsString() Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist.
List<SdkField<?>>	sdkFields()
static Class<? extends HlsEncryptionSettings.Builder>	serializableBuilderClass()
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.
StaticKeyProvider	staticKeyProvider() Use these settings to set up encryption with a static key provider.
HlsEncryptionSettings.Builder	toBuilder()
String	toString() Returns a string representation of this object.
HlsKeyProviderType	type() Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard.
String	typeAsString() 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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

constantInitializationVector

public final 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.

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.

encryptionMethod

public final HlsEncryptionType encryptionMethod()

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

If the service returns an enum value that is not available in the current SDK version, encryptionMethod will return HlsEncryptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encryptionMethodAsString().

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

encryptionMethodAsString

public final String encryptionMethodAsString()

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

If the service returns an enum value that is not available in the current SDK version, encryptionMethod will return HlsEncryptionType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from encryptionMethodAsString().

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

initializationVectorInManifest

public final 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.

If the service returns an enum value that is not available in the current SDK version, initializationVectorInManifest will return HlsInitializationVectorInManifest.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from initializationVectorInManifestAsString().

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

initializationVectorInManifestAsString

public final String initializationVectorInManifestAsString()

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.

If the service returns an enum value that is not available in the current SDK version, initializationVectorInManifest will return HlsInitializationVectorInManifest.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from initializationVectorInManifestAsString().

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

offlineEncrypted

public final 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.

If the service returns an enum value that is not available in the current SDK version, offlineEncrypted will return HlsOfflineEncrypted.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from offlineEncryptedAsString().

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

offlineEncryptedAsString

public final String offlineEncryptedAsString()

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

If the service returns an enum value that is not available in the current SDK version, offlineEncrypted will return HlsOfflineEncrypted.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from offlineEncryptedAsString().

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

spekeKeyProvider

public final 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.

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.

staticKeyProvider

public final StaticKeyProvider staticKeyProvider()

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.

type

public final 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.

If the service returns an enum value that is not available in the current SDK version, type will return HlsKeyProviderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

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

typeAsString

public final String typeAsString()

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.

If the service returns an enum value that is not available in the current SDK version, type will return HlsKeyProviderType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

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

toBuilder

public HlsEncryptionSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HlsEncryptionSettings.Builder,HlsEncryptionSettings>

builder

public static HlsEncryptionSettings.Builder builder()

serializableBuilderClass

public static Class<? extends HlsEncryptionSettings.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo