software.amazon.awssdk.services.mediaconvert.model

Interface JobTemplateSettings.Builder

All Superinterfaces:

Buildable, CopyableBuilder<JobTemplateSettings.Builder,JobTemplateSettings>, SdkBuilder<JobTemplateSettings.Builder,JobTemplateSettings>, SdkPojo

Enclosing class:

JobTemplateSettings

public static interface JobTemplateSettings.Builder
extends SdkPojo, CopyableBuilder<JobTemplateSettings.Builder,JobTemplateSettings>

Method Summary

Modifier and Type	Method and Description
JobTemplateSettings.Builder	adAvailOffset(Integer adAvailOffset) When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.
JobTemplateSettings.Builder	availBlanking(AvailBlanking availBlanking) Settings for ad avail blanking.
default JobTemplateSettings.Builder	availBlanking(Consumer<AvailBlanking.Builder> availBlanking) Settings for ad avail blanking.
default JobTemplateSettings.Builder	esam(Consumer<EsamSettings.Builder> esam) Settings for Event Signaling And Messaging (ESAM).
JobTemplateSettings.Builder	esam(EsamSettings esam) Settings for Event Signaling And Messaging (ESAM).
JobTemplateSettings.Builder	inputs(Collection<InputTemplate> inputs) Use Inputs (inputs) to define the source file used in the transcode job.
JobTemplateSettings.Builder	inputs(Consumer<InputTemplate.Builder>... inputs) Use Inputs (inputs) to define the source file used in the transcode job.
JobTemplateSettings.Builder	inputs(InputTemplate... inputs) Use Inputs (inputs) to define the source file used in the transcode job.
default JobTemplateSettings.Builder	motionImageInserter(Consumer<MotionImageInserter.Builder> motionImageInserter) Overlay motion graphics on top of your video.
JobTemplateSettings.Builder	motionImageInserter(MotionImageInserter motionImageInserter) Overlay motion graphics on top of your video.
default JobTemplateSettings.Builder	nielsenConfiguration(Consumer<NielsenConfiguration.Builder> nielsenConfiguration) Settings for your Nielsen configuration.
JobTemplateSettings.Builder	nielsenConfiguration(NielsenConfiguration nielsenConfiguration) Settings for your Nielsen configuration.
JobTemplateSettings.Builder	outputGroups(Collection<OutputGroup> outputGroups) (OutputGroups) contains one group of settings for each set of outputs that share a common package type.
JobTemplateSettings.Builder	outputGroups(Consumer<OutputGroup.Builder>... outputGroups) (OutputGroups) contains one group of settings for each set of outputs that share a common package type.
JobTemplateSettings.Builder	outputGroups(OutputGroup... outputGroups) (OutputGroups) contains one group of settings for each set of outputs that share a common package type.
default JobTemplateSettings.Builder	timecodeConfig(Consumer<TimecodeConfig.Builder> timecodeConfig) Contains settings used to acquire and adjust timecode information from inputs.
JobTemplateSettings.Builder	timecodeConfig(TimecodeConfig timecodeConfig) Contains settings used to acquire and adjust timecode information from inputs.
default JobTemplateSettings.Builder	timedMetadataInsertion(Consumer<TimedMetadataInsertion.Builder> timedMetadataInsertion) Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in your job.
JobTemplateSettings.Builder	timedMetadataInsertion(TimedMetadataInsertion timedMetadataInsertion) Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in your job.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

adAvailOffset

JobTemplateSettings.Builder adAvailOffset(Integer adAvailOffset)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

availBlanking

JobTemplateSettings.Builder availBlanking(AvailBlanking availBlanking)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

availBlanking

default JobTemplateSettings.Builder availBlanking(Consumer<AvailBlanking.Builder> availBlanking)

Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails. This is a convenience that creates an instance of the AvailBlanking.Builder avoiding the need to create one manually via AvailBlanking.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to availBlanking(AvailBlanking).

Parameters:

availBlanking - a consumer that will call methods on AvailBlanking.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

availBlanking(AvailBlanking)

esam

JobTemplateSettings.Builder esam(EsamSettings esam)

Settings for Event Signaling And Messaging (ESAM).

Parameters:

esam - Settings for Event Signaling And Messaging (ESAM).

Returns:

Returns a reference to this object so that method calls can be chained together.

esam

default JobTemplateSettings.Builder esam(Consumer<EsamSettings.Builder> esam)

Settings for Event Signaling And Messaging (ESAM). This is a convenience that creates an instance of the EsamSettings.Builder avoiding the need to create one manually via EsamSettings.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to esam(EsamSettings).

Parameters:

esam - a consumer that will call methods on EsamSettings.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

esam(EsamSettings)

inputs

JobTemplateSettings.Builder inputs(Collection<InputTemplate> inputs)

Use Inputs (inputs) to define the source file used in the transcode job. There can only be one input in a job template. Using the API, you can include multiple inputs when referencing a job template.

Parameters:

inputs - Use Inputs (inputs) to define the source file used in the transcode job. There can only be one input in a job template. Using the API, you can include multiple inputs when referencing a job template.

Returns:

Returns a reference to this object so that method calls can be chained together.

inputs

JobTemplateSettings.Builder inputs(InputTemplate... inputs)

Use Inputs (inputs) to define the source file used in the transcode job. There can only be one input in a job template. Using the API, you can include multiple inputs when referencing a job template.

Parameters:

inputs - Use Inputs (inputs) to define the source file used in the transcode job. There can only be one input in a job template. Using the API, you can include multiple inputs when referencing a job template.

Returns:

Returns a reference to this object so that method calls can be chained together.

inputs

JobTemplateSettings.Builder inputs(Consumer<InputTemplate.Builder>... inputs)

Use Inputs (inputs) to define the source file used in the transcode job. There can only be one input in a job template. Using the API, you can include multiple inputs when referencing a job template. This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #inputs(List).

Parameters:

inputs - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#inputs(List)

motionImageInserter

JobTemplateSettings.Builder motionImageInserter(MotionImageInserter motionImageInserter)

Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in all output groups.

Parameters:

motionImageInserter - Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in all output groups.

Returns:

Returns a reference to this object so that method calls can be chained together.

motionImageInserter

default JobTemplateSettings.Builder motionImageInserter(Consumer<MotionImageInserter.Builder> motionImageInserter)

Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in all output groups. This is a convenience that creates an instance of the MotionImageInserter.Builder avoiding the need to create one manually via MotionImageInserter.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to motionImageInserter(MotionImageInserter).

Parameters:

motionImageInserter - a consumer that will call methods on MotionImageInserter.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

motionImageInserter(MotionImageInserter)

nielsenConfiguration

JobTemplateSettings.Builder nielsenConfiguration(NielsenConfiguration 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

nielsenConfiguration

default JobTemplateSettings.Builder nielsenConfiguration(Consumer<NielsenConfiguration.Builder> 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. This is a convenience that creates an instance of the NielsenConfiguration.Builder avoiding the need to create one manually via NielsenConfiguration.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to nielsenConfiguration(NielsenConfiguration).

Parameters:

nielsenConfiguration - a consumer that will call methods on NielsenConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

nielsenConfiguration(NielsenConfiguration)

outputGroups

JobTemplateSettings.Builder outputGroups(Collection<OutputGroup> 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

outputGroups

JobTemplateSettings.Builder outputGroups(OutputGroup... 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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

outputGroups

JobTemplateSettings.Builder outputGroups(Consumer<OutputGroup.Builder>... 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 This is a convenience that creates an instance of the .Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #outputGroups(List).

Parameters:

outputGroups - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#outputGroups(List)

timecodeConfig

JobTemplateSettings.Builder timecodeConfig(TimecodeConfig timecodeConfig)

Contains settings used to acquire and adjust timecode information from inputs.

Parameters:

timecodeConfig - Contains settings used to acquire and adjust timecode information from inputs.

Returns:

Returns a reference to this object so that method calls can be chained together.

timecodeConfig

default JobTemplateSettings.Builder timecodeConfig(Consumer<TimecodeConfig.Builder> timecodeConfig)

Contains settings used to acquire and adjust timecode information from inputs. This is a convenience that creates an instance of the TimecodeConfig.Builder avoiding the need to create one manually via TimecodeConfig.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timecodeConfig(TimecodeConfig).

Parameters:

timecodeConfig - a consumer that will call methods on TimecodeConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

timecodeConfig(TimecodeConfig)

timedMetadataInsertion

JobTemplateSettings.Builder timedMetadataInsertion(TimedMetadataInsertion timedMetadataInsertion)

Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in your job. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects.

Parameters:

timedMetadataInsertion - Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in your job. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects.

Returns:

Returns a reference to this object so that method calls can be chained together.

timedMetadataInsertion

default JobTemplateSettings.Builder timedMetadataInsertion(Consumer<TimedMetadataInsertion.Builder> timedMetadataInsertion)

Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in your job. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects. This is a convenience that creates an instance of the TimedMetadataInsertion.Builder avoiding the need to create one manually via TimedMetadataInsertion.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timedMetadataInsertion(TimedMetadataInsertion).

Parameters:

timedMetadataInsertion - a consumer that will call methods on TimedMetadataInsertion.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

timedMetadataInsertion(TimedMetadataInsertion)