Amazonka.MediaConvert.Types.JobSettings

Documentation

data JobSettings

JobSettings contains all the transcode settings for a job.

See: newJobSettings smart constructor.

Constructors

JobSettings'

Fields

• adAvailOffset :: Maybe Int

  When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.

• availBlanking :: Maybe AvailBlanking

  Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails.

• esam :: Maybe EsamSettings

  Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these settings.

• extendedDataServices :: Maybe ExtendedDataServices

  If your source content has EIA-608 Line 21 Data Services, enable this feature to specify what MediaConvert does with the Extended Data Services (XDS) packets. You can choose to pass through XDS packets, or remove them from the output. For more information about XDS, see EIA-608 Line Data Services, section 9.5.1.5 05h Content Advisory.

• inputs :: Maybe [Input]

  Use Inputs (inputs) to define source file used in the transcode job. There can be multiple inputs add in a job. These inputs will be concantenated together to create the output.

• kantarWatermark :: Maybe KantarWatermarkSettings

  Use these settings only when you use Kantar watermarking. Specify the values that MediaConvert uses to generate and place Kantar watermarks in your output audio. These settings apply to every output in your job. In addition to specifying these values, you also need to store your Kantar credentials in AWS Secrets Manager. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/kantar-watermarking.html.

• motionImageInserter :: Maybe MotionImageInserter

  Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in all output groups. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/motion-graphic-overlay.html.

• nielsenConfiguration :: Maybe NielsenConfiguration

  Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these settings. When you enable Nielsen configuration (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs in the job. To enable Nielsen configuration programmatically, include an instance of nielsenConfiguration in your JSON job specification. Even if you don't include any children of nielsenConfiguration, you still enable the setting.

• nielsenNonLinearWatermark :: Maybe NielsenNonLinearWatermarkSettings

  Ignore these settings unless you are using Nielsen non-linear watermarking. Specify the values that MediaConvert uses to generate and place Nielsen watermarks in your output audio. In addition to specifying these values, you also need to set up your cloud TIC server. These settings apply to every output in your job. The MediaConvert implementation is currently with the following Nielsen versions: Nielsen Watermark SDK Version 5.2.1 Nielsen NLM Watermark Engine Version 1.2.7 Nielsen Watermark Authenticator [SID_TIC] Version [5.0.0]

• outputGroups :: Maybe [OutputGroup]

  (OutputGroups) contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings

• timecodeConfig :: Maybe TimecodeConfig

  These settings control how the service handles timecodes throughout the job. These settings don't affect input clipping.

• timedMetadataInsertion :: Maybe TimedMetadataInsertion

  Insert user-defined custom ID3 metadata (id3) at timecodes (timecode) that you specify. In each output that you want to include this metadata, you must set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH).

Instances

FromJSON JobSettings

Defined in Amazonka.MediaConvert.Types.JobSettings

Methods

parseJSON :: Value -> Parser JobSettings

parseJSONList :: Value -> Parser [JobSettings]

ToJSON JobSettings

Defined in Amazonka.MediaConvert.Types.JobSettings

Methods

toJSON :: JobSettings -> Value

toEncoding :: JobSettings -> Encoding

toJSONList :: [JobSettings] -> Value

toEncodingList :: [JobSettings] -> Encoding

Generic JobSettings

Defined in Amazonka.MediaConvert.Types.JobSettings

Associated Types

type Rep JobSettings :: Type -> Type

Methods

from :: JobSettings -> Rep JobSettings x

to :: Rep JobSettings x -> JobSettings

Read JobSettings

Defined in Amazonka.MediaConvert.Types.JobSettings

Methods

readsPrec :: Int -> ReadS JobSettings

readList :: ReadS [JobSettings]

readPrec :: ReadPrec JobSettings

readListPrec :: ReadPrec [JobSettings]

Show JobSettings

Defined in Amazonka.MediaConvert.Types.JobSettings

Methods

showsPrec :: Int -> JobSettings -> ShowS

show :: JobSettings -> String

showList :: [JobSettings] -> ShowS

NFData JobSettings

Defined in Amazonka.MediaConvert.Types.JobSettings

Methods

rnf :: JobSettings -> ()

Eq JobSettings

Defined in Amazonka.MediaConvert.Types.JobSettings

Methods

(==) :: JobSettings -> JobSettings -> Bool

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

Hashable JobSettings

Defined in Amazonka.MediaConvert.Types.JobSettings

Methods

hashWithSalt :: Int -> JobSettings -> Int

hash :: JobSettings -> Int

type Rep JobSettings

Defined in Amazonka.MediaConvert.Types.JobSettings

type Rep JobSettings = D1 ('MetaData "JobSettings" "Amazonka.MediaConvert.Types.JobSettings" "amazonka-mediaconvert-2.0-ClG8xHhlx4y6bdaCrZchqH" 'False) (C1 ('MetaCons "JobSettings'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "adAvailOffset") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "availBlanking") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AvailBlanking)) :*: S1 ('MetaSel ('Just "esam") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EsamSettings)))) :*: (S1 ('MetaSel ('Just "extendedDataServices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ExtendedDataServices)) :*: (S1 ('MetaSel ('Just "inputs") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Input])) :*: S1 ('MetaSel ('Just "kantarWatermark") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe KantarWatermarkSettings))))) :*: ((S1 ('MetaSel ('Just "motionImageInserter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MotionImageInserter)) :*: (S1 ('MetaSel ('Just "nielsenConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NielsenConfiguration)) :*: S1 ('MetaSel ('Just "nielsenNonLinearWatermark") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NielsenNonLinearWatermarkSettings)))) :*: (S1 ('MetaSel ('Just "outputGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OutputGroup])) :*: (S1 ('MetaSel ('Just "timecodeConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimecodeConfig)) :*: S1 ('MetaSel ('Just "timedMetadataInsertion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TimedMetadataInsertion)))))))

newJobSettings :: JobSettings

Create a value of JobSettings 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:adAvailOffset:JobSettings', jobSettings_adAvailOffset - When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.

$sel:availBlanking:JobSettings', jobSettings_availBlanking - Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails.

$sel:esam:JobSettings', jobSettings_esam - Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these settings.

$sel:extendedDataServices:JobSettings', jobSettings_extendedDataServices - If your source content has EIA-608 Line 21 Data Services, enable this feature to specify what MediaConvert does with the Extended Data Services (XDS) packets. You can choose to pass through XDS packets, or remove them from the output. For more information about XDS, see EIA-608 Line Data Services, section 9.5.1.5 05h Content Advisory.

$sel:inputs:JobSettings', jobSettings_inputs - Use Inputs (inputs) to define source file used in the transcode job. There can be multiple inputs add in a job. These inputs will be concantenated together to create the output.

$sel:kantarWatermark:JobSettings', jobSettings_kantarWatermark - Use these settings only when you use Kantar watermarking. Specify the values that MediaConvert uses to generate and place Kantar watermarks in your output audio. These settings apply to every output in your job. In addition to specifying these values, you also need to store your Kantar credentials in AWS Secrets Manager. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/kantar-watermarking.html.

$sel:motionImageInserter:JobSettings', jobSettings_motionImageInserter - Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in all output groups. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/motion-graphic-overlay.html.

$sel:nielsenConfiguration:JobSettings', jobSettings_nielsenConfiguration - Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these settings. When you enable Nielsen configuration (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs in the job. To enable Nielsen configuration programmatically, include an instance of nielsenConfiguration in your JSON job specification. Even if you don't include any children of nielsenConfiguration, you still enable the setting.

$sel:nielsenNonLinearWatermark:JobSettings', jobSettings_nielsenNonLinearWatermark - Ignore these settings unless you are using Nielsen non-linear watermarking. Specify the values that MediaConvert uses to generate and place Nielsen watermarks in your output audio. In addition to specifying these values, you also need to set up your cloud TIC server. These settings apply to every output in your job. The MediaConvert implementation is currently with the following Nielsen versions: Nielsen Watermark SDK Version 5.2.1 Nielsen NLM Watermark Engine Version 1.2.7 Nielsen Watermark Authenticator [SID_TIC] Version [5.0.0]

$sel:outputGroups:JobSettings', jobSettings_outputGroups - (OutputGroups) contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings

$sel:timecodeConfig:JobSettings', jobSettings_timecodeConfig - These settings control how the service handles timecodes throughout the job. These settings don't affect input clipping.

$sel:timedMetadataInsertion:JobSettings', jobSettings_timedMetadataInsertion - Insert user-defined custom ID3 metadata (id3) at timecodes (timecode) that you specify. In each output that you want to include this metadata, you must set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH).

jobSettings_adAvailOffset :: Lens' JobSettings (Maybe Int)

When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.

jobSettings_availBlanking :: Lens' JobSettings (Maybe AvailBlanking)

Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails.

jobSettings_esam :: Lens' JobSettings (Maybe EsamSettings)

Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these settings.

jobSettings_extendedDataServices :: Lens' JobSettings (Maybe ExtendedDataServices)

If your source content has EIA-608 Line 21 Data Services, enable this feature to specify what MediaConvert does with the Extended Data Services (XDS) packets. You can choose to pass through XDS packets, or remove them from the output. For more information about XDS, see EIA-608 Line Data Services, section 9.5.1.5 05h Content Advisory.

jobSettings_inputs :: Lens' JobSettings (Maybe [Input])

Use Inputs (inputs) to define source file used in the transcode job. There can be multiple inputs add in a job. These inputs will be concantenated together to create the output.

jobSettings_kantarWatermark :: Lens' JobSettings (Maybe KantarWatermarkSettings)

Use these settings only when you use Kantar watermarking. Specify the values that MediaConvert uses to generate and place Kantar watermarks in your output audio. These settings apply to every output in your job. In addition to specifying these values, you also need to store your Kantar credentials in AWS Secrets Manager. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/kantar-watermarking.html.

jobSettings_motionImageInserter :: Lens' JobSettings (Maybe MotionImageInserter)

Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in all output groups. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/motion-graphic-overlay.html.

jobSettings_nielsenConfiguration :: Lens' JobSettings (Maybe NielsenConfiguration)

Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these settings. When you enable Nielsen configuration (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs in the job. To enable Nielsen configuration programmatically, include an instance of nielsenConfiguration in your JSON job specification. Even if you don't include any children of nielsenConfiguration, you still enable the setting.

jobSettings_nielsenNonLinearWatermark :: Lens' JobSettings (Maybe NielsenNonLinearWatermarkSettings)

Ignore these settings unless you are using Nielsen non-linear watermarking. Specify the values that MediaConvert uses to generate and place Nielsen watermarks in your output audio. In addition to specifying these values, you also need to set up your cloud TIC server. These settings apply to every output in your job. The MediaConvert implementation is currently with the following Nielsen versions: Nielsen Watermark SDK Version 5.2.1 Nielsen NLM Watermark Engine Version 1.2.7 Nielsen Watermark Authenticator [SID_TIC] Version [5.0.0]

jobSettings_outputGroups :: Lens' JobSettings (Maybe [OutputGroup])

(OutputGroups) contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings

jobSettings_timecodeConfig :: Lens' JobSettings (Maybe TimecodeConfig)

These settings control how the service handles timecodes throughout the job. These settings don't affect input clipping.

jobSettings_timedMetadataInsertion :: Lens' JobSettings (Maybe TimedMetadataInsertion)

Insert user-defined custom ID3 metadata (id3) at timecodes (timecode) that you specify. In each output that you want to include this metadata, you must set ID3 metadata (timedMetadata) to Passthrough (PASSTHROUGH).