Class HlsEncryptionSettings

java.lang.Object
software.amazon.awssdk.services.mediaconvert.model.HlsEncryptionSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<HlsEncryptionSettings.Builder,HlsEncryptionSettings>
@Generated("software.amazon.awssdk:codegen") public final class HlsEncryptionSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<HlsEncryptionSettings.Builder,HlsEncryptionSettings>
Settings for HLS encryption
See Also:

  • Method Details

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • 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:

    • toBuilder

      public HlsEncryptionSettings.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<HlsEncryptionSettings.Builder,HlsEncryptionSettings>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.