Class AudioParameters

java.lang.Object
software.amazon.awssdk.services.elastictranscoder.model.AudioParameters
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<AudioParameters.Builder,AudioParameters>
@Generated("software.amazon.awssdk:codegen") public final class AudioParameters extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AudioParameters.Builder,AudioParameters>

Parameters required for transcoding audio.

See Also:

  • Method Details

    • codec

      public final String codec()

      The audio codec for the output file. Valid values include aac, flac, mp2, mp3, pcm, and vorbis.

      Returns:
      The audio codec for the output file. Valid values include aac, flac, mp2, mp3, pcm, and vorbis.

    • sampleRate

      public final String sampleRate()

      The sample rate of the audio stream in the output file, in Hertz. Valid values include:

      auto, 22050, 32000, 44100, 48000, 96000

      If you specify auto, Elastic Transcoder automatically detects the sample rate.

      Returns:
      The sample rate of the audio stream in the output file, in Hertz. Valid values include:

      auto, 22050, 32000, 44100, 48000, 96000

      If you specify auto, Elastic Transcoder automatically detects the sample rate.

    • bitRate

      public final String bitRate()

      The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer between 64 and 320, inclusive.

      Returns:
      The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer between 64 and 320, inclusive.

    • channels

      public final String channels()

      The number of audio channels in the output file. The following values are valid:

      auto, 0, 1, 2

      One channel carries the information played by a single speaker. For example, a stereo track with two channels sends one channel to the left speaker, and the other channel to the right speaker. The output channels are organized into tracks. If you want Elastic Transcoder to automatically detect the number of audio channels in the input file and use that value for the output file, select auto.

      The output of a specific channel value and inputs are as follows:

      • auto channel specified, with any input: Pass through up to eight input channels.

      • 0 channels specified, with any input: Audio omitted from the output.

      • 1 channel specified, with at least one input channel: Mono sound.

      • 2 channels specified, with any input: Two identical mono channels or stereo. For more information about tracks, see Audio:AudioPackingMode.

      For more information about how Elastic Transcoder organizes channels and tracks, see Audio:AudioPackingMode.

      Returns:
      The number of audio channels in the output file. The following values are valid:

      auto, 0, 1, 2

      One channel carries the information played by a single speaker. For example, a stereo track with two channels sends one channel to the left speaker, and the other channel to the right speaker. The output channels are organized into tracks. If you want Elastic Transcoder to automatically detect the number of audio channels in the input file and use that value for the output file, select auto.

      The output of a specific channel value and inputs are as follows:

      • auto channel specified, with any input: Pass through up to eight input channels.

      • 0 channels specified, with any input: Audio omitted from the output.

      • 1 channel specified, with at least one input channel: Mono sound.

      • 2 channels specified, with any input: Two identical mono channels or stereo. For more information about tracks, see Audio:AudioPackingMode.

      For more information about how Elastic Transcoder organizes channels and tracks, see Audio:AudioPackingMode.

    • audioPackingMode

      public final String audioPackingMode()

      The method of organizing audio channels and tracks. Use Audio:Channels to specify the number of channels in your output, and Audio:AudioPackingMode to specify the number of tracks and their relation to the channels. If you do not specify an Audio:AudioPackingMode, Elastic Transcoder uses SingleTrack.

      The following values are valid:

      SingleTrack, OneChannelPerTrack, and OneChannelPerTrackWithMosTo8Tracks

      When you specify SingleTrack, Elastic Transcoder creates a single track for your output. The track can have up to eight channels. Use SingleTrack for all non-mxf containers.

      The outputs of SingleTrack for a specific channel value and inputs are as follows:

      • 0 channels with any input: Audio omitted from the output

      • 1, 2, or auto channels with no audio input: Audio omitted from the output

      • 1 channel with any input with audio: One track with one channel, downmixed if necessary

      • 2 channels with one track with one channel: One track with two identical channels

      • 2 or auto channels with two tracks with one channel each: One track with two channels

      • 2 or auto channels with one track with two channels: One track with two channels

      • 2 channels with one track with multiple channels: One track with two channels

      • auto channels with one track with one channel: One track with one channel

      • auto channels with one track with multiple channels: One track with multiple channels

      When you specify OneChannelPerTrack, Elastic Transcoder creates a new track for every channel in your output. Your output can have up to eight single-channel tracks.

      The outputs of OneChannelPerTrack for a specific channel value and inputs are as follows:

      • 0 channels with any input: Audio omitted from the output

      • 1, 2, or auto channels with no audio input: Audio omitted from the output

      • 1 channel with any input with audio: One track with one channel, downmixed if necessary

      • 2 channels with one track with one channel: Two tracks with one identical channel each

      • 2 or auto channels with two tracks with one channel each: Two tracks with one channel each

      • 2 or auto channels with one track with two channels: Two tracks with one channel each

      • 2 channels with one track with multiple channels: Two tracks with one channel each

      • auto channels with one track with one channel: One track with one channel

      • auto channels with one track with multiple channels: Up to eight tracks with one channel each

      When you specify OneChannelPerTrackWithMosTo8Tracks, Elastic Transcoder creates eight single-channel tracks for your output. All tracks that do not contain audio data from an input channel are MOS, or Mit Out Sound, tracks.

      The outputs of OneChannelPerTrackWithMosTo8Tracks for a specific channel value and inputs are as follows:

      • 0 channels with any input: Audio omitted from the output

      • 1, 2, or auto channels with no audio input: Audio omitted from the output

      • 1 channel with any input with audio: One track with one channel, downmixed if necessary, plus six MOS tracks

      • 2 channels with one track with one channel: Two tracks with one identical channel each, plus six MOS tracks

      • 2 or auto channels with two tracks with one channel each: Two tracks with one channel each, plus six MOS tracks

      • 2 or auto channels with one track with two channels: Two tracks with one channel each, plus six MOS tracks

      • 2 channels with one track with multiple channels: Two tracks with one channel each, plus six MOS tracks

      • auto channels with one track with one channel: One track with one channel, plus seven MOS tracks

      • auto channels with one track with multiple channels: Up to eight tracks with one channel each, plus MOS tracks until there are eight tracks in all

      Returns:
      The method of organizing audio channels and tracks. Use Audio:Channels to specify the number of channels in your output, and Audio:AudioPackingMode to specify the number of tracks and their relation to the channels. If you do not specify an Audio:AudioPackingMode, Elastic Transcoder uses SingleTrack.

      The following values are valid:

      SingleTrack, OneChannelPerTrack, and OneChannelPerTrackWithMosTo8Tracks

      When you specify SingleTrack, Elastic Transcoder creates a single track for your output. The track can have up to eight channels. Use SingleTrack for all non-mxf containers.

      The outputs of SingleTrack for a specific channel value and inputs are as follows:

      • 0 channels with any input: Audio omitted from the output

      • 1, 2, or auto channels with no audio input: Audio omitted from the output

      • 1 channel with any input with audio: One track with one channel, downmixed if necessary

      • 2 channels with one track with one channel: One track with two identical channels

      • 2 or auto channels with two tracks with one channel each: One track with two channels

      • 2 or auto channels with one track with two channels: One track with two channels

      • 2 channels with one track with multiple channels: One track with two channels

      • auto channels with one track with one channel: One track with one channel

      • auto channels with one track with multiple channels: One track with multiple channels

      When you specify OneChannelPerTrack, Elastic Transcoder creates a new track for every channel in your output. Your output can have up to eight single-channel tracks.

      The outputs of OneChannelPerTrack for a specific channel value and inputs are as follows:

      • 0 channels with any input: Audio omitted from the output

      • 1, 2, or auto channels with no audio input: Audio omitted from the output

      • 1 channel with any input with audio: One track with one channel, downmixed if necessary

      • 2 channels with one track with one channel: Two tracks with one identical channel each

      • 2 or auto channels with two tracks with one channel each: Two tracks with one channel each

      • 2 or auto channels with one track with two channels: Two tracks with one channel each

      • 2 channels with one track with multiple channels: Two tracks with one channel each

      • auto channels with one track with one channel: One track with one channel

      • auto channels with one track with multiple channels: Up to eight tracks with one channel each

      When you specify OneChannelPerTrackWithMosTo8Tracks, Elastic Transcoder creates eight single-channel tracks for your output. All tracks that do not contain audio data from an input channel are MOS, or Mit Out Sound, tracks.

      The outputs of OneChannelPerTrackWithMosTo8Tracks for a specific channel value and inputs are as follows:

      • 0 channels with any input: Audio omitted from the output

      • 1, 2, or auto channels with no audio input: Audio omitted from the output

      • 1 channel with any input with audio: One track with one channel, downmixed if necessary, plus six MOS tracks

      • 2 channels with one track with one channel: Two tracks with one identical channel each, plus six MOS tracks

      • 2 or auto channels with two tracks with one channel each: Two tracks with one channel each, plus six MOS tracks

      • 2 or auto channels with one track with two channels: Two tracks with one channel each, plus six MOS tracks

      • 2 channels with one track with multiple channels: Two tracks with one channel each, plus six MOS tracks

      • auto channels with one track with one channel: One track with one channel, plus seven MOS tracks

      • auto channels with one track with multiple channels: Up to eight tracks with one channel each, plus MOS tracks until there are eight tracks in all

    • codecOptions

      public final AudioCodecOptions codecOptions()

      If you specified AAC for Audio:Codec, this is the AAC compression profile to use. Valid values include:

      auto, AAC-LC, HE-AAC, HE-AACv2

      If you specify auto, Elastic Transcoder chooses a profile based on the bit rate of the output file.

      Returns:
      If you specified AAC for Audio:Codec, this is the AAC compression profile to use. Valid values include:

      auto, AAC-LC, HE-AAC, HE-AACv2

      If you specify auto, Elastic Transcoder chooses a profile based on the bit rate of the output file.

    • toBuilder

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

    • builder

      public static AudioParameters.Builder builder()

    • serializableBuilderClass

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