JobTemplateSettings (AWS Java SDK :: Services :: AWS Elemental MediaConvert 2.16.76 API)

java.lang.Object
- software.amazon.awssdk.services.mediaconvert.model.JobTemplateSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<JobTemplateSettings.Builder,JobTemplateSettings>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class JobTemplateSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<JobTemplateSettings.Builder,JobTemplateSettings>
```
JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface JobTemplateSettings.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`JobTemplateSettings.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Integer`	`adAvailOffset()` When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.
`AvailBlanking`	`availBlanking()` Settings for ad avail blanking.
`static JobTemplateSettings.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`EsamSettings`	`esam()` Settings for Event Signaling And Messaging (ESAM).
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasInputs()` Returns true if the Inputs property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasOutputGroups()` Returns true if the OutputGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<InputTemplate>`	`inputs()` Use Inputs (inputs) to define the source file used in the transcode job.
`KantarWatermarkSettings`	`kantarWatermark()` Use these settings only when you use Kantar watermarking.
`MotionImageInserter`	`motionImageInserter()` Overlay motion graphics on top of your video.
`NielsenConfiguration`	`nielsenConfiguration()` Settings for your Nielsen configuration.
`NielsenNonLinearWatermarkSettings`	`nielsenNonLinearWatermark()` Ignore these settings unless you are using Nielsen non-linear watermarking.
`List<OutputGroup>`	`outputGroups()` (OutputGroups) contains one group of settings for each set of outputs that share a common package type.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends JobTemplateSettings.Builder>`	`serializableBuilderClass()`
`TimecodeConfig`	`timecodeConfig()` These settings control how the service handles timecodes throughout the job.
`TimedMetadataInsertion`	`timedMetadataInsertion()` Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in any HLS outputs.
`JobTemplateSettings.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - adAvailOffset
```
public final Integer adAvailOffset()
```
    When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.
    
    Returns:
    
    When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.
  - availBlanking
```
public final 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.
    
    Returns:
    
    Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails.
  - esam
```
public final EsamSettings esam()
```
    Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these settings.
    
    Returns:
    
    Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these settings.
  - hasInputs
```
public final boolean hasInputs()
```
    Returns true if the Inputs property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - inputs
```
public final List<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.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasInputs() to see if a value was sent in this field.
    
    Returns:
    
    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.
  - kantarWatermark
```
public final 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.
    
    Returns:
    
    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
```
public final 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.
    
    Returns:
    
    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
```
public final 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.
    
    Returns:
    
    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
```
public final 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]
    
    Returns:
    
    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]
  - hasOutputGroups
```
public final boolean hasOutputGroups()
```
    Returns true if the OutputGroups property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - outputGroups
```
public final List<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
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasOutputGroups() to see if a value was sent in this field.
    
    Returns:
    
    (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
```
public final TimecodeConfig timecodeConfig()
```
    These settings control how the service handles timecodes throughout the job. These settings don't affect input clipping.
    
    Returns:
    
    These settings control how the service handles timecodes throughout the job. These settings don't affect input clipping.
  - timedMetadataInsertion
```
public final 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.
    
    Returns:
    
    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.
  - toBuilder
```
public JobTemplateSettings.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<JobTemplateSettings.Builder,JobTemplateSettings>
  - builder
```
public static JobTemplateSettings.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends JobTemplateSettings.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class JobTemplateSettings

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

adAvailOffset

availBlanking

esam

hasInputs

inputs

kantarWatermark

motionImageInserter

nielsenConfiguration

nielsenNonLinearWatermark

hasOutputGroups

outputGroups

timecodeConfig

timedMetadataInsertion

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields