Interface HlsEncryptionSettings.Builder

All Superinterfaces:
Buildable, CopyableBuilder<HlsEncryptionSettings.Builder,HlsEncryptionSettings>, SdkBuilder<HlsEncryptionSettings.Builder,HlsEncryptionSettings>, SdkPojo
Enclosing class:
HlsEncryptionSettings
public static interface HlsEncryptionSettings.Builder extends SdkPojo, CopyableBuilder<HlsEncryptionSettings.Builder,HlsEncryptionSettings>

  • Method Details

    • constantInitializationVector

      HlsEncryptionSettings.Builder constantInitializationVector(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.

    • encryptionMethod

      HlsEncryptionSettings.Builder encryptionMethod(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:

    • encryptionMethod

      HlsEncryptionSettings.Builder encryptionMethod(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:

    • initializationVectorInManifest

      HlsEncryptionSettings.Builder initializationVectorInManifest(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:

    • initializationVectorInManifest

      HlsEncryptionSettings.Builder initializationVectorInManifest(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:

    • offlineEncrypted

      HlsEncryptionSettings.Builder offlineEncrypted(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:

    • offlineEncrypted

      HlsEncryptionSettings.Builder offlineEncrypted(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:

    • spekeKeyProvider

      HlsEncryptionSettings.Builder spekeKeyProvider(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.

    • spekeKeyProvider

      default HlsEncryptionSettings.Builder spekeKeyProvider(Consumer<SpekeKeyProvider.Builder> 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. This is a convenience method that creates an instance of the SpekeKeyProvider.Builder avoiding the need to create one manually via SpekeKeyProvider.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to spekeKeyProvider(SpekeKeyProvider).

      Parameters:
      spekeKeyProvider - a consumer that will call methods on SpekeKeyProvider.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • staticKeyProvider

      HlsEncryptionSettings.Builder staticKeyProvider(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.

    • staticKeyProvider

      default HlsEncryptionSettings.Builder staticKeyProvider(Consumer<StaticKeyProvider.Builder> staticKeyProvider)
      Use these settings to set up encryption with a static key provider. This is a convenience method that creates an instance of the StaticKeyProvider.Builder avoiding the need to create one manually via StaticKeyProvider.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to staticKeyProvider(StaticKeyProvider).

      Parameters:
      staticKeyProvider - a consumer that will call methods on StaticKeyProvider.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      HlsEncryptionSettings.Builder type(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:

    • type

      HlsEncryptionSettings.Builder type(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: