software.amazon.awssdk.services.mediaconvert.model

Class JobSettings

java.lang.Object

software.amazon.awssdk.services.mediaconvert.model.JobSettings

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<JobSettings.Builder,JobSettings>

@Generated(value="software.amazon.awssdk:codegen")
public final class JobSettings
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<JobSettings.Builder,JobSettings>

JobSettings contains all the transcode settings for a job.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	JobSettings.Builder

Method Summary

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 JobSettings.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()
List<Input>	inputs() Use Inputs (inputs) to define source file used in the transcode job.
MotionImageInserter	motionImageInserter() Overlay motion graphics on top of your video.
NielsenConfiguration	nielsenConfiguration() Settings for your Nielsen configuration.
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 JobSettings.Builder>	serializableBuilderClass()
TimecodeConfig	timecodeConfig() Contains settings used to acquire and adjust timecode information from inputs.
TimedMetadataInsertion	timedMetadataInsertion() Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in your job.
JobSettings.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 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 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 EsamSettings esam()

Settings for Event Signaling And Messaging (ESAM).

Returns:

Settings for Event Signaling And Messaging (ESAM).

inputs

public List<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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

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.

motionImageInserter

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

Returns:

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

nielsenConfiguration

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

outputGroups

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

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 TimecodeConfig timecodeConfig()

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

Returns:

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

timedMetadataInsertion

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

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.

toBuilder

public JobSettings.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<JobSettings.Builder,JobSettings>

builder

public static JobSettings.Builder builder()

serializableBuilderClass

public static Class<? extends JobSettings.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo