com.amazonaws.services.mediaconvert.model

Class JobTemplateSettings

java.lang.Object

com.amazonaws.services.mediaconvert.model.JobTemplateSettings

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class JobTemplateSettings
extends Object
implements Serializable, Cloneable, StructuredPojo

JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
JobTemplateSettings()

Method Summary

Modifier and Type	Method and Description
JobTemplateSettings	clone()
boolean	equals(Object obj)
Integer	getAdAvailOffset() When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.
AvailBlanking	getAvailBlanking() Settings for ad avail blanking.
EsamSettings	getEsam() Settings for Event Signaling And Messaging (ESAM).
List<InputTemplate>	getInputs() Use Inputs (inputs) to define the source file used in the transcode job.
MotionImageInserter	getMotionImageInserter() Overlay motion graphics on top of your video.
NielsenConfiguration	getNielsenConfiguration() Settings for your Nielsen configuration.
List<OutputGroup>	getOutputGroups() (OutputGroups) contains one group of settings for each set of outputs that share a common package type.
TimecodeConfig	getTimecodeConfig() Contains settings used to acquire and adjust timecode information from inputs.
TimedMetadataInsertion	getTimedMetadataInsertion() Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in your job.
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
void	setAdAvailOffset(Integer adAvailOffset) When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.
void	setAvailBlanking(AvailBlanking availBlanking) Settings for ad avail blanking.
void	setEsam(EsamSettings esam) Settings for Event Signaling And Messaging (ESAM).
void	setInputs(Collection<InputTemplate> inputs) Use Inputs (inputs) to define the source file used in the transcode job.
void	setMotionImageInserter(MotionImageInserter motionImageInserter) Overlay motion graphics on top of your video.
void	setNielsenConfiguration(NielsenConfiguration nielsenConfiguration) Settings for your Nielsen configuration.
void	setOutputGroups(Collection<OutputGroup> outputGroups) (OutputGroups) contains one group of settings for each set of outputs that share a common package type.
void	setTimecodeConfig(TimecodeConfig timecodeConfig) Contains settings used to acquire and adjust timecode information from inputs.
void	setTimedMetadataInsertion(TimedMetadataInsertion timedMetadataInsertion) Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in your job.
String	toString() Returns a string representation of this object.
JobTemplateSettings	withAdAvailOffset(Integer adAvailOffset) When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.
JobTemplateSettings	withAvailBlanking(AvailBlanking availBlanking) Settings for ad avail blanking.
JobTemplateSettings	withEsam(EsamSettings esam) Settings for Event Signaling And Messaging (ESAM).
JobTemplateSettings	withInputs(Collection<InputTemplate> inputs) Use Inputs (inputs) to define the source file used in the transcode job.
JobTemplateSettings	withInputs(InputTemplate... inputs) Use Inputs (inputs) to define the source file used in the transcode job.
JobTemplateSettings	withMotionImageInserter(MotionImageInserter motionImageInserter) Overlay motion graphics on top of your video.
JobTemplateSettings	withNielsenConfiguration(NielsenConfiguration nielsenConfiguration) Settings for your Nielsen configuration.
JobTemplateSettings	withOutputGroups(Collection<OutputGroup> outputGroups) (OutputGroups) contains one group of settings for each set of outputs that share a common package type.
JobTemplateSettings	withOutputGroups(OutputGroup... outputGroups) (OutputGroups) contains one group of settings for each set of outputs that share a common package type.
JobTemplateSettings	withTimecodeConfig(TimecodeConfig timecodeConfig) Contains settings used to acquire and adjust timecode information from inputs.
JobTemplateSettings	withTimedMetadataInsertion(TimedMetadataInsertion timedMetadataInsertion) Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in your job.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JobTemplateSettings

public JobTemplateSettings()

Method Detail

setAdAvailOffset

public void setAdAvailOffset(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.

getAdAvailOffset

public Integer getAdAvailOffset()

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.

withAdAvailOffset

public JobTemplateSettings withAdAvailOffset(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.

setAvailBlanking

public void setAvailBlanking(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.

getAvailBlanking

public AvailBlanking getAvailBlanking()

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.

withAvailBlanking

public JobTemplateSettings withAvailBlanking(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.

setEsam

public void setEsam(EsamSettings esam)

Settings for Event Signaling And Messaging (ESAM).

Parameters:

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

getEsam

public EsamSettings getEsam()

Settings for Event Signaling And Messaging (ESAM).

Returns:

Settings for Event Signaling And Messaging (ESAM).

withEsam

public JobTemplateSettings withEsam(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.

getInputs

public List<InputTemplate> getInputs()

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:

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.

setInputs

public void setInputs(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.

withInputs

public JobTemplateSettings withInputs(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.

NOTE: This method appends the values to the existing list (if any). Use setInputs(java.util.Collection) or withInputs(java.util.Collection) if you want to override the existing values.

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.

withInputs

public JobTemplateSettings withInputs(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.

setMotionImageInserter

public void setMotionImageInserter(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.

getMotionImageInserter

public MotionImageInserter getMotionImageInserter()

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

Returns:

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

withMotionImageInserter

public JobTemplateSettings withMotionImageInserter(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.

setNielsenConfiguration

public void setNielsenConfiguration(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.

getNielsenConfiguration

public NielsenConfiguration getNielsenConfiguration()

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.

withNielsenConfiguration

public JobTemplateSettings withNielsenConfiguration(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.

getOutputGroups

public List<OutputGroup> getOutputGroups()

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

(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

setOutputGroups

public void setOutputGroups(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

withOutputGroups

public JobTemplateSettings withOutputGroups(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

NOTE: This method appends the values to the existing list (if any). Use setOutputGroups(java.util.Collection) or withOutputGroups(java.util.Collection) if you want to override the existing values.

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.

withOutputGroups

public JobTemplateSettings withOutputGroups(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.

setTimecodeConfig

public void setTimecodeConfig(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.

getTimecodeConfig

public TimecodeConfig getTimecodeConfig()

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

Returns:

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

withTimecodeConfig

public JobTemplateSettings withTimecodeConfig(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.

setTimedMetadataInsertion

public void setTimedMetadataInsertion(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.

getTimedMetadataInsertion

public TimedMetadataInsertion getTimedMetadataInsertion()

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:

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.

withTimedMetadataInsertion

public JobTemplateSettings withTimedMetadataInsertion(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public JobTemplateSettings clone()

Overrides:

clone in class Object

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.