Class AudioCodecSettings

java.lang.Object
software.amazon.awssdk.services.mediaconvert.model.AudioCodecSettings
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AudioCodecSettings.Builder,AudioCodecSettings>
@Generated("software.amazon.awssdk:codegen") public final class AudioCodecSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AudioCodecSettings.Builder,AudioCodecSettings>
Settings related to audio encoding. The settings in this group vary depending on the value that you choose for your audio codec.
See Also:

  • Method Details

    • aacSettings

      public final AacSettings aacSettings()
      Required when you set Codec to the value AAC. The service accepts one of two mutually exclusive groups of AAC settings--VBR and CBR. To select one of these modes, set the value of Bitrate control mode to "VBR" or "CBR". In VBR mode, you control the audio quality with the setting VBR quality. In CBR mode, you use the setting Bitrate. Defaults and valid values depend on the rate control mode.
      Returns:
      Required when you set Codec to the value AAC. The service accepts one of two mutually exclusive groups of AAC settings--VBR and CBR. To select one of these modes, set the value of Bitrate control mode to "VBR" or "CBR". In VBR mode, you control the audio quality with the setting VBR quality. In CBR mode, you use the setting Bitrate. Defaults and valid values depend on the rate control mode.

    • ac3Settings

      public final Ac3Settings ac3Settings()
      Required when you set Codec to the value AC3.
      Returns:
      Required when you set Codec to the value AC3.

    • aiffSettings

      public final AiffSettings aiffSettings()
      Required when you set Codec to the value AIFF.
      Returns:
      Required when you set Codec to the value AIFF.

    • codec

      public final AudioCodec codec()
      Choose the audio codec for this output. Note that the option Dolby Digital passthrough applies only to Dolby Digital and Dolby Digital Plus audio inputs. Make sure that you choose a codec that's supported with your output container: https://docs.aws.amazon.com/mediaconvert/latest/ug/reference-codecs-containers.html#reference-codecs-containers -output-audio For audio-only outputs, make sure that both your input audio codec and your output audio codec are supported for audio-only workflows. For more information, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/ reference-codecs-containers-input.html#reference-codecs-containers-input-audio-only and https://docs.aws.amazon.com/mediaconvert/latest/ug/reference-codecs-containers.html#audio-only-output

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

      Returns:
      Choose the audio codec for this output. Note that the option Dolby Digital passthrough applies only to Dolby Digital and Dolby Digital Plus audio inputs. Make sure that you choose a codec that's supported with your output container: https://docs.aws.amazon.com/mediaconvert/latest/ug/reference-codecs-containers .html#reference-codecs-containers-output-audio For audio-only outputs, make sure that both your input audio codec and your output audio codec are supported for audio-only workflows. For more information, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/reference-codecs-containers-input.html#reference- codecs-containers-input-audio-only and https://docs.aws.amazon.com/mediaconvert/latest/ug/reference-codecs-containers.html#audio-only-output
      See Also:

    • codecAsString

      public final String codecAsString()
      Choose the audio codec for this output. Note that the option Dolby Digital passthrough applies only to Dolby Digital and Dolby Digital Plus audio inputs. Make sure that you choose a codec that's supported with your output container: https://docs.aws.amazon.com/mediaconvert/latest/ug/reference-codecs-containers.html#reference-codecs-containers -output-audio For audio-only outputs, make sure that both your input audio codec and your output audio codec are supported for audio-only workflows. For more information, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/ reference-codecs-containers-input.html#reference-codecs-containers-input-audio-only and https://docs.aws.amazon.com/mediaconvert/latest/ug/reference-codecs-containers.html#audio-only-output

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

      Returns:
      Choose the audio codec for this output. Note that the option Dolby Digital passthrough applies only to Dolby Digital and Dolby Digital Plus audio inputs. Make sure that you choose a codec that's supported with your output container: https://docs.aws.amazon.com/mediaconvert/latest/ug/reference-codecs-containers .html#reference-codecs-containers-output-audio For audio-only outputs, make sure that both your input audio codec and your output audio codec are supported for audio-only workflows. For more information, see: https://docs.aws.amazon.com/mediaconvert/latest/ug/reference-codecs-containers-input.html#reference- codecs-containers-input-audio-only and https://docs.aws.amazon.com/mediaconvert/latest/ug/reference-codecs-containers.html#audio-only-output
      See Also:

    • eac3AtmosSettings

      public final Eac3AtmosSettings eac3AtmosSettings()
      Required when you set Codec to the value EAC3_ATMOS.
      Returns:
      Required when you set Codec to the value EAC3_ATMOS.

    • eac3Settings

      public final Eac3Settings eac3Settings()
      Required when you set Codec to the value EAC3.
      Returns:
      Required when you set Codec to the value EAC3.

    • flacSettings

      public final FlacSettings flacSettings()
      Required when you set Codec, under AudioDescriptions>CodecSettings, to the value FLAC.
      Returns:
      Required when you set Codec, under AudioDescriptions>CodecSettings, to the value FLAC.

    • mp2Settings

      public final Mp2Settings mp2Settings()
      Required when you set Codec to the value MP2.
      Returns:
      Required when you set Codec to the value MP2.

    • mp3Settings

      public final Mp3Settings mp3Settings()
      Required when you set Codec, under AudioDescriptions>CodecSettings, to the value MP3.
      Returns:
      Required when you set Codec, under AudioDescriptions>CodecSettings, to the value MP3.

    • opusSettings

      public final OpusSettings opusSettings()
      Required when you set Codec, under AudioDescriptions>CodecSettings, to the value OPUS.
      Returns:
      Required when you set Codec, under AudioDescriptions>CodecSettings, to the value OPUS.

    • vorbisSettings

      public final VorbisSettings vorbisSettings()
      Required when you set Codec, under AudioDescriptions>CodecSettings, to the value Vorbis.
      Returns:
      Required when you set Codec, under AudioDescriptions>CodecSettings, to the value Vorbis.

    • wavSettings

      public final WavSettings wavSettings()
      Required when you set Codec to the value WAV.
      Returns:
      Required when you set Codec to the value WAV.

    • toBuilder

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

    • builder

      public static AudioCodecSettings.Builder builder()

    • serializableBuilderClass

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