Class Ac3Settings

java.lang.Object
software.amazon.awssdk.services.mediaconvert.model.Ac3Settings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Ac3Settings.Builder,Ac3Settings>
@Generated("software.amazon.awssdk:codegen") public final class Ac3Settings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Ac3Settings.Builder,Ac3Settings>
Required when you set Codec to the value AC3.
See Also:

  • Method Details

    • bitrate

      public final Integer bitrate()
      Specify the average bitrate in bits per second. The bitrate that you specify must be a multiple of 8000 within the allowed minimum and maximum values. Leave blank to use the default bitrate for the coding mode you select according ETSI TS 102 366. Valid bitrates for coding mode 1/0: Default: 96000. Minimum: 64000. Maximum: 128000. Valid bitrates for coding mode 1/1: Default: 192000. Minimum: 128000. Maximum: 384000. Valid bitrates for coding mode 2/0: Default: 192000. Minimum: 128000. Maximum: 384000. Valid bitrates for coding mode 3/2 with FLE: Default: 384000. Minimum: 384000. Maximum: 640000.
      Returns:
      Specify the average bitrate in bits per second. The bitrate that you specify must be a multiple of 8000 within the allowed minimum and maximum values. Leave blank to use the default bitrate for the coding mode you select according ETSI TS 102 366. Valid bitrates for coding mode 1/0: Default: 96000. Minimum: 64000. Maximum: 128000. Valid bitrates for coding mode 1/1: Default: 192000. Minimum: 128000. Maximum: 384000. Valid bitrates for coding mode 2/0: Default: 192000. Minimum: 128000. Maximum: 384000. Valid bitrates for coding mode 3/2 with FLE: Default: 384000. Minimum: 384000. Maximum: 640000.

    • bitstreamMode

      public final Ac3BitstreamMode bitstreamMode()
      Specify the bitstream mode for the AC-3 stream that the encoder emits. For more information about the AC3 bitstream mode, see ATSC A/52-2012 (Annex E).

      If the service returns an enum value that is not available in the current SDK version, bitstreamMode will return Ac3BitstreamMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from bitstreamModeAsString().

      Returns:
      Specify the bitstream mode for the AC-3 stream that the encoder emits. For more information about the AC3 bitstream mode, see ATSC A/52-2012 (Annex E).
      See Also:

    • bitstreamModeAsString

      public final String bitstreamModeAsString()
      Specify the bitstream mode for the AC-3 stream that the encoder emits. For more information about the AC3 bitstream mode, see ATSC A/52-2012 (Annex E).

      If the service returns an enum value that is not available in the current SDK version, bitstreamMode will return Ac3BitstreamMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from bitstreamModeAsString().

      Returns:
      Specify the bitstream mode for the AC-3 stream that the encoder emits. For more information about the AC3 bitstream mode, see ATSC A/52-2012 (Annex E).
      See Also:

    • codingMode

      public final Ac3CodingMode codingMode()
      Dolby Digital coding mode. Determines number of channels.

      If the service returns an enum value that is not available in the current SDK version, codingMode will return Ac3CodingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from codingModeAsString().

      Returns:
      Dolby Digital coding mode. Determines number of channels.
      See Also:

    • codingModeAsString

      public final String codingModeAsString()
      Dolby Digital coding mode. Determines number of channels.

      If the service returns an enum value that is not available in the current SDK version, codingMode will return Ac3CodingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from codingModeAsString().

      Returns:
      Dolby Digital coding mode. Determines number of channels.
      See Also:

    • dialnorm

      public final Integer dialnorm()
      Sets the dialnorm for the output. If blank and input audio is Dolby Digital, dialnorm will be passed through.
      Returns:
      Sets the dialnorm for the output. If blank and input audio is Dolby Digital, dialnorm will be passed through.

    • dynamicRangeCompressionLine

      public final Ac3DynamicRangeCompressionLine dynamicRangeCompressionLine()
      Choose the Dolby Digital dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby Digital stream for the line operating mode. Related setting: When you use this setting, MediaConvert ignores any value you provide for Dynamic range compression profile. For information about the Dolby Digital DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide at https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf.

      If the service returns an enum value that is not available in the current SDK version, dynamicRangeCompressionLine will return Ac3DynamicRangeCompressionLine.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dynamicRangeCompressionLineAsString().

      Returns:
      Choose the Dolby Digital dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby Digital stream for the line operating mode. Related setting: When you use this setting, MediaConvert ignores any value you provide for Dynamic range compression profile. For information about the Dolby Digital DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide at https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf.
      See Also:

    • dynamicRangeCompressionLineAsString

      public final String dynamicRangeCompressionLineAsString()
      Choose the Dolby Digital dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby Digital stream for the line operating mode. Related setting: When you use this setting, MediaConvert ignores any value you provide for Dynamic range compression profile. For information about the Dolby Digital DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide at https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf.

      If the service returns an enum value that is not available in the current SDK version, dynamicRangeCompressionLine will return Ac3DynamicRangeCompressionLine.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dynamicRangeCompressionLineAsString().

      Returns:
      Choose the Dolby Digital dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby Digital stream for the line operating mode. Related setting: When you use this setting, MediaConvert ignores any value you provide for Dynamic range compression profile. For information about the Dolby Digital DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide at https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf.
      See Also:

    • dynamicRangeCompressionProfile

      public final Ac3DynamicRangeCompressionProfile dynamicRangeCompressionProfile()
      When you want to add Dolby dynamic range compression (DRC) signaling to your output stream, we recommend that you use the mode-specific settings instead of Dynamic range compression profile. The mode-specific settings are Dynamic range compression profile, line mode and Dynamic range compression profile, RF mode. Note that when you specify values for all three settings, MediaConvert ignores the value of this setting in favor of the mode-specific settings. If you do use this setting instead of the mode-specific settings, choose None to leave out DRC signaling. Keep the default Film standard to set the profile to Dolby's film standard profile for all operating modes.

      If the service returns an enum value that is not available in the current SDK version, dynamicRangeCompressionProfile will return Ac3DynamicRangeCompressionProfile.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dynamicRangeCompressionProfileAsString().

      Returns:
      When you want to add Dolby dynamic range compression (DRC) signaling to your output stream, we recommend that you use the mode-specific settings instead of Dynamic range compression profile. The mode-specific settings are Dynamic range compression profile, line mode and Dynamic range compression profile, RF mode. Note that when you specify values for all three settings, MediaConvert ignores the value of this setting in favor of the mode-specific settings. If you do use this setting instead of the mode-specific settings, choose None to leave out DRC signaling. Keep the default Film standard to set the profile to Dolby's film standard profile for all operating modes.
      See Also:

    • dynamicRangeCompressionProfileAsString

      public final String dynamicRangeCompressionProfileAsString()
      When you want to add Dolby dynamic range compression (DRC) signaling to your output stream, we recommend that you use the mode-specific settings instead of Dynamic range compression profile. The mode-specific settings are Dynamic range compression profile, line mode and Dynamic range compression profile, RF mode. Note that when you specify values for all three settings, MediaConvert ignores the value of this setting in favor of the mode-specific settings. If you do use this setting instead of the mode-specific settings, choose None to leave out DRC signaling. Keep the default Film standard to set the profile to Dolby's film standard profile for all operating modes.

      If the service returns an enum value that is not available in the current SDK version, dynamicRangeCompressionProfile will return Ac3DynamicRangeCompressionProfile.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dynamicRangeCompressionProfileAsString().

      Returns:
      When you want to add Dolby dynamic range compression (DRC) signaling to your output stream, we recommend that you use the mode-specific settings instead of Dynamic range compression profile. The mode-specific settings are Dynamic range compression profile, line mode and Dynamic range compression profile, RF mode. Note that when you specify values for all three settings, MediaConvert ignores the value of this setting in favor of the mode-specific settings. If you do use this setting instead of the mode-specific settings, choose None to leave out DRC signaling. Keep the default Film standard to set the profile to Dolby's film standard profile for all operating modes.
      See Also:

    • dynamicRangeCompressionRf

      public final Ac3DynamicRangeCompressionRf dynamicRangeCompressionRf()
      Choose the Dolby Digital dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby Digital stream for the RF operating mode. Related setting: When you use this setting, MediaConvert ignores any value you provide for Dynamic range compression profile. For information about the Dolby Digital DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide at https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf.

      If the service returns an enum value that is not available in the current SDK version, dynamicRangeCompressionRf will return Ac3DynamicRangeCompressionRf.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dynamicRangeCompressionRfAsString().

      Returns:
      Choose the Dolby Digital dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby Digital stream for the RF operating mode. Related setting: When you use this setting, MediaConvert ignores any value you provide for Dynamic range compression profile. For information about the Dolby Digital DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide at https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf.
      See Also:

    • dynamicRangeCompressionRfAsString

      public final String dynamicRangeCompressionRfAsString()
      Choose the Dolby Digital dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby Digital stream for the RF operating mode. Related setting: When you use this setting, MediaConvert ignores any value you provide for Dynamic range compression profile. For information about the Dolby Digital DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide at https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf.

      If the service returns an enum value that is not available in the current SDK version, dynamicRangeCompressionRf will return Ac3DynamicRangeCompressionRf.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dynamicRangeCompressionRfAsString().

      Returns:
      Choose the Dolby Digital dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby Digital stream for the RF operating mode. Related setting: When you use this setting, MediaConvert ignores any value you provide for Dynamic range compression profile. For information about the Dolby Digital DRC operating modes and profiles, see the Dynamic Range Control chapter of the Dolby Metadata Guide at https://developer.dolby.com/globalassets/professional/documents/dolby-metadata-guide.pdf.
      See Also:

    • lfeFilter

      public final Ac3LfeFilter lfeFilter()
      Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode.

      If the service returns an enum value that is not available in the current SDK version, lfeFilter will return Ac3LfeFilter.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lfeFilterAsString().

      Returns:
      Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode.
      See Also:

    • lfeFilterAsString

      public final String lfeFilterAsString()
      Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode.

      If the service returns an enum value that is not available in the current SDK version, lfeFilter will return Ac3LfeFilter.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lfeFilterAsString().

      Returns:
      Applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with 3_2_LFE coding mode.
      See Also:

    • metadataControl

      public final Ac3MetadataControl metadataControl()
      When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.

      If the service returns an enum value that is not available in the current SDK version, metadataControl will return Ac3MetadataControl.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metadataControlAsString().

      Returns:
      When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
      See Also:

    • metadataControlAsString

      public final String metadataControlAsString()
      When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.

      If the service returns an enum value that is not available in the current SDK version, metadataControl will return Ac3MetadataControl.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metadataControlAsString().

      Returns:
      When set to FOLLOW_INPUT, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used.
      See Also:

    • sampleRate

      public final Integer sampleRate()
      This value is always 48000. It represents the sample rate in Hz.
      Returns:
      This value is always 48000. It represents the sample rate in Hz.

    • toBuilder

      public Ac3Settings.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<Ac3Settings.Builder,Ac3Settings>
      Returns:
      a builder for type T

    • builder

      public static Ac3Settings.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Ac3Settings.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.