Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.ElasticTranscoder.Types.JobInput

Description

Synopsis

data JobInput = JobInput' {
- frameRate :: Maybe Text
- resolution :: Maybe Text
- aspectRatio :: Maybe Text
- timeSpan :: Maybe TimeSpan
- encryption :: Maybe Encryption
- key :: Maybe Text
- detectedProperties :: Maybe DetectedProperties
- container :: Maybe Text
- interlaced :: Maybe Text
- inputCaptions :: Maybe InputCaptions
}
newJobInput :: JobInput
jobInput_frameRate :: Lens' JobInput (Maybe Text)
jobInput_resolution :: Lens' JobInput (Maybe Text)
jobInput_aspectRatio :: Lens' JobInput (Maybe Text)
jobInput_timeSpan :: Lens' JobInput (Maybe TimeSpan)
jobInput_encryption :: Lens' JobInput (Maybe Encryption)
jobInput_key :: Lens' JobInput (Maybe Text)
jobInput_detectedProperties :: Lens' JobInput (Maybe DetectedProperties)
jobInput_container :: Lens' JobInput (Maybe Text)
jobInput_interlaced :: Lens' JobInput (Maybe Text)
jobInput_inputCaptions :: Lens' JobInput (Maybe InputCaptions)

Documentation

data JobInput Source #

Information about the file that you're transcoding.

See: newJobInput smart constructor.

Constructors

JobInput'

Fields

frameRate :: Maybe Text
The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate of the input file, specify auto. If you want to specify the frame rate for the input file, enter one of the following values:
10, 15, 23.97, 24, 25, 29.97, 30, 60
If you specify a value other than auto, Elastic Transcoder disables automatic detection of the frame rate.
resolution :: Maybe Text
This value must be auto, which causes Elastic Transcoder to automatically detect the resolution of the input file.
aspectRatio :: Maybe Text
The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect ratio of the input file, specify auto. If you want to specify the aspect ratio for the output file, enter one of the following values:
1:1, 4:3, 3:2, 16:9
If you specify a value other than auto, Elastic Transcoder disables automatic detection of the aspect ratio.
timeSpan :: Maybe TimeSpan
Settings for clipping an input. Each input can have different clip settings.
encryption :: Maybe Encryption
The encryption settings, if any, that are used for decrypting your input files. If your input file is encrypted, you must specify the mode that Elastic Transcoder uses to decrypt your file.
key :: Maybe Text
The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID of the pipeline to use for processing the job. The InputBucket object in that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from.
If the file name includes a prefix, such as cooking/lasagna.mpg, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.
detectedProperties :: Maybe DetectedProperties
The detected properties of the input file.
container :: Maybe Text
The container type for the input file. If you want Elastic Transcoder to automatically detect the container type of the input file, specify auto. If you want to specify the container type for the input file, enter one of the following values:
3gp, aac, asf, avi, divx, flv, m4a, mkv, mov, mp3, mp4, mpeg, mpeg-ps, mpeg-ts, mxf, ogg, vob, wav, webm
interlaced :: Maybe Text
Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether the input file is interlaced, specify auto. If you want to specify whether the input file is interlaced, enter one of the following values:
true, false
If you specify a value other than auto, Elastic Transcoder disables automatic detection of interlacing.
inputCaptions :: Maybe InputCaptions
You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions:
- Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file.
  Valid input values include: CEA-608 (EIA-608, first non-empty channel only), CEA-708 (EIA-708, first non-empty channel only), and mov-text
  Valid outputs include: mov-text
  Elastic Transcoder supports a maximum of one embedded format per output.
- Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file.
  Valid input values include: dfxp (first div element only), ebu-tt, scc, smpt, srt, ttml (first div element only), and webvtt
  Valid outputs include: dfxp (first div element only), scc, srt, and webvtt.
If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.
Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.
To remove captions or leave the captions empty, set Captions to null. To pass through existing captions unchanged, set the MergePolicy to MergeRetain, and pass in a null CaptionSources array.
For more information on embedded files, see the Subtitles Wikipedia page.
For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.

Instances

Instances details

Eq JobInput Source #
Instance details Defined in Amazonka.ElasticTranscoder.Types.JobInput Methods (==) :: JobInput -> JobInput -> Bool # (/=) :: JobInput -> JobInput -> Bool #
Read JobInput Source #
Instance details Defined in Amazonka.ElasticTranscoder.Types.JobInput Methods readsPrec :: Int -> ReadS JobInput # readList :: ReadS [JobInput] # readPrec :: ReadPrec JobInput # readListPrec :: ReadPrec [JobInput] #
Show JobInput Source #
Instance details Defined in Amazonka.ElasticTranscoder.Types.JobInput Methods showsPrec :: Int -> JobInput -> ShowS # show :: JobInput -> String # showList :: [JobInput] -> ShowS #
Generic JobInput Source #
Instance details Defined in Amazonka.ElasticTranscoder.Types.JobInput Associated Types type Rep JobInput :: Type -> Type # Methods from :: JobInput -> Rep JobInput x # to :: Rep JobInput x -> JobInput #
NFData JobInput Source #
Instance details Defined in Amazonka.ElasticTranscoder.Types.JobInput Methods rnf :: JobInput -> () #
Hashable JobInput Source #
Instance details Defined in Amazonka.ElasticTranscoder.Types.JobInput Methods hashWithSalt :: Int -> JobInput -> Int # hash :: JobInput -> Int #
ToJSON JobInput Source #
Instance details Defined in Amazonka.ElasticTranscoder.Types.JobInput Methods toJSON :: JobInput -> Value # toEncoding :: JobInput -> Encoding # toJSONList :: [JobInput] -> Value # toEncodingList :: [JobInput] -> Encoding #
FromJSON JobInput Source #
Instance details Defined in Amazonka.ElasticTranscoder.Types.JobInput Methods parseJSON :: Value -> Parser JobInput # parseJSONList :: Value -> Parser [JobInput] #
type Rep JobInput Source #
Instance details Defined in Amazonka.ElasticTranscoder.Types.JobInput type Rep JobInput = D1 ('MetaData "JobInput" "Amazonka.ElasticTranscoder.Types.JobInput" "libZSservicesZSamazonka-elastictranscoderZSamazonka-elastictranscoder" 'False) (C1 ('MetaCons "JobInput'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "frameRate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "resolution") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "aspectRatio") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "timeSpan") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimeSpan)) :: S1 ('MetaSel ('Just "encryption") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Encryption))))) :: ((S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "detectedProperties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DetectedProperties))) :: (S1 ('MetaSel ('Just "container") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "interlaced") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "inputCaptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputCaptions)))))))

newJobInput :: JobInput Source #

Create a value of JobInput 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:frameRate:JobInput', jobInput_frameRate - The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate of the input file, specify auto. If you want to specify the frame rate for the input file, enter one of the following values:

10, 15, 23.97, 24, 25, 29.97, 30, 60

If you specify a value other than auto, Elastic Transcoder disables automatic detection of the frame rate.

$sel:resolution:JobInput', jobInput_resolution - This value must be auto, which causes Elastic Transcoder to automatically detect the resolution of the input file.

$sel:aspectRatio:JobInput', jobInput_aspectRatio - The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect ratio of the input file, specify auto. If you want to specify the aspect ratio for the output file, enter one of the following values:

1:1, 4:3, 3:2, 16:9

If you specify a value other than auto, Elastic Transcoder disables automatic detection of the aspect ratio.

$sel:timeSpan:JobInput', jobInput_timeSpan - Settings for clipping an input. Each input can have different clip settings.

$sel:encryption:JobInput', jobInput_encryption - The encryption settings, if any, that are used for decrypting your input files. If your input file is encrypted, you must specify the mode that Elastic Transcoder uses to decrypt your file.

$sel:key:JobInput', jobInput_key - The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID of the pipeline to use for processing the job. The InputBucket object in that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from.

If the file name includes a prefix, such as cooking/lasagna.mpg, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

$sel:detectedProperties:JobInput', jobInput_detectedProperties - The detected properties of the input file.

$sel:container:JobInput', jobInput_container - The container type for the input file. If you want Elastic Transcoder to automatically detect the container type of the input file, specify auto. If you want to specify the container type for the input file, enter one of the following values:

3gp, aac, asf, avi, divx, flv, m4a, mkv, mov, mp3, mp4, mpeg, mpeg-ps, mpeg-ts, mxf, ogg, vob, wav, webm

$sel:interlaced:JobInput', jobInput_interlaced - Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether the input file is interlaced, specify auto. If you want to specify whether the input file is interlaced, enter one of the following values:

true, false

If you specify a value other than auto, Elastic Transcoder disables automatic detection of interlacing.

$sel:inputCaptions:JobInput', jobInput_inputCaptions - You can configure Elastic Transcoder to transcode captions, or subtitles, from one format to another. All captions must be in UTF-8. Elastic Transcoder supports two types of captions:

Embedded: Embedded captions are included in the same file as the audio and video. Elastic Transcoder supports only one embedded caption per language, to a maximum of 300 embedded captions per file.
Valid input values include: CEA-608 (EIA-608, first non-empty channel only), CEA-708 (EIA-708, first non-empty channel only), and mov-text
Valid outputs include: mov-text
Elastic Transcoder supports a maximum of one embedded format per output.
Sidecar: Sidecar captions are kept in a separate metadata file from the audio and video data. Sidecar captions require a player that is capable of understanding the relationship between the video file and the sidecar file. Elastic Transcoder supports only one sidecar caption per language, to a maximum of 20 sidecar captions per file.
Valid input values include: dfxp (first div element only), ebu-tt, scc, smpt, srt, ttml (first div element only), and webvtt
Valid outputs include: dfxp (first div element only), scc, srt, and webvtt.

If you want ttml or smpte-tt compatible captions, specify dfxp as your output format.

Elastic Transcoder does not support OCR (Optical Character Recognition), does not accept pictures as a valid input for captions, and is not available for audio-only transcoding. Elastic Transcoder does not preserve text formatting (for example, italics) during the transcoding process.

To remove captions or leave the captions empty, set Captions to null. To pass through existing captions unchanged, set the MergePolicy to MergeRetain, and pass in a null CaptionSources array.

For more information on embedded files, see the Subtitles Wikipedia page.

For more information on sidecar files, see the Extensible Metadata Platform and Sidecar file Wikipedia pages.

jobInput_frameRate :: Lens' JobInput (Maybe Text) Source #

The frame rate of the input file. If you want Elastic Transcoder to automatically detect the frame rate of the input file, specify auto. If you want to specify the frame rate for the input file, enter one of the following values:

10, 15, 23.97, 24, 25, 29.97, 30, 60

If you specify a value other than auto, Elastic Transcoder disables automatic detection of the frame rate.

jobInput_resolution :: Lens' JobInput (Maybe Text) Source #

This value must be auto, which causes Elastic Transcoder to automatically detect the resolution of the input file.

jobInput_aspectRatio :: Lens' JobInput (Maybe Text) Source #

The aspect ratio of the input file. If you want Elastic Transcoder to automatically detect the aspect ratio of the input file, specify auto. If you want to specify the aspect ratio for the output file, enter one of the following values:

1:1, 4:3, 3:2, 16:9

If you specify a value other than auto, Elastic Transcoder disables automatic detection of the aspect ratio.

jobInput_timeSpan :: Lens' JobInput (Maybe TimeSpan) Source #

Settings for clipping an input. Each input can have different clip settings.

jobInput_encryption :: Lens' JobInput (Maybe Encryption) Source #

The encryption settings, if any, that are used for decrypting your input files. If your input file is encrypted, you must specify the mode that Elastic Transcoder uses to decrypt your file.

jobInput_key :: Lens' JobInput (Maybe Text) Source #

The name of the file to transcode. Elsewhere in the body of the JSON block is the the ID of the pipeline to use for processing the job. The InputBucket object in that pipeline tells Elastic Transcoder which Amazon S3 bucket to get the file from.

If the file name includes a prefix, such as cooking/lasagna.mpg, include the prefix in the key. If the file isn't in the specified bucket, Elastic Transcoder returns an error.

jobInput_detectedProperties :: Lens' JobInput (Maybe DetectedProperties) Source #

The detected properties of the input file.

jobInput_container :: Lens' JobInput (Maybe Text) Source #

The container type for the input file. If you want Elastic Transcoder to automatically detect the container type of the input file, specify auto. If you want to specify the container type for the input file, enter one of the following values:

3gp, aac, asf, avi, divx, flv, m4a, mkv, mov, mp3, mp4, mpeg, mpeg-ps, mpeg-ts, mxf, ogg, vob, wav, webm

jobInput_interlaced :: Lens' JobInput (Maybe Text) Source #

Whether the input file is interlaced. If you want Elastic Transcoder to automatically detect whether the input file is interlaced, specify auto. If you want to specify whether the input file is interlaced, enter one of the following values: