Class HlsEncryptionSettings
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<HlsEncryptionSettings.Builder,
HlsEncryptionSettings>
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final String
This is a 128-bit, 16-byte hex value represented by a 32-character text string.final HlsEncryptionType
Encrypts the segments with the given encryption scheme.final String
Encrypts the segments with the given encryption scheme.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks.final String
The Initialization Vector is a 128-bit number used in conjunction with the key for encrypting blocks.final HlsOfflineEncrypted
Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist.final String
Enable this setting to insert the EXT-X-SESSION-KEY element into the master playlist.static Class
<? extends HlsEncryptionSettings.Builder> final 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.final StaticKeyProvider
Use these settings to set up encryption with a static key provider.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final HlsKeyProviderType
type()
Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard.final String
Specify whether your DRM encryption key is static or from a key provider that follows the SPEKE standard.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
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 returnHlsEncryptionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencryptionMethodAsString()
.- 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
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 returnHlsEncryptionType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromencryptionMethodAsString()
.- 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
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 returnHlsInitializationVectorInManifest.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominitializationVectorInManifestAsString()
.- 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
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 returnHlsInitializationVectorInManifest.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominitializationVectorInManifestAsString()
.- 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
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 returnHlsOfflineEncrypted.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromofflineEncryptedAsString()
.- 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
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 returnHlsOfflineEncrypted.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromofflineEncryptedAsString()
.- 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
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
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
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 returnHlsKeyProviderType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- 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
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 returnHlsKeyProviderType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtypeAsString()
.- 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
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 interfaceToCopyableBuilder<HlsEncryptionSettings.Builder,
HlsEncryptionSettings> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-