| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.MediaConvert.Types.Input
Description
Synopsis
- data Input = Input' {
- audioSelectorGroups :: Maybe (HashMap Text AudioSelectorGroup)
- audioSelectors :: Maybe (HashMap Text AudioSelector)
- captionSelectors :: Maybe (HashMap Text CaptionSelector)
- crop :: Maybe Rectangle
- deblockFilter :: Maybe InputDeblockFilter
- decryptionSettings :: Maybe InputDecryptionSettings
- denoiseFilter :: Maybe InputDenoiseFilter
- dolbyVisionMetadataXml :: Maybe Text
- fileInput :: Maybe Text
- filterEnable :: Maybe InputFilterEnable
- filterStrength :: Maybe Int
- imageInserter :: Maybe ImageInserter
- inputClippings :: Maybe [InputClipping]
- inputScanType :: Maybe InputScanType
- position :: Maybe Rectangle
- programNumber :: Maybe Natural
- psiControl :: Maybe InputPsiControl
- supplementalImps :: Maybe [Text]
- timecodeSource :: Maybe InputTimecodeSource
- timecodeStart :: Maybe Text
- videoGenerator :: Maybe InputVideoGenerator
- videoSelector :: Maybe VideoSelector
- newInput :: Input
- input_audioSelectorGroups :: Lens' Input (Maybe (HashMap Text AudioSelectorGroup))
- input_audioSelectors :: Lens' Input (Maybe (HashMap Text AudioSelector))
- input_captionSelectors :: Lens' Input (Maybe (HashMap Text CaptionSelector))
- input_crop :: Lens' Input (Maybe Rectangle)
- input_deblockFilter :: Lens' Input (Maybe InputDeblockFilter)
- input_decryptionSettings :: Lens' Input (Maybe InputDecryptionSettings)
- input_denoiseFilter :: Lens' Input (Maybe InputDenoiseFilter)
- input_dolbyVisionMetadataXml :: Lens' Input (Maybe Text)
- input_fileInput :: Lens' Input (Maybe Text)
- input_filterEnable :: Lens' Input (Maybe InputFilterEnable)
- input_filterStrength :: Lens' Input (Maybe Int)
- input_imageInserter :: Lens' Input (Maybe ImageInserter)
- input_inputClippings :: Lens' Input (Maybe [InputClipping])
- input_inputScanType :: Lens' Input (Maybe InputScanType)
- input_position :: Lens' Input (Maybe Rectangle)
- input_programNumber :: Lens' Input (Maybe Natural)
- input_psiControl :: Lens' Input (Maybe InputPsiControl)
- input_supplementalImps :: Lens' Input (Maybe [Text])
- input_timecodeSource :: Lens' Input (Maybe InputTimecodeSource)
- input_timecodeStart :: Lens' Input (Maybe Text)
- input_videoGenerator :: Lens' Input (Maybe InputVideoGenerator)
- input_videoSelector :: Lens' Input (Maybe VideoSelector)
Documentation
Use inputs to define the source files used in your transcoding job. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/specify-input-settings.html. You can use multiple video inputs to do input stitching. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/assembling-multiple-inputs-and-input-clips.html
See: newInput smart constructor.
Constructors
| Input' | |
Fields
| |
Instances
Create a value of Input 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:audioSelectorGroups:Input', input_audioSelectorGroups - Use audio selector groups to combine multiple sidecar audio inputs so
that you can assign them to a single output audio tab
(AudioDescription). Note that, if you're working with embedded audio,
it's simpler to assign multiple input tracks into a single audio
selector rather than use an audio selector group.
$sel:audioSelectors:Input', input_audioSelectors - Use Audio selectors (AudioSelectors) to specify a track or set of tracks
from the input that you will use in your outputs. You can use multiple
Audio selectors per input.
$sel:captionSelectors:Input', input_captionSelectors - Use captions selectors to specify the captions data from your input that
you use in your outputs. You can use up to 20 captions selectors per
input.
$sel:crop:Input', input_crop - Use Cropping selection (crop) to specify the video area that the service
will include in the output video frame. If you specify a value here, it
will override any value that you specify in the output setting Cropping
selection (crop).
$sel:deblockFilter:Input', input_deblockFilter - Enable Deblock (InputDeblockFilter) to produce smoother motion in the
output. Default is disabled. Only manually controllable for MPEG2 and
uncompressed video inputs.
$sel:decryptionSettings:Input', input_decryptionSettings - Settings for decrypting any input files that you encrypt before you
upload them to Amazon S3. MediaConvert can decrypt files only when you
use AWS Key Management Service (KMS) to encrypt the data key that you
use to encrypt your content.
$sel:denoiseFilter:Input', input_denoiseFilter - Enable Denoise (InputDenoiseFilter) to filter noise from the input.
Default is disabled. Only applicable to MPEG2, H.264, H.265, and
uncompressed video inputs.
$sel:dolbyVisionMetadataXml:Input', input_dolbyVisionMetadataXml - Use this setting only when your video source has Dolby Vision studio
mastering metadata that is carried in a separate XML file. Specify the
Amazon S3 location for the metadata XML file. MediaConvert uses this
file to provide global and frame-level metadata for Dolby Vision
preprocessing. When you specify a file here and your input also has
interleaved global and frame level metadata, MediaConvert ignores the
interleaved metadata and uses only the the metadata from this external
XML file. Note that your IAM service role must grant MediaConvert read
permissions to this file. For more information, see
https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html.
$sel:fileInput:Input', input_fileInput - Specify the source file for your transcoding job. You can use multiple
inputs in a single job. The service concatenates these inputs, in the
order that you specify them in the job, to create the outputs. If your
input format is IMF, specify your input by providing the path to your
CPL. For example, "s3://bucket/vf/cpl.xml". If the CPL is in an
incomplete IMP, make sure to use *Supplemental IMPs* (SupplementalImps)
to specify any supplemental IMPs that contain assets referenced by the
CPL.
$sel:filterEnable:Input', input_filterEnable - Specify how the transcoding service applies the denoise and deblock
filters. You must also enable the filters separately, with Denoise
(InputDenoiseFilter) and Deblock (InputDeblockFilter). * Auto - The
transcoding service determines whether to apply filtering, depending on
input type and quality. * Disable - The input is not filtered. This is
true even if you use the API to enable them in (InputDeblockFilter) and
(InputDeblockFilter). * Force - The input is filtered regardless of
input type.
$sel:filterStrength:Input', input_filterStrength - Use Filter strength (FilterStrength) to adjust the magnitude the input
filter settings (Deblock and Denoise). The range is -5 to 5. Default is
0.
$sel:imageInserter:Input', input_imageInserter - Enable the image inserter feature to include a graphic overlay on your
video. Enable or disable this feature for each input individually. This
setting is disabled by default.
$sel:inputClippings:Input', input_inputClippings - (InputClippings) contains sets of start and end times that together
specify a portion of the input to be used in the outputs. If you provide
only a start time, the clip will be the entire input from that point to
the end. If you provide only an end time, it will be the entire input up
to that point. When you specify more than one input clip, the
transcoding service creates the job outputs by stringing the clips
together in the order you specify them.
$sel:inputScanType:Input', input_inputScanType - When you have a progressive segmented frame (PsF) input, use this
setting to flag the input as PsF. MediaConvert doesn't automatically
detect PsF. Therefore, flagging your input as PsF results in better
preservation of video quality when you do deinterlacing and frame rate
conversion. If you don't specify, the default value is Auto (AUTO).
Auto is the correct setting for all inputs that are not PsF. Don't set
this value to PsF when your input is interlaced. Doing so creates
horizontal interlacing artifacts.
$sel:position:Input', input_position - Use Selection placement (position) to define the video area in your
output frame. The area outside of the rectangle that you specify here is
black. If you specify a value here, it will override any value that you
specify in the output setting Selection placement (position). If you
specify a value here, this will override any AFD values in your input,
even if you set Respond to AFD (RespondToAfd) to Respond (RESPOND). If
you specify a value here, this will ignore anything that you specify for
the setting Scaling Behavior (scalingBehavior).
Input, input_programNumber - Use Program (programNumber) to select a specific program from within a
multi-program transport stream. Note that Quad 4K is not currently
supported. Default is the first program within the transport stream. If
the program you specify doesn't exist, the transcoding service will use
this default.
$sel:psiControl:Input', input_psiControl - Set PSI control (InputPsiControl) for transport stream inputs to specify
which data the demux process to scans. * Ignore PSI - Scan all PIDs for
audio and video. * Use PSI - Scan only PSI data.
$sel:supplementalImps:Input', input_supplementalImps - Provide a list of any necessary supplemental IMPs. You need supplemental
IMPs if the CPL that you're using for your input is in an incomplete
IMP. Specify either the supplemental IMP directories with a trailing
slash or the ASSETMAP.xml files. For example ["s3://bucket/ov/",
"s3://bucket/vf2/ASSETMAP.xml"]. You don't need to specify the
IMP that contains your input CPL, because the service automatically
detects it.
$sel:timecodeSource:Input', input_timecodeSource - Use this Timecode source setting, located under the input settings
(InputTimecodeSource), to specify how the service counts input video
frames. This input frame count affects only the behavior of features
that apply to a single input at a time, such as input clipping and
synchronizing some captions formats. Choose Embedded (EMBEDDED) to use
the timecodes in your input video. Choose Start at zero (ZEROBASED) to
start the first frame at zero. Choose Specified start (SPECIFIEDSTART)
to start the first frame at the timecode that you specify in the setting
Start timecode (timecodeStart). If you don't specify a value for
Timecode source, the service will use Embedded by default. For more
information about timecodes, see
https://docs.aws.amazon.com/console/mediaconvert/timecode.
$sel:timecodeStart:Input', input_timecodeStart - Specify the timecode that you want the service to use for this input's
initial frame. To use this setting, you must set the Timecode source
setting, located under the input settings (InputTimecodeSource), to
Specified start (SPECIFIEDSTART). For more information about timecodes,
see https://docs.aws.amazon.com/console/mediaconvert/timecode.
$sel:videoGenerator:Input', input_videoGenerator - When you include Video generator, MediaConvert creates a video input
with black frames. Use this setting if you do not have a video input or
if you want to add black video frames before, or after, other inputs.
You can specify Video generator, or you can specify an Input file, but
you cannot specify both. For more information, see
https://docs.aws.amazon.com/mediaconvert/latest/ug/video-generator.html
$sel:videoSelector:Input', input_videoSelector - Input video selectors contain the video settings for the input. Each of
your inputs can have up to one video selector.
input_audioSelectorGroups :: Lens' Input (Maybe (HashMap Text AudioSelectorGroup)) Source #
Use audio selector groups to combine multiple sidecar audio inputs so that you can assign them to a single output audio tab (AudioDescription). Note that, if you're working with embedded audio, it's simpler to assign multiple input tracks into a single audio selector rather than use an audio selector group.
input_audioSelectors :: Lens' Input (Maybe (HashMap Text AudioSelector)) Source #
Use Audio selectors (AudioSelectors) to specify a track or set of tracks from the input that you will use in your outputs. You can use multiple Audio selectors per input.
input_captionSelectors :: Lens' Input (Maybe (HashMap Text CaptionSelector)) Source #
Use captions selectors to specify the captions data from your input that you use in your outputs. You can use up to 20 captions selectors per input.
input_crop :: Lens' Input (Maybe Rectangle) Source #
Use Cropping selection (crop) to specify the video area that the service will include in the output video frame. If you specify a value here, it will override any value that you specify in the output setting Cropping selection (crop).
input_deblockFilter :: Lens' Input (Maybe InputDeblockFilter) Source #
Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manually controllable for MPEG2 and uncompressed video inputs.
input_decryptionSettings :: Lens' Input (Maybe InputDecryptionSettings) Source #
Settings for decrypting any input files that you encrypt before you upload them to Amazon S3. MediaConvert can decrypt files only when you use AWS Key Management Service (KMS) to encrypt the data key that you use to encrypt your content.
input_denoiseFilter :: Lens' Input (Maybe InputDenoiseFilter) Source #
Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs.
input_dolbyVisionMetadataXml :: Lens' Input (Maybe Text) Source #
Use this setting only when your video source has Dolby Vision studio mastering metadata that is carried in a separate XML file. Specify the Amazon S3 location for the metadata XML file. MediaConvert uses this file to provide global and frame-level metadata for Dolby Vision preprocessing. When you specify a file here and your input also has interleaved global and frame level metadata, MediaConvert ignores the interleaved metadata and uses only the the metadata from this external XML file. Note that your IAM service role must grant MediaConvert read permissions to this file. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/iam-role.html.
input_fileInput :: Lens' Input (Maybe Text) Source #
Specify the source file for your transcoding job. You can use multiple inputs in a single job. The service concatenates these inputs, in the order that you specify them in the job, to create the outputs. If your input format is IMF, specify your input by providing the path to your CPL. For example, "s3://bucket/vf/cpl.xml". If the CPL is in an incomplete IMP, make sure to use *Supplemental IMPs* (SupplementalImps) to specify any supplemental IMPs that contain assets referenced by the CPL.
input_filterEnable :: Lens' Input (Maybe InputFilterEnable) Source #
Specify how the transcoding service applies the denoise and deblock filters. You must also enable the filters separately, with Denoise (InputDenoiseFilter) and Deblock (InputDeblockFilter). * Auto - The transcoding service determines whether to apply filtering, depending on input type and quality. * Disable - The input is not filtered. This is true even if you use the API to enable them in (InputDeblockFilter) and (InputDeblockFilter). * Force - The input is filtered regardless of input type.
input_filterStrength :: Lens' Input (Maybe Int) Source #
Use Filter strength (FilterStrength) to adjust the magnitude the input filter settings (Deblock and Denoise). The range is -5 to 5. Default is 0.
input_imageInserter :: Lens' Input (Maybe ImageInserter) Source #
Enable the image inserter feature to include a graphic overlay on your video. Enable or disable this feature for each input individually. This setting is disabled by default.
input_inputClippings :: Lens' Input (Maybe [InputClipping]) Source #
(InputClippings) contains sets of start and end times that together specify a portion of the input to be used in the outputs. If you provide only a start time, the clip will be the entire input from that point to the end. If you provide only an end time, it will be the entire input up to that point. When you specify more than one input clip, the transcoding service creates the job outputs by stringing the clips together in the order you specify them.
input_inputScanType :: Lens' Input (Maybe InputScanType) Source #
When you have a progressive segmented frame (PsF) input, use this setting to flag the input as PsF. MediaConvert doesn't automatically detect PsF. Therefore, flagging your input as PsF results in better preservation of video quality when you do deinterlacing and frame rate conversion. If you don't specify, the default value is Auto (AUTO). Auto is the correct setting for all inputs that are not PsF. Don't set this value to PsF when your input is interlaced. Doing so creates horizontal interlacing artifacts.
input_position :: Lens' Input (Maybe Rectangle) Source #
Use Selection placement (position) to define the video area in your output frame. The area outside of the rectangle that you specify here is black. If you specify a value here, it will override any value that you specify in the output setting Selection placement (position). If you specify a value here, this will override any AFD values in your input, even if you set Respond to AFD (RespondToAfd) to Respond (RESPOND). If you specify a value here, this will ignore anything that you specify for the setting Scaling Behavior (scalingBehavior).
input_programNumber :: Lens' Input (Maybe Natural) Source #
Use Program (programNumber) to select a specific program from within a multi-program transport stream. Note that Quad 4K is not currently supported. Default is the first program within the transport stream. If the program you specify doesn't exist, the transcoding service will use this default.
input_psiControl :: Lens' Input (Maybe InputPsiControl) Source #
Set PSI control (InputPsiControl) for transport stream inputs to specify which data the demux process to scans. * Ignore PSI - Scan all PIDs for audio and video. * Use PSI - Scan only PSI data.
input_supplementalImps :: Lens' Input (Maybe [Text]) Source #
Provide a list of any necessary supplemental IMPs. You need supplemental IMPs if the CPL that you're using for your input is in an incomplete IMP. Specify either the supplemental IMP directories with a trailing slash or the ASSETMAP.xml files. For example ["s3://bucket/ov/", "s3://bucket/vf2/ASSETMAP.xml"]. You don't need to specify the IMP that contains your input CPL, because the service automatically detects it.
input_timecodeSource :: Lens' Input (Maybe InputTimecodeSource) Source #
Use this Timecode source setting, located under the input settings (InputTimecodeSource), to specify how the service counts input video frames. This input frame count affects only the behavior of features that apply to a single input at a time, such as input clipping and synchronizing some captions formats. Choose Embedded (EMBEDDED) to use the timecodes in your input video. Choose Start at zero (ZEROBASED) to start the first frame at zero. Choose Specified start (SPECIFIEDSTART) to start the first frame at the timecode that you specify in the setting Start timecode (timecodeStart). If you don't specify a value for Timecode source, the service will use Embedded by default. For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode.
input_timecodeStart :: Lens' Input (Maybe Text) Source #
Specify the timecode that you want the service to use for this input's initial frame. To use this setting, you must set the Timecode source setting, located under the input settings (InputTimecodeSource), to Specified start (SPECIFIEDSTART). For more information about timecodes, see https://docs.aws.amazon.com/console/mediaconvert/timecode.
input_videoGenerator :: Lens' Input (Maybe InputVideoGenerator) Source #
When you include Video generator, MediaConvert creates a video input with black frames. Use this setting if you do not have a video input or if you want to add black video frames before, or after, other inputs. You can specify Video generator, or you can specify an Input file, but you cannot specify both. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/video-generator.html
input_videoSelector :: Lens' Input (Maybe VideoSelector) Source #
Input video selectors contain the video settings for the input. Each of your inputs can have up to one video selector.