com.amazonaws.services.mediaconvert.model

Class AudioNormalizationSettings

java.lang.Object

com.amazonaws.services.mediaconvert.model.AudioNormalizationSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AudioNormalizationSettings
extends Object
implements Serializable, Cloneable, StructuredPojo

Advanced audio normalization settings. Ignore these settings unless you need to comply with a loudness standard.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AudioNormalizationSettings()

Method Summary

Modifier and Type	Method and Description
AudioNormalizationSettings	clone()
boolean	equals(Object obj)
String	getAlgorithm() Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness.
String	getAlgorithmControl() When enabled the output audio is corrected using the chosen algorithm.
Integer	getCorrectionGateLevel() Content measuring above this level will be corrected to the target level.
String	getLoudnessLogging() If set to LOG, log each output's audio track loudness to a CSV file.
String	getPeakCalculation() If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.
Double	getTargetLkfs() When you use Audio normalization, optionally use this setting to specify a target loudness.
Double	getTruePeakLimiterThreshold() Specify the True-peak limiter threshold in decibels relative to full scale (dBFS).
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAlgorithm(String algorithm) Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness.
void	setAlgorithmControl(String algorithmControl) When enabled the output audio is corrected using the chosen algorithm.
void	setCorrectionGateLevel(Integer correctionGateLevel) Content measuring above this level will be corrected to the target level.
void	setLoudnessLogging(String loudnessLogging) If set to LOG, log each output's audio track loudness to a CSV file.
void	setPeakCalculation(String peakCalculation) If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.
void	setTargetLkfs(Double targetLkfs) When you use Audio normalization, optionally use this setting to specify a target loudness.
void	setTruePeakLimiterThreshold(Double truePeakLimiterThreshold) Specify the True-peak limiter threshold in decibels relative to full scale (dBFS).
String	toString() Returns a string representation of this object.
AudioNormalizationSettings	withAlgorithm(AudioNormalizationAlgorithm algorithm) Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness.
AudioNormalizationSettings	withAlgorithm(String algorithm) Choose one of the following audio normalization algorithms: ITU-R BS.1770-1: Ungated loudness.
AudioNormalizationSettings	withAlgorithmControl(AudioNormalizationAlgorithmControl algorithmControl) When enabled the output audio is corrected using the chosen algorithm.
AudioNormalizationSettings	withAlgorithmControl(String algorithmControl) When enabled the output audio is corrected using the chosen algorithm.
AudioNormalizationSettings	withCorrectionGateLevel(Integer correctionGateLevel) Content measuring above this level will be corrected to the target level.
AudioNormalizationSettings	withLoudnessLogging(AudioNormalizationLoudnessLogging loudnessLogging) If set to LOG, log each output's audio track loudness to a CSV file.
AudioNormalizationSettings	withLoudnessLogging(String loudnessLogging) If set to LOG, log each output's audio track loudness to a CSV file.
AudioNormalizationSettings	withPeakCalculation(AudioNormalizationPeakCalculation peakCalculation) If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.
AudioNormalizationSettings	withPeakCalculation(String peakCalculation) If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.
AudioNormalizationSettings	withTargetLkfs(Double targetLkfs) When you use Audio normalization, optionally use this setting to specify a target loudness.
AudioNormalizationSettings	withTruePeakLimiterThreshold(Double truePeakLimiterThreshold) Specify the True-peak limiter threshold in decibels relative to full scale (dBFS).

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AudioNormalizationSettings

public AudioNormalizationSettings()

Method Detail

setAlgorithm

public void setAlgorithm(String 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.

Parameters:

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.

See Also:

AudioNormalizationAlgorithm

getAlgorithm

public String getAlgorithm()

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.

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

withAlgorithm

public AudioNormalizationSettings withAlgorithm(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AudioNormalizationAlgorithm

withAlgorithm

public AudioNormalizationSettings withAlgorithm(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AudioNormalizationAlgorithm

setAlgorithmControl

public void setAlgorithmControl(String algorithmControl)

When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured but not adjusted.

Parameters:

algorithmControl - When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured but not adjusted.

See Also:

AudioNormalizationAlgorithmControl

getAlgorithmControl

public String getAlgorithmControl()

When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured but not adjusted.

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

withAlgorithmControl

public AudioNormalizationSettings withAlgorithmControl(String algorithmControl)

When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured but not adjusted.

Parameters:

algorithmControl - When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured but not adjusted.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AudioNormalizationAlgorithmControl

withAlgorithmControl

public AudioNormalizationSettings withAlgorithmControl(AudioNormalizationAlgorithmControl algorithmControl)

When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured but not adjusted.

Parameters:

algorithmControl - When enabled the output audio is corrected using the chosen algorithm. If disabled, the audio will be measured but not adjusted.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AudioNormalizationAlgorithmControl

setCorrectionGateLevel

public void setCorrectionGateLevel(Integer correctionGateLevel)

Content measuring above this level will be corrected to the target level. Content measuring below this level will not be corrected.

Parameters:

correctionGateLevel - Content measuring above this level will be corrected to the target level. Content measuring below this level will not be corrected.

getCorrectionGateLevel

public Integer getCorrectionGateLevel()

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.

withCorrectionGateLevel

public AudioNormalizationSettings withCorrectionGateLevel(Integer correctionGateLevel)

Content measuring above this level will be corrected to the target level. Content measuring below this level will not be corrected.

Parameters:

correctionGateLevel - Content measuring above this level will be corrected to the target level. Content measuring below this level will not be corrected.

Returns:

Returns a reference to this object so that method calls can be chained together.

setLoudnessLogging

public void setLoudnessLogging(String loudnessLogging)

If set to LOG, log each output's audio track loudness to a CSV file.

Parameters:

loudnessLogging - If set to LOG, log each output's audio track loudness to a CSV file.

See Also:

AudioNormalizationLoudnessLogging

getLoudnessLogging

public String getLoudnessLogging()

If set to LOG, log each output's audio track loudness to a CSV file.

Returns:

If set to LOG, log each output's audio track loudness to a CSV file.

See Also:

AudioNormalizationLoudnessLogging

withLoudnessLogging

public AudioNormalizationSettings withLoudnessLogging(String loudnessLogging)

If set to LOG, log each output's audio track loudness to a CSV file.

Parameters:

loudnessLogging - If set to LOG, log each output's audio track loudness to a CSV file.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AudioNormalizationLoudnessLogging

withLoudnessLogging

public AudioNormalizationSettings withLoudnessLogging(AudioNormalizationLoudnessLogging loudnessLogging)

If set to LOG, log each output's audio track loudness to a CSV file.

Parameters:

loudnessLogging - If set to LOG, log each output's audio track loudness to a CSV file.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AudioNormalizationLoudnessLogging

setPeakCalculation

public void setPeakCalculation(String peakCalculation)

If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.

Parameters:

peakCalculation - If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.

See Also:

AudioNormalizationPeakCalculation

getPeakCalculation

public String getPeakCalculation()

If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.

Returns:

If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.

See Also:

AudioNormalizationPeakCalculation

withPeakCalculation

public AudioNormalizationSettings withPeakCalculation(String peakCalculation)

If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.

Parameters:

peakCalculation - If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AudioNormalizationPeakCalculation

withPeakCalculation

public AudioNormalizationSettings withPeakCalculation(AudioNormalizationPeakCalculation peakCalculation)

If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.

Parameters:

peakCalculation - If set to TRUE_PEAK, calculate and log the TruePeak for each output's audio track loudness.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

AudioNormalizationPeakCalculation

setTargetLkfs

public void setTargetLkfs(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.

Parameters:

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.

getTargetLkfs

public Double getTargetLkfs()

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.

withTargetLkfs

public AudioNormalizationSettings withTargetLkfs(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setTruePeakLimiterThreshold

public void setTruePeakLimiterThreshold(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.

Parameters:

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.

getTruePeakLimiterThreshold

public Double getTruePeakLimiterThreshold()

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.

withTruePeakLimiterThreshold

public AudioNormalizationSettings withTruePeakLimiterThreshold(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AudioNormalizationSettings clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.