Class Eac3Settings

java.lang.Object
software.amazon.awssdk.services.medialive.model.Eac3Settings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Eac3Settings.Builder,Eac3Settings>
@Generated("software.amazon.awssdk:codegen") public final class Eac3Settings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Eac3Settings.Builder,Eac3Settings>
Eac3 Settings
See Also:

  • Method Details

    • attenuationControl

      public final Eac3AttenuationControl attenuationControl()
      When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.

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

      Returns:
      When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.
      See Also:

    • attenuationControlAsString

      public final String attenuationControlAsString()
      When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.

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

      Returns:
      When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.
      See Also:

    • bitrate

      public final Double bitrate()
      Average bitrate in bits/second. Valid bitrates depend on the coding mode.
      Returns:
      Average bitrate in bits/second. Valid bitrates depend on the coding mode.

    • bitstreamMode

      public final Eac3BitstreamMode bitstreamMode()
      Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values.

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

      Returns:
      Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values.
      See Also:

    • bitstreamModeAsString

      public final String bitstreamModeAsString()
      Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values.

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

      Returns:
      Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values.
      See Also:

    • codingMode

      public final Eac3CodingMode codingMode()
      Dolby Digital Plus 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 Eac3CodingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from codingModeAsString().

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

    • codingModeAsString

      public final String codingModeAsString()
      Dolby Digital Plus 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 Eac3CodingMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from codingModeAsString().

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

    • dcFilter

      public final Eac3DcFilter dcFilter()
      When set to enabled, activates a DC highpass filter for all input channels.

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

      Returns:
      When set to enabled, activates a DC highpass filter for all input channels.
      See Also:

    • dcFilterAsString

      public final String dcFilterAsString()
      When set to enabled, activates a DC highpass filter for all input channels.

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

      Returns:
      When set to enabled, activates a DC highpass filter for all input channels.
      See Also:

    • dialnorm

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

    • drcLine

      public final Eac3DrcLine drcLine()
      Sets the Dolby dynamic range compression profile.

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

      Returns:
      Sets the Dolby dynamic range compression profile.
      See Also:

    • drcLineAsString

      public final String drcLineAsString()
      Sets the Dolby dynamic range compression profile.

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

      Returns:
      Sets the Dolby dynamic range compression profile.
      See Also:

    • drcRf

      public final Eac3DrcRf drcRf()
      Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.

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

      Returns:
      Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.
      See Also:

    • drcRfAsString

      public final String drcRfAsString()
      Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.

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

      Returns:
      Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.
      See Also:

    • lfeControl

      public final Eac3LfeControl lfeControl()
      When encoding 3/2 audio, setting to lfe enables the LFE channel

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

      Returns:
      When encoding 3/2 audio, setting to lfe enables the LFE channel
      See Also:

    • lfeControlAsString

      public final String lfeControlAsString()
      When encoding 3/2 audio, setting to lfe enables the LFE channel

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

      Returns:
      When encoding 3/2 audio, setting to lfe enables the LFE channel
      See Also:

    • lfeFilter

      public final Eac3LfeFilter lfeFilter()
      When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode.

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

      Returns:
      When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode.
      See Also:

    • lfeFilterAsString

      public final String lfeFilterAsString()
      When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode.

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

      Returns:
      When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode.
      See Also:

    • loRoCenterMixLevel

      public final Double loRoCenterMixLevel()
      Left only/Right only center mix level. Only used for 3/2 coding mode.
      Returns:
      Left only/Right only center mix level. Only used for 3/2 coding mode.

    • loRoSurroundMixLevel

      public final Double loRoSurroundMixLevel()
      Left only/Right only surround mix level. Only used for 3/2 coding mode.
      Returns:
      Left only/Right only surround mix level. Only used for 3/2 coding mode.

    • ltRtCenterMixLevel

      public final Double ltRtCenterMixLevel()
      Left total/Right total center mix level. Only used for 3/2 coding mode.
      Returns:
      Left total/Right total center mix level. Only used for 3/2 coding mode.

    • ltRtSurroundMixLevel

      public final Double ltRtSurroundMixLevel()
      Left total/Right total surround mix level. Only used for 3/2 coding mode.
      Returns:
      Left total/Right total surround mix level. Only used for 3/2 coding mode.

    • metadataControl

      public final Eac3MetadataControl metadataControl()
      When set to followInput, 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 Eac3MetadataControl.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metadataControlAsString().

      Returns:
      When set to followInput, 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 followInput, 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 Eac3MetadataControl.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metadataControlAsString().

      Returns:
      When set to followInput, 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:

    • passthroughControl

      public final Eac3PassthroughControl passthroughControl()
      When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.

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

      Returns:
      When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.
      See Also:

    • passthroughControlAsString

      public final String passthroughControlAsString()
      When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.

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

      Returns:
      When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding.
      See Also:

    • phaseControl

      public final Eac3PhaseControl phaseControl()
      When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode.

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

      Returns:
      When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode.
      See Also:

    • phaseControlAsString

      public final String phaseControlAsString()
      When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode.

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

      Returns:
      When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode.
      See Also:

    • stereoDownmix

      public final Eac3StereoDownmix stereoDownmix()
      Stereo downmix preference. Only used for 3/2 coding mode.

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

      Returns:
      Stereo downmix preference. Only used for 3/2 coding mode.
      See Also:

    • stereoDownmixAsString

      public final String stereoDownmixAsString()
      Stereo downmix preference. Only used for 3/2 coding mode.

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

      Returns:
      Stereo downmix preference. Only used for 3/2 coding mode.
      See Also:

    • surroundExMode

      public final Eac3SurroundExMode surroundExMode()
      When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.

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

      Returns:
      When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.
      See Also:

    • surroundExModeAsString

      public final String surroundExModeAsString()
      When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.

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

      Returns:
      When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.
      See Also:

    • surroundMode

      public final Eac3SurroundMode surroundMode()
      When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.

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

      Returns:
      When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.
      See Also:

    • surroundModeAsString

      public final String surroundModeAsString()
      When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.

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

      Returns:
      When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.
      See Also:

    • toBuilder

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

    • builder

      public static Eac3Settings.Builder builder()

    • serializableBuilderClass

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