libZSservicesZSamazonka-elastictranscoderZSamazonka-elastictranscoder
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.ElasticTranscoder.Types.AudioParameters

Description

 
Synopsis

Documentation

data AudioParameters Source #

Parameters required for transcoding audio.

See: newAudioParameters smart constructor.

Constructors

AudioParameters' 

Fields

  • channels :: Maybe Text

    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.

  • codec :: Maybe Text

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

  • audioPackingMode :: Maybe Text

    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
  • sampleRate :: Maybe Text

    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 :: Maybe Text

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

  • codecOptions :: Maybe AudioCodecOptions

    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.

Instances

Instances details
Eq AudioParameters Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.AudioParameters

Read AudioParameters Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.AudioParameters

Show AudioParameters Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.AudioParameters

Generic AudioParameters Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.AudioParameters

Associated Types

type Rep AudioParameters :: Type -> Type #

NFData AudioParameters Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.AudioParameters

Methods

rnf :: AudioParameters -> () #

Hashable AudioParameters Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.AudioParameters

ToJSON AudioParameters Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.AudioParameters

FromJSON AudioParameters Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.AudioParameters

type Rep AudioParameters Source # 
Instance details

Defined in Amazonka.ElasticTranscoder.Types.AudioParameters

type Rep AudioParameters = D1 ('MetaData "AudioParameters" "Amazonka.ElasticTranscoder.Types.AudioParameters" "libZSservicesZSamazonka-elastictranscoderZSamazonka-elastictranscoder" 'False) (C1 ('MetaCons "AudioParameters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "channels") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "codec") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "audioPackingMode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "sampleRate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "bitRate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "codecOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AudioCodecOptions))))))

newAudioParameters :: AudioParameters Source #

Create a value of AudioParameters with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:channels:AudioParameters', audioParameters_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.

$sel:codec:AudioParameters', audioParameters_codec - The audio codec for the output file. Valid values include aac, flac, mp2, mp3, pcm, and vorbis.

$sel:audioPackingMode:AudioParameters', audioParameters_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

$sel:sampleRate:AudioParameters', audioParameters_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.

$sel:bitRate:AudioParameters', audioParameters_bitRate - The bit rate of the audio stream in the output file, in kilobits/second. Enter an integer between 64 and 320, inclusive.

$sel:codecOptions:AudioParameters', audioParameters_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.

audioParameters_channels :: Lens' AudioParameters (Maybe Text) Source #

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.

audioParameters_codec :: Lens' AudioParameters (Maybe Text) Source #

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

audioParameters_audioPackingMode :: Lens' AudioParameters (Maybe Text) Source #

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

audioParameters_sampleRate :: Lens' AudioParameters (Maybe Text) Source #

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.

audioParameters_bitRate :: Lens' AudioParameters (Maybe Text) Source #

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

audioParameters_codecOptions :: Lens' AudioParameters (Maybe AudioCodecOptions) Source #

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.