Class Eac3AtmosSettings

    • Method Detail

      • bitrate

        public final Integer bitrate()
        Specify the average bitrate for this output in bits per second. Valid values: 384k, 448k, 576k, 640k, 768k, 1024k Default value: 448k Note that MediaConvert supports 384k only with channel-based immersive (CBI) 7.1.4 and 5.1.4 inputs. For CBI 9.1.6 and other input types, MediaConvert automatically increases your output bitrate to 448k.
        Returns:
        Specify the average bitrate for this output in bits per second. Valid values: 384k, 448k, 576k, 640k, 768k, 1024k Default value: 448k Note that MediaConvert supports 384k only with channel-based immersive (CBI) 7.1.4 and 5.1.4 inputs. For CBI 9.1.6 and other input types, MediaConvert automatically increases your output bitrate to 448k.
      • bitstreamMode

        public final Eac3AtmosBitstreamMode bitstreamMode()
        Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 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 Eac3AtmosBitstreamMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from bitstreamModeAsString().

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

        public final String bitstreamModeAsString()
        Specify the bitstream mode for the E-AC-3 stream that the encoder emits. For more information about the EAC3 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 Eac3AtmosBitstreamMode.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from bitstreamModeAsString().

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

        public final Eac3AtmosDownmixControl downmixControl()
        Specify whether MediaConvert should use any downmix metadata from your input file. Keep the default value, Custom to provide downmix values in your job settings. Choose Follow source to use the metadata from your input. Related settings--Use these settings to specify your downmix values: Left only/Right only surround, Left total/Right total surround, Left total/Right total center, Left only/Right only center, and Stereo downmix. When you keep Custom for Downmix control and you don't specify values for the related settings, MediaConvert uses default values for those settings.

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

        Returns:
        Specify whether MediaConvert should use any downmix metadata from your input file. Keep the default value, Custom to provide downmix values in your job settings. Choose Follow source to use the metadata from your input. Related settings--Use these settings to specify your downmix values: Left only/Right only surround, Left total/Right total surround, Left total/Right total center, Left only/Right only center, and Stereo downmix. When you keep Custom for Downmix control and you don't specify values for the related settings, MediaConvert uses default values for those settings.
        See Also:
        Eac3AtmosDownmixControl
      • downmixControlAsString

        public final String downmixControlAsString()
        Specify whether MediaConvert should use any downmix metadata from your input file. Keep the default value, Custom to provide downmix values in your job settings. Choose Follow source to use the metadata from your input. Related settings--Use these settings to specify your downmix values: Left only/Right only surround, Left total/Right total surround, Left total/Right total center, Left only/Right only center, and Stereo downmix. When you keep Custom for Downmix control and you don't specify values for the related settings, MediaConvert uses default values for those settings.

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

        Returns:
        Specify whether MediaConvert should use any downmix metadata from your input file. Keep the default value, Custom to provide downmix values in your job settings. Choose Follow source to use the metadata from your input. Related settings--Use these settings to specify your downmix values: Left only/Right only surround, Left total/Right total surround, Left total/Right total center, Left only/Right only center, and Stereo downmix. When you keep Custom for Downmix control and you don't specify values for the related settings, MediaConvert uses default values for those settings.
        See Also:
        Eac3AtmosDownmixControl
      • dynamicRangeCompressionLine

        public final Eac3AtmosDynamicRangeCompressionLine dynamicRangeCompressionLine()
        Choose the Dolby dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby stream for the line operating mode. Default value: Film light Related setting: To have MediaConvert use the value you specify here, keep the default value, Custom for the setting Dynamic range control. Otherwise, MediaConvert ignores Dynamic range compression line. For information about the Dolby 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 Eac3AtmosDynamicRangeCompressionLine.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dynamicRangeCompressionLineAsString().

        Returns:
        Choose the Dolby dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby stream for the line operating mode. Default value: Film light Related setting: To have MediaConvert use the value you specify here, keep the default value, Custom for the setting Dynamic range control. Otherwise, MediaConvert ignores Dynamic range compression line. For information about the Dolby 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:
        Eac3AtmosDynamicRangeCompressionLine
      • dynamicRangeCompressionLineAsString

        public final String dynamicRangeCompressionLineAsString()
        Choose the Dolby dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby stream for the line operating mode. Default value: Film light Related setting: To have MediaConvert use the value you specify here, keep the default value, Custom for the setting Dynamic range control. Otherwise, MediaConvert ignores Dynamic range compression line. For information about the Dolby 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 Eac3AtmosDynamicRangeCompressionLine.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dynamicRangeCompressionLineAsString().

        Returns:
        Choose the Dolby dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby stream for the line operating mode. Default value: Film light Related setting: To have MediaConvert use the value you specify here, keep the default value, Custom for the setting Dynamic range control. Otherwise, MediaConvert ignores Dynamic range compression line. For information about the Dolby 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:
        Eac3AtmosDynamicRangeCompressionLine
      • dynamicRangeCompressionRf

        public final Eac3AtmosDynamicRangeCompressionRf dynamicRangeCompressionRf()
        Choose the Dolby dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby stream for the RF operating mode. Default value: Film light Related setting: To have MediaConvert use the value you specify here, keep the default value, Custom for the setting Dynamic range control. Otherwise, MediaConvert ignores Dynamic range compression RF. For information about the Dolby 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 Eac3AtmosDynamicRangeCompressionRf.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dynamicRangeCompressionRfAsString().

        Returns:
        Choose the Dolby dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby stream for the RF operating mode. Default value: Film light Related setting: To have MediaConvert use the value you specify here, keep the default value, Custom for the setting Dynamic range control. Otherwise, MediaConvert ignores Dynamic range compression RF. For information about the Dolby 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:
        Eac3AtmosDynamicRangeCompressionRf
      • dynamicRangeCompressionRfAsString

        public final String dynamicRangeCompressionRfAsString()
        Choose the Dolby dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby stream for the RF operating mode. Default value: Film light Related setting: To have MediaConvert use the value you specify here, keep the default value, Custom for the setting Dynamic range control. Otherwise, MediaConvert ignores Dynamic range compression RF. For information about the Dolby 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 Eac3AtmosDynamicRangeCompressionRf.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from dynamicRangeCompressionRfAsString().

        Returns:
        Choose the Dolby dynamic range control (DRC) profile that MediaConvert uses when encoding the metadata in the Dolby stream for the RF operating mode. Default value: Film light Related setting: To have MediaConvert use the value you specify here, keep the default value, Custom for the setting Dynamic range control. Otherwise, MediaConvert ignores Dynamic range compression RF. For information about the Dolby 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:
        Eac3AtmosDynamicRangeCompressionRf
      • dynamicRangeControl

        public final Eac3AtmosDynamicRangeControl dynamicRangeControl()
        Specify whether MediaConvert should use any dynamic range control metadata from your input file. Keep the default value, Custom, to provide dynamic range control values in your job settings. Choose Follow source to use the metadata from your input. Related settings--Use these settings to specify your dynamic range control values: Dynamic range compression line and Dynamic range compression RF. When you keep the value Custom for Dynamic range control and you don't specify values for the related settings, MediaConvert uses default values for those settings.

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

        Returns:
        Specify whether MediaConvert should use any dynamic range control metadata from your input file. Keep the default value, Custom, to provide dynamic range control values in your job settings. Choose Follow source to use the metadata from your input. Related settings--Use these settings to specify your dynamic range control values: Dynamic range compression line and Dynamic range compression RF. When you keep the value Custom for Dynamic range control and you don't specify values for the related settings, MediaConvert uses default values for those settings.
        See Also:
        Eac3AtmosDynamicRangeControl
      • dynamicRangeControlAsString

        public final String dynamicRangeControlAsString()
        Specify whether MediaConvert should use any dynamic range control metadata from your input file. Keep the default value, Custom, to provide dynamic range control values in your job settings. Choose Follow source to use the metadata from your input. Related settings--Use these settings to specify your dynamic range control values: Dynamic range compression line and Dynamic range compression RF. When you keep the value Custom for Dynamic range control and you don't specify values for the related settings, MediaConvert uses default values for those settings.

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

        Returns:
        Specify whether MediaConvert should use any dynamic range control metadata from your input file. Keep the default value, Custom, to provide dynamic range control values in your job settings. Choose Follow source to use the metadata from your input. Related settings--Use these settings to specify your dynamic range control values: Dynamic range compression line and Dynamic range compression RF. When you keep the value Custom for Dynamic range control and you don't specify values for the related settings, MediaConvert uses default values for those settings.
        See Also:
        Eac3AtmosDynamicRangeControl
      • loRoCenterMixLevel

        public final Double loRoCenterMixLevel()
        Specify a value for the following Dolby Atmos setting: Left only/Right only center mix (Lo/Ro center). MediaConvert uses this value for downmixing. Default value: -3 dB. Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, and -6.0. Related setting: How the service uses this value depends on the value that you choose for Stereo downmix. Related setting: To have MediaConvert use this value, keep the default value, Custom for the setting Downmix control. Otherwise, MediaConvert ignores Left only/Right only center.
        Returns:
        Specify a value for the following Dolby Atmos setting: Left only/Right only center mix (Lo/Ro center). MediaConvert uses this value for downmixing. Default value: -3 dB. Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, and -6.0. Related setting: How the service uses this value depends on the value that you choose for Stereo downmix. Related setting: To have MediaConvert use this value, keep the default value, Custom for the setting Downmix control. Otherwise, MediaConvert ignores Left only/Right only center.
      • loRoSurroundMixLevel

        public final Double loRoSurroundMixLevel()
        Specify a value for the following Dolby Atmos setting: Left only/Right only. MediaConvert uses this value for downmixing. Default value: -3 dB. Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. Related setting: How the service uses this value depends on the value that you choose for Stereo downmix. Related setting: To have MediaConvert use this value, keep the default value, Custom for the setting Downmix control. Otherwise, MediaConvert ignores Left only/Right only surround.
        Returns:
        Specify a value for the following Dolby Atmos setting: Left only/Right only. MediaConvert uses this value for downmixing. Default value: -3 dB. Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. Related setting: How the service uses this value depends on the value that you choose for Stereo downmix. Related setting: To have MediaConvert use this value, keep the default value, Custom for the setting Downmix control. Otherwise, MediaConvert ignores Left only/Right only surround.
      • ltRtCenterMixLevel

        public final Double ltRtCenterMixLevel()
        Specify a value for the following Dolby Atmos setting: Left total/Right total center mix (Lt/Rt center). MediaConvert uses this value for downmixing. Default value: -3 dB Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, and -6.0. Related setting: How the service uses this value depends on the value that you choose for Stereo downmix. Related setting: To have MediaConvert use this value, keep the default value, Custom for the setting Downmix control. Otherwise, MediaConvert ignores Left total/Right total center.
        Returns:
        Specify a value for the following Dolby Atmos setting: Left total/Right total center mix (Lt/Rt center). MediaConvert uses this value for downmixing. Default value: -3 dB Valid values: 3.0, 1.5, 0.0, -1.5, -3.0, -4.5, and -6.0. Related setting: How the service uses this value depends on the value that you choose for Stereo downmix. Related setting: To have MediaConvert use this value, keep the default value, Custom for the setting Downmix control. Otherwise, MediaConvert ignores Left total/Right total center.
      • ltRtSurroundMixLevel

        public final Double ltRtSurroundMixLevel()
        Specify a value for the following Dolby Atmos setting: Left total/Right total surround mix (Lt/Rt surround). MediaConvert uses this value for downmixing. Default value: -3 dB Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. Related setting: How the service uses this value depends on the value that you choose for Stereo downmix. Related setting: To have MediaConvert use this value, keep the default value, Custom for the setting Downmix control. Otherwise, the service ignores Left total/Right total surround.
        Returns:
        Specify a value for the following Dolby Atmos setting: Left total/Right total surround mix (Lt/Rt surround). MediaConvert uses this value for downmixing. Default value: -3 dB Valid values: -1.5, -3.0, -4.5, -6.0, and -60. The value -60 mutes the channel. Related setting: How the service uses this value depends on the value that you choose for Stereo downmix. Related setting: To have MediaConvert use this value, keep the default value, Custom for the setting Downmix control. Otherwise, the service ignores Left total/Right total surround.
      • 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.
      • speechThreshold

        public final Integer speechThreshold()
        Specify the percentage of audio content, from 0% to 100%, that must be speech in order for the encoder to use the measured speech loudness as the overall program loudness. Default value: 15%
        Returns:
        Specify the percentage of audio content, from 0% to 100%, that must be speech in order for the encoder to use the measured speech loudness as the overall program loudness. Default value: 15%
      • stereoDownmix

        public final Eac3AtmosStereoDownmix stereoDownmix()
        Choose how the service does stereo downmixing. Default value: Not indicated Related setting: To have MediaConvert use this value, keep the default value, Custom for the setting Downmix control. Otherwise, MediaConvert ignores Stereo downmix.

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

        Returns:
        Choose how the service does stereo downmixing. Default value: Not indicated Related setting: To have MediaConvert use this value, keep the default value, Custom for the setting Downmix control. Otherwise, MediaConvert ignores Stereo downmix.
        See Also:
        Eac3AtmosStereoDownmix
      • stereoDownmixAsString

        public final String stereoDownmixAsString()
        Choose how the service does stereo downmixing. Default value: Not indicated Related setting: To have MediaConvert use this value, keep the default value, Custom for the setting Downmix control. Otherwise, MediaConvert ignores Stereo downmix.

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

        Returns:
        Choose how the service does stereo downmixing. Default value: Not indicated Related setting: To have MediaConvert use this value, keep the default value, Custom for the setting Downmix control. Otherwise, MediaConvert ignores Stereo downmix.
        See Also:
        Eac3AtmosStereoDownmix
      • surroundExModeAsString

        public final String surroundExModeAsString()
        Specify whether your input audio has an additional center rear surround channel matrix encoded into your left and right surround channels.

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

        Returns:
        Specify whether your input audio has an additional center rear surround channel matrix encoded into your left and right surround channels.
        See Also:
        Eac3AtmosSurroundExMode
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)