Class Ac3Settings

    • Method Detail

      • 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 Ac3BitstreamMode bitstreamMode()
        Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values.

        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:
        Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values.
        See Also:
        Ac3BitstreamMode
      • bitstreamModeAsString

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

        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:
        Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values.
        See Also:
        Ac3BitstreamMode
      • 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:
        Ac3CodingMode
      • 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:
        Ac3CodingMode
      • dialnorm

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

        public final Ac3DrcProfile drcProfile()
        If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification.

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

        Returns:
        If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification.
        See Also:
        Ac3DrcProfile
      • drcProfileAsString

        public final String drcProfileAsString()
        If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification.

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

        Returns:
        If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification.
        See Also:
        Ac3DrcProfile
      • lfeFilter

        public final Ac3LfeFilter lfeFilter()
        When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe 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:
        When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode.
        See Also:
        Ac3LfeFilter
      • lfeFilterAsString

        public final String lfeFilterAsString()
        When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe 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:
        When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode.
        See Also:
        Ac3LfeFilter
      • metadataControl

        public final Ac3MetadataControl 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 Ac3MetadataControl.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:
        Ac3MetadataControl
      • 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 Ac3MetadataControl.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:
        Ac3MetadataControl
      • attenuationControl

        public final Ac3AttenuationControl attenuationControl()
        Applies a 3 dB attenuation to the surround channels. Applies only when the coding mode parameter is CODING_MODE_3_2_LFE.

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

        Returns:
        Applies a 3 dB attenuation to the surround channels. Applies only when the coding mode parameter is CODING_MODE_3_2_LFE.
        See Also:
        Ac3AttenuationControl
      • attenuationControlAsString

        public final String attenuationControlAsString()
        Applies a 3 dB attenuation to the surround channels. Applies only when the coding mode parameter is CODING_MODE_3_2_LFE.

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

        Returns:
        Applies a 3 dB attenuation to the surround channels. Applies only when the coding mode parameter is CODING_MODE_3_2_LFE.
        See Also:
        Ac3AttenuationControl
      • 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)