Amazonka.MediaConvert.Types.InputTemplate

Documentation

data InputTemplate

Specified video input in a template.

See: newInputTemplate smart constructor.

Constructors

InputTemplate'

Fields

• audioSelectorGroups :: Maybe (HashMap Text AudioSelectorGroup)

  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.

• audioSelectors :: Maybe (HashMap Text AudioSelector)

  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.

• captionSelectors :: Maybe (HashMap Text CaptionSelector)

  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.

• crop :: Maybe Rectangle

  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).

• deblockFilter :: Maybe InputDeblockFilter

  Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manually controllable for MPEG2 and uncompressed video inputs.

• denoiseFilter :: Maybe InputDenoiseFilter

  Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs.

• dolbyVisionMetadataXml :: Maybe Text

  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.

• filterEnable :: Maybe InputFilterEnable

  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.

• filterStrength :: Maybe Int

  Use Filter strength (FilterStrength) to adjust the magnitude the input filter settings (Deblock and Denoise). The range is -5 to 5. Default is 0.

• imageInserter :: Maybe 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.

• inputClippings :: Maybe [InputClipping]

  (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.

• inputScanType :: Maybe 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.

• position :: Maybe Rectangle

  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).

• programNumber :: Maybe Natural

  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.

• psiControl :: Maybe InputPsiControl

  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.

• timecodeSource :: Maybe InputTimecodeSource

  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.

• timecodeStart :: Maybe Text

  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.

• videoSelector :: Maybe VideoSelector

  Input video selectors contain the video settings for the input. Each of your inputs can have up to one video selector.

Instances

FromJSON InputTemplate

Defined in Amazonka.MediaConvert.Types.InputTemplate

Methods

parseJSON :: Value -> Parser InputTemplate

parseJSONList :: Value -> Parser [InputTemplate]

ToJSON InputTemplate

Defined in Amazonka.MediaConvert.Types.InputTemplate

Methods

toJSON :: InputTemplate -> Value

toEncoding :: InputTemplate -> Encoding

toJSONList :: [InputTemplate] -> Value

toEncodingList :: [InputTemplate] -> Encoding

Generic InputTemplate

Defined in Amazonka.MediaConvert.Types.InputTemplate

Associated Types

type Rep InputTemplate :: Type -> Type

Methods

from :: InputTemplate -> Rep InputTemplate x

to :: Rep InputTemplate x -> InputTemplate

Read InputTemplate

Defined in Amazonka.MediaConvert.Types.InputTemplate

Methods

readsPrec :: Int -> ReadS InputTemplate

readList :: ReadS [InputTemplate]

readPrec :: ReadPrec InputTemplate

readListPrec :: ReadPrec [InputTemplate]

Show InputTemplate

Defined in Amazonka.MediaConvert.Types.InputTemplate

Methods

showsPrec :: Int -> InputTemplate -> ShowS

show :: InputTemplate -> String

showList :: [InputTemplate] -> ShowS

NFData InputTemplate

Defined in Amazonka.MediaConvert.Types.InputTemplate

Methods

rnf :: InputTemplate -> ()

Eq InputTemplate

Defined in Amazonka.MediaConvert.Types.InputTemplate

Methods

(==) :: InputTemplate -> InputTemplate -> Bool

(/=) :: InputTemplate -> InputTemplate -> Bool

Hashable InputTemplate

Defined in Amazonka.MediaConvert.Types.InputTemplate

Methods

hashWithSalt :: Int -> InputTemplate -> Int

hash :: InputTemplate -> Int

type Rep InputTemplate

Defined in Amazonka.MediaConvert.Types.InputTemplate

type Rep InputTemplate = D1 ('MetaData "InputTemplate" "Amazonka.MediaConvert.Types.InputTemplate" "amazonka-mediaconvert-2.0-ClG8xHhlx4y6bdaCrZchqH" 'False) (C1 ('MetaCons "InputTemplate'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "audioSelectorGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text AudioSelectorGroup))) :*: S1 ('MetaSel ('Just "audioSelectors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text AudioSelector)))) :*: (S1 ('MetaSel ('Just "captionSelectors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text CaptionSelector))) :*: S1 ('MetaSel ('Just "crop") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Rectangle)))) :*: ((S1 ('MetaSel ('Just "deblockFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputDeblockFilter)) :*: S1 ('MetaSel ('Just "denoiseFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputDenoiseFilter))) :*: (S1 ('MetaSel ('Just "dolbyVisionMetadataXml") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "filterEnable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputFilterEnable)) :*: S1 ('MetaSel ('Just "filterStrength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))) :*: (((S1 ('MetaSel ('Just "imageInserter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ImageInserter)) :*: S1 ('MetaSel ('Just "inputClippings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InputClipping]))) :*: (S1 ('MetaSel ('Just "inputScanType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputScanType)) :*: S1 ('MetaSel ('Just "position") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Rectangle)))) :*: ((S1 ('MetaSel ('Just "programNumber") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: S1 ('MetaSel ('Just "psiControl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputPsiControl))) :*: (S1 ('MetaSel ('Just "timecodeSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe InputTimecodeSource)) :*: (S1 ('MetaSel ('Just "timecodeStart") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "videoSelector") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VideoSelector))))))))

newInputTemplate :: InputTemplate

Create a value of InputTemplate 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:InputTemplate', inputTemplate_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:InputTemplate', inputTemplate_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:InputTemplate', inputTemplate_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:InputTemplate', inputTemplate_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:InputTemplate', inputTemplate_deblockFilter - Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manually controllable for MPEG2 and uncompressed video inputs.

$sel:denoiseFilter:InputTemplate', inputTemplate_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:InputTemplate', inputTemplate_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:filterEnable:InputTemplate', inputTemplate_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:InputTemplate', inputTemplate_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:InputTemplate', inputTemplate_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:InputTemplate', inputTemplate_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:InputTemplate', inputTemplate_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:InputTemplate', inputTemplate_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).

InputTemplate, inputTemplate_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:InputTemplate', inputTemplate_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:timecodeSource:InputTemplate', inputTemplate_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:InputTemplate', inputTemplate_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:videoSelector:InputTemplate', inputTemplate_videoSelector - Input video selectors contain the video settings for the input. Each of your inputs can have up to one video selector.

inputTemplate_audioSelectorGroups :: Lens' InputTemplate (Maybe (HashMap Text AudioSelectorGroup))

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.

inputTemplate_audioSelectors :: Lens' InputTemplate (Maybe (HashMap Text AudioSelector))

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.

inputTemplate_captionSelectors :: Lens' InputTemplate (Maybe (HashMap Text CaptionSelector))

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.

inputTemplate_crop :: Lens' InputTemplate (Maybe Rectangle)

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).

inputTemplate_deblockFilter :: Lens' InputTemplate (Maybe InputDeblockFilter)

Enable Deblock (InputDeblockFilter) to produce smoother motion in the output. Default is disabled. Only manually controllable for MPEG2 and uncompressed video inputs.

inputTemplate_denoiseFilter :: Lens' InputTemplate (Maybe InputDenoiseFilter)

Enable Denoise (InputDenoiseFilter) to filter noise from the input. Default is disabled. Only applicable to MPEG2, H.264, H.265, and uncompressed video inputs.

inputTemplate_dolbyVisionMetadataXml :: Lens' InputTemplate (Maybe Text)

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.

inputTemplate_filterEnable :: Lens' InputTemplate (Maybe InputFilterEnable)

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.

inputTemplate_filterStrength :: Lens' InputTemplate (Maybe Int)

Use Filter strength (FilterStrength) to adjust the magnitude the input filter settings (Deblock and Denoise). The range is -5 to 5. Default is 0.

inputTemplate_imageInserter :: Lens' InputTemplate (Maybe 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.

inputTemplate_inputClippings :: Lens' InputTemplate (Maybe [InputClipping])

(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.

inputTemplate_inputScanType :: Lens' InputTemplate (Maybe 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.

inputTemplate_position :: Lens' InputTemplate (Maybe Rectangle)

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).

inputTemplate_programNumber :: Lens' InputTemplate (Maybe Natural)

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.

inputTemplate_psiControl :: Lens' InputTemplate (Maybe InputPsiControl)

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.

inputTemplate_timecodeSource :: Lens' InputTemplate (Maybe InputTimecodeSource)

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.

inputTemplate_timecodeStart :: Lens' InputTemplate (Maybe Text)

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.

inputTemplate_videoSelector :: Lens' InputTemplate (Maybe VideoSelector)

Input video selectors contain the video settings for the input. Each of your inputs can have up to one video selector.