software.amazon.awssdk.services.mediaconvert.model

Interface JobSettings.Builder

All Superinterfaces:

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

Enclosing class:

JobSettings

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

Method Summary

Modifier and Type	Method and Description
JobSettings.Builder	adAvailOffset(Integer adAvailOffset) When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.
JobSettings.Builder	availBlanking(AvailBlanking availBlanking) Settings for ad avail blanking.
default JobSettings.Builder	availBlanking(Consumer<AvailBlanking.Builder> availBlanking) Settings for ad avail blanking.
default JobSettings.Builder	esam(Consumer<EsamSettings.Builder> esam) Settings for Event Signaling And Messaging (ESAM).
JobSettings.Builder	esam(EsamSettings esam) Settings for Event Signaling And Messaging (ESAM).
JobSettings.Builder	inputs(Collection<Input> inputs) Use Inputs (inputs) to define source file used in the transcode job.
JobSettings.Builder	inputs(Consumer<Input.Builder>... inputs) Use Inputs (inputs) to define source file used in the transcode job.
JobSettings.Builder	inputs(Input... inputs) Use Inputs (inputs) to define source file used in the transcode job.
default JobSettings.Builder	kantarWatermark(Consumer<KantarWatermarkSettings.Builder> kantarWatermark) Use these settings only when you use Kantar watermarking.
JobSettings.Builder	kantarWatermark(KantarWatermarkSettings kantarWatermark) Use these settings only when you use Kantar watermarking.
default JobSettings.Builder	motionImageInserter(Consumer<MotionImageInserter.Builder> motionImageInserter) Overlay motion graphics on top of your video.
JobSettings.Builder	motionImageInserter(MotionImageInserter motionImageInserter) Overlay motion graphics on top of your video.
default JobSettings.Builder	nielsenConfiguration(Consumer<NielsenConfiguration.Builder> nielsenConfiguration) Settings for your Nielsen configuration.
JobSettings.Builder	nielsenConfiguration(NielsenConfiguration nielsenConfiguration) Settings for your Nielsen configuration.
default JobSettings.Builder	nielsenNonLinearWatermark(Consumer<NielsenNonLinearWatermarkSettings.Builder> nielsenNonLinearWatermark) Ignore these settings unless you are using Nielsen non-linear watermarking.
JobSettings.Builder	nielsenNonLinearWatermark(NielsenNonLinearWatermarkSettings nielsenNonLinearWatermark) Ignore these settings unless you are using Nielsen non-linear watermarking.
JobSettings.Builder	outputGroups(Collection<OutputGroup> outputGroups) (OutputGroups) contains one group of settings for each set of outputs that share a common package type.
JobSettings.Builder	outputGroups(Consumer<OutputGroup.Builder>... outputGroups) (OutputGroups) contains one group of settings for each set of outputs that share a common package type.
JobSettings.Builder	outputGroups(OutputGroup... outputGroups) (OutputGroups) contains one group of settings for each set of outputs that share a common package type.
default JobSettings.Builder	timecodeConfig(Consumer<TimecodeConfig.Builder> timecodeConfig) These settings control how the service handles timecodes throughout the job.
JobSettings.Builder	timecodeConfig(TimecodeConfig timecodeConfig) These settings control how the service handles timecodes throughout the job.
default JobSettings.Builder	timedMetadataInsertion(Consumer<TimedMetadataInsertion.Builder> timedMetadataInsertion) Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in any HLS outputs.
JobSettings.Builder	timedMetadataInsertion(TimedMetadataInsertion timedMetadataInsertion) Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in any HLS outputs.

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

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

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

JobSettings.Builder esam(EsamSettings esam)

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

Parameters:

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

Returns:

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

esam

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

Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these settings. 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

JobSettings.Builder inputs(Collection<Input> 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.

Parameters:

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.

Returns:

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

inputs

JobSettings.Builder inputs(Input... 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.

Parameters:

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.

Returns:

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

inputs

JobSettings.Builder inputs(Consumer<Input.Builder>... 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. This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via #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)

kantarWatermark

JobSettings.Builder kantarWatermark(KantarWatermarkSettings 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.

Parameters:

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.

Returns:

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

kantarWatermark

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

Parameters:

kantarWatermark - a consumer that will call methods on KantarWatermarkSettings.Builder

Returns:

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

See Also:

kantarWatermark(KantarWatermarkSettings)

motionImageInserter

JobSettings.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. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/motion-graphic-overlay.html.

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. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/motion-graphic-overlay.html.

Returns:

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

motionImageInserter

default JobSettings.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. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/motion-graphic-overlay.html. 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

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

nielsenNonLinearWatermark

JobSettings.Builder nielsenNonLinearWatermark(NielsenNonLinearWatermarkSettings 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]

Parameters:

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]

Returns:

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

nielsenNonLinearWatermark

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

Parameters:

nielsenNonLinearWatermark - a consumer that will call methods on NielsenNonLinearWatermarkSettings.Builder

Returns:

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

See Also:

nielsenNonLinearWatermark(NielsenNonLinearWatermarkSettings)

outputGroups

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

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

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

JobSettings.Builder timecodeConfig(TimecodeConfig timecodeConfig)

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

Parameters:

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

Returns:

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

timecodeConfig

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

These settings control how the service handles timecodes throughout the job. These settings don't affect input clipping. 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

JobSettings.Builder timedMetadataInsertion(TimedMetadataInsertion timedMetadataInsertion)

Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in any HLS outputs. 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 any HLS outputs. 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 JobSettings.Builder timedMetadataInsertion(Consumer<TimedMetadataInsertion.Builder> timedMetadataInsertion)

Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in any HLS outputs. 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)