Class AudioNormalizationSettings
- java.lang.Object
-
- software.amazon.awssdk.services.mediaconvert.model.AudioNormalizationSettings
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AudioNormalizationSettings.Builder,AudioNormalizationSettings>
@Generated("software.amazon.awssdk:codegen") public final class AudioNormalizationSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AudioNormalizationSettings.Builder,AudioNormalizationSettings>
Advanced audio normalization settings. Ignore these settings unless you need to comply with a loudness standard.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
AudioNormalizationSettings.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AudioNormalizationAlgorithm
algorithm()
Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness.String
algorithmAsString()
Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness.AudioNormalizationAlgorithmControl
algorithmControl()
When enabled the output audio is corrected using the chosen algorithm.String
algorithmControlAsString()
When enabled the output audio is corrected using the chosen algorithm.static AudioNormalizationSettings.Builder
builder()
Integer
correctionGateLevel()
Content measuring above this level will be corrected to the target level.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
AudioNormalizationLoudnessLogging
loudnessLogging()
If set to LOG, log each output's audio track loudness to a CSV file.String
loudnessLoggingAsString()
If set to LOG, log each output's audio track loudness to a CSV file.AudioNormalizationPeakCalculation
peakCalculation()
If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.String
peakCalculationAsString()
If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends AudioNormalizationSettings.Builder>
serializableBuilderClass()
Double
targetLkfs()
When you use Audio normalization, optionally use this setting to specify a target loudness.AudioNormalizationSettings.Builder
toBuilder()
String
toString()
Returns a string representation of this object.Double
truePeakLimiterThreshold()
Specify the True-peak limiter threshold in decibels relative to full scale (dBFS).-
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
-
algorithm
public final AudioNormalizationAlgorithm algorithm()
Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness. A measurement of ungated average loudness for an entire piece of content, suitable for measurement of short-form content under ATSC recommendation A/85. Supports up to 5.1 audio channels. ITU-R BS.1770-2: Gated loudness. A measurement of gated average loudness compliant with the requirements of EBU-R128. Supports up to 5.1 audio channels. ITU-R BS.1770-3: Modified peak. The same loudness measurement algorithm as 1770-2, with an updated true peak measurement. ITU-R BS.1770-4: Higher channel count. Allows for more audio channels than the other algorithms, including configurations such as 7.1.If the service returns an enum value that is not available in the current SDK version,
algorithm
will returnAudioNormalizationAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromalgorithmAsString()
.- Returns:
- Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness. A measurement of ungated average loudness for an entire piece of content, suitable for measurement of short-form content under ATSC recommendation A/85. Supports up to 5.1 audio channels. ITU-R BS.1770-2: Gated loudness. A measurement of gated average loudness compliant with the requirements of EBU-R128. Supports up to 5.1 audio channels. ITU-R BS.1770-3: Modified peak. The same loudness measurement algorithm as 1770-2, with an updated true peak measurement. ITU-R BS.1770-4: Higher channel count. Allows for more audio channels than the other algorithms, including configurations such as 7.1.
- See Also:
AudioNormalizationAlgorithm
-
algorithmAsString
public final String algorithmAsString()
Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness. A measurement of ungated average loudness for an entire piece of content, suitable for measurement of short-form content under ATSC recommendation A/85. Supports up to 5.1 audio channels. ITU-R BS.1770-2: Gated loudness. A measurement of gated average loudness compliant with the requirements of EBU-R128. Supports up to 5.1 audio channels. ITU-R BS.1770-3: Modified peak. The same loudness measurement algorithm as 1770-2, with an updated true peak measurement. ITU-R BS.1770-4: Higher channel count. Allows for more audio channels than the other algorithms, including configurations such as 7.1.If the service returns an enum value that is not available in the current SDK version,
algorithm
will returnAudioNormalizationAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromalgorithmAsString()
.- Returns:
- Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness. A measurement of ungated average loudness for an entire piece of content, suitable for measurement of short-form content under ATSC recommendation A/85. Supports up to 5.1 audio channels. ITU-R BS.1770-2: Gated loudness. A measurement of gated average loudness compliant with the requirements of EBU-R128. Supports up to 5.1 audio channels. ITU-R BS.1770-3: Modified peak. The same loudness measurement algorithm as 1770-2, with an updated true peak measurement. ITU-R BS.1770-4: Higher channel count. Allows for more audio channels than the other algorithms, including configurations such as 7.1.
- See Also:
AudioNormalizationAlgorithm
-
algorithmControl
public final AudioNormalizationAlgorithmControl algorithmControl()
When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured but not adjusted.If the service returns an enum value that is not available in the current SDK version,
algorithmControl
will returnAudioNormalizationAlgorithmControl.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromalgorithmControlAsString()
.- Returns:
- When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured but not adjusted.
- See Also:
AudioNormalizationAlgorithmControl
-
algorithmControlAsString
public final String algorithmControlAsString()
When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured but not adjusted.If the service returns an enum value that is not available in the current SDK version,
algorithmControl
will returnAudioNormalizationAlgorithmControl.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromalgorithmControlAsString()
.- Returns:
- When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured but not adjusted.
- See Also:
AudioNormalizationAlgorithmControl
-
correctionGateLevel
public final Integer correctionGateLevel()
Content measuring above this level will be corrected to the target level. Content measuring below this level will not be corrected.- Returns:
- Content measuring above this level will be corrected to the target level. Content measuring below this level will not be corrected.
-
loudnessLogging
public final AudioNormalizationLoudnessLogging loudnessLogging()
If set to LOG, log each output's audio track loudness to a CSV file.If the service returns an enum value that is not available in the current SDK version,
loudnessLogging
will returnAudioNormalizationLoudnessLogging.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromloudnessLoggingAsString()
.- Returns:
- If set to LOG, log each output's audio track loudness to a CSV file.
- See Also:
AudioNormalizationLoudnessLogging
-
loudnessLoggingAsString
public final String loudnessLoggingAsString()
If set to LOG, log each output's audio track loudness to a CSV file.If the service returns an enum value that is not available in the current SDK version,
loudnessLogging
will returnAudioNormalizationLoudnessLogging.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromloudnessLoggingAsString()
.- Returns:
- If set to LOG, log each output's audio track loudness to a CSV file.
- See Also:
AudioNormalizationLoudnessLogging
-
peakCalculation
public final AudioNormalizationPeakCalculation peakCalculation()
If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.If the service returns an enum value that is not available in the current SDK version,
peakCalculation
will returnAudioNormalizationPeakCalculation.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompeakCalculationAsString()
.- Returns:
- If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.
- See Also:
AudioNormalizationPeakCalculation
-
peakCalculationAsString
public final String peakCalculationAsString()
If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.If the service returns an enum value that is not available in the current SDK version,
peakCalculation
will returnAudioNormalizationPeakCalculation.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompeakCalculationAsString()
.- Returns:
- If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.
- See Also:
AudioNormalizationPeakCalculation
-
targetLkfs
public final Double targetLkfs()
When you use Audio normalization, optionally use this setting to specify a target loudness. If you don't specify a value here, the encoder chooses a value for you, based on the algorithm that you choose for Algorithm. If you choose algorithm 1770-1, the encoder will choose -24 LKFS; otherwise, the encoder will choose -23 LKFS.- Returns:
- When you use Audio normalization, optionally use this setting to specify a target loudness. If you don't specify a value here, the encoder chooses a value for you, based on the algorithm that you choose for Algorithm. If you choose algorithm 1770-1, the encoder will choose -24 LKFS; otherwise, the encoder will choose -23 LKFS.
-
truePeakLimiterThreshold
public final Double truePeakLimiterThreshold()
Specify the True-peak limiter threshold in decibels relative to full scale (dBFS). The peak inter-audio sample loudness in your output will be limited to the value that you specify, without affecting the overall target LKFS. Enter a value from 0 to -8. Leave blank to use the default value 0.- Returns:
- Specify the True-peak limiter threshold in decibels relative to full scale (dBFS). The peak inter-audio sample loudness in your output will be limited to the value that you specify, without affecting the overall target LKFS. Enter a value from 0 to -8. Leave blank to use the default value 0.
-
toBuilder
public AudioNormalizationSettings.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<AudioNormalizationSettings.Builder,AudioNormalizationSettings>
-
builder
public static AudioNormalizationSettings.Builder builder()
-
serializableBuilderClass
public static Class<? extends AudioNormalizationSettings.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-