com.amazonaws.services.mediaconvert.model.JobSettings Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-mediaconvert Show documentation
Show all versions of aws-java-sdk-mediaconvert Show documentation
The AWS Java SDK for AWS Elemental MediaConvert module holds the client classes that are used for communicating with AWS Elemental MediaConvert Service
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.mediaconvert.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
* JobSettings contains all the transcode settings for a job.
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class JobSettings implements Serializable, Cloneable, StructuredPojo {
/** When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. */
private Integer adAvailOffset;
/**
* Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35
* triggered ad avails.
*/
private AvailBlanking availBlanking;
/**
* Use 3D LUTs to specify custom color mapping behavior when you convert from one color space into another. You can
* include up to 8 different 3D LUTs. For more information, see:
* https://docs.aws.amazon.com/mediaconvert/latest/ug/3d-luts.html
*/
private java.util.List colorConversion3DLUTSettings;
/** Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these settings. */
private EsamSettings esam;
/**
* If your source content has EIA-608 Line 21 Data Services, enable this feature to specify what MediaConvert does
* with the Extended Data Services (XDS) packets. You can choose to pass through XDS packets, or remove them from
* the output. For more information about XDS, see EIA-608 Line Data Services, section 9.5.1.5 05h Content Advisory.
*/
private ExtendedDataServices extendedDataServices;
/**
* Specify the input that MediaConvert references for your default output settings. MediaConvert uses this input's
* Resolution, Frame rate, and Pixel aspect ratio for all outputs that you don't manually specify different output
* settings for. Enabling this setting will disable "Follow source" for all other inputs. If MediaConvert cannot
* follow your source, for example if you specify an audio-only input, MediaConvert uses the first followable input
* instead. In your JSON job specification, enter an integer from 1 to 150 corresponding to the order of your inputs.
*/
private Integer followSource;
/**
* Use 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.
*/
private java.util.List inputs;
/**
* 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.
*/
private KantarWatermarkSettings kantarWatermark;
/**
* 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.
*/
private MotionImageInserter motionImageInserter;
/**
* Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these
* settings. When you enable Nielsen configuration, MediaConvert enables PCM to ID3 tagging for all outputs in the
* job.
*/
private NielsenConfiguration nielsenConfiguration;
/**
* 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]
*/
private NielsenNonLinearWatermarkSettings nielsenNonLinearWatermark;
/**
* 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
* is a group of settings that apply to the whole group. This required object depends on the value you set for Type.
* 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
*/
private java.util.List outputGroups;
/**
* These settings control how the service handles timecodes throughout the job. These settings don't affect input
* clipping.
*/
private TimecodeConfig timecodeConfig;
/**
* Insert user-defined custom ID3 metadata at timecodes that you specify. In each output that you want to include
* this metadata, you must set ID3 metadata to Passthrough.
*/
private TimedMetadataInsertion timedMetadataInsertion;
/**
* When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.
*
* @param adAvailOffset
* When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.
*/
public void setAdAvailOffset(Integer adAvailOffset) {
this.adAvailOffset = adAvailOffset;
}
/**
* When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.
*
* @return When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.
*/
public Integer getAdAvailOffset() {
return this.adAvailOffset;
}
/**
* When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.
*
* @param adAvailOffset
* When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobSettings withAdAvailOffset(Integer adAvailOffset) {
setAdAvailOffset(adAvailOffset);
return this;
}
/**
* Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35
* triggered ad avails.
*
* @param availBlanking
* Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during
* SCTE-35 triggered ad avails.
*/
public void setAvailBlanking(AvailBlanking availBlanking) {
this.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.
*
* @return Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during
* SCTE-35 triggered ad avails.
*/
public AvailBlanking getAvailBlanking() {
return this.availBlanking;
}
/**
* Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35
* triggered ad avails.
*
* @param availBlanking
* Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during
* SCTE-35 triggered ad avails.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobSettings withAvailBlanking(AvailBlanking availBlanking) {
setAvailBlanking(availBlanking);
return this;
}
/**
* Use 3D LUTs to specify custom color mapping behavior when you convert from one color space into another. You can
* include up to 8 different 3D LUTs. For more information, see:
* https://docs.aws.amazon.com/mediaconvert/latest/ug/3d-luts.html
*
* @return Use 3D LUTs to specify custom color mapping behavior when you convert from one color space into another.
* You can include up to 8 different 3D LUTs. For more information, see:
* https://docs.aws.amazon.com/mediaconvert/latest/ug/3d-luts.html
*/
public java.util.List getColorConversion3DLUTSettings() {
return colorConversion3DLUTSettings;
}
/**
* Use 3D LUTs to specify custom color mapping behavior when you convert from one color space into another. You can
* include up to 8 different 3D LUTs. For more information, see:
* https://docs.aws.amazon.com/mediaconvert/latest/ug/3d-luts.html
*
* @param colorConversion3DLUTSettings
* Use 3D LUTs to specify custom color mapping behavior when you convert from one color space into another.
* You can include up to 8 different 3D LUTs. For more information, see:
* https://docs.aws.amazon.com/mediaconvert/latest/ug/3d-luts.html
*/
public void setColorConversion3DLUTSettings(java.util.Collection colorConversion3DLUTSettings) {
if (colorConversion3DLUTSettings == null) {
this.colorConversion3DLUTSettings = null;
return;
}
this.colorConversion3DLUTSettings = new java.util.ArrayList(colorConversion3DLUTSettings);
}
/**
* Use 3D LUTs to specify custom color mapping behavior when you convert from one color space into another. You can
* include up to 8 different 3D LUTs. For more information, see:
* https://docs.aws.amazon.com/mediaconvert/latest/ug/3d-luts.html
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setColorConversion3DLUTSettings(java.util.Collection)} or
* {@link #withColorConversion3DLUTSettings(java.util.Collection)} if you want to override the existing values.
*
*
* @param colorConversion3DLUTSettings
* Use 3D LUTs to specify custom color mapping behavior when you convert from one color space into another.
* You can include up to 8 different 3D LUTs. For more information, see:
* https://docs.aws.amazon.com/mediaconvert/latest/ug/3d-luts.html
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobSettings withColorConversion3DLUTSettings(ColorConversion3DLUTSetting... colorConversion3DLUTSettings) {
if (this.colorConversion3DLUTSettings == null) {
setColorConversion3DLUTSettings(new java.util.ArrayList(colorConversion3DLUTSettings.length));
}
for (ColorConversion3DLUTSetting ele : colorConversion3DLUTSettings) {
this.colorConversion3DLUTSettings.add(ele);
}
return this;
}
/**
* Use 3D LUTs to specify custom color mapping behavior when you convert from one color space into another. You can
* include up to 8 different 3D LUTs. For more information, see:
* https://docs.aws.amazon.com/mediaconvert/latest/ug/3d-luts.html
*
* @param colorConversion3DLUTSettings
* Use 3D LUTs to specify custom color mapping behavior when you convert from one color space into another.
* You can include up to 8 different 3D LUTs. For more information, see:
* https://docs.aws.amazon.com/mediaconvert/latest/ug/3d-luts.html
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobSettings withColorConversion3DLUTSettings(java.util.Collection colorConversion3DLUTSettings) {
setColorConversion3DLUTSettings(colorConversion3DLUTSettings);
return this;
}
/**
* Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these settings.
*
* @param esam
* Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these
* settings.
*/
public void setEsam(EsamSettings esam) {
this.esam = esam;
}
/**
* Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these settings.
*
* @return Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these
* settings.
*/
public EsamSettings getEsam() {
return this.esam;
}
/**
* Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these settings.
*
* @param esam
* Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these
* settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobSettings withEsam(EsamSettings esam) {
setEsam(esam);
return this;
}
/**
* If your source content has EIA-608 Line 21 Data Services, enable this feature to specify what MediaConvert does
* with the Extended Data Services (XDS) packets. You can choose to pass through XDS packets, or remove them from
* the output. For more information about XDS, see EIA-608 Line Data Services, section 9.5.1.5 05h Content Advisory.
*
* @param extendedDataServices
* If your source content has EIA-608 Line 21 Data Services, enable this feature to specify what MediaConvert
* does with the Extended Data Services (XDS) packets. You can choose to pass through XDS packets, or remove
* them from the output. For more information about XDS, see EIA-608 Line Data Services, section 9.5.1.5 05h
* Content Advisory.
*/
public void setExtendedDataServices(ExtendedDataServices extendedDataServices) {
this.extendedDataServices = extendedDataServices;
}
/**
* If your source content has EIA-608 Line 21 Data Services, enable this feature to specify what MediaConvert does
* with the Extended Data Services (XDS) packets. You can choose to pass through XDS packets, or remove them from
* the output. For more information about XDS, see EIA-608 Line Data Services, section 9.5.1.5 05h Content Advisory.
*
* @return If your source content has EIA-608 Line 21 Data Services, enable this feature to specify what
* MediaConvert does with the Extended Data Services (XDS) packets. You can choose to pass through XDS
* packets, or remove them from the output. For more information about XDS, see EIA-608 Line Data Services,
* section 9.5.1.5 05h Content Advisory.
*/
public ExtendedDataServices getExtendedDataServices() {
return this.extendedDataServices;
}
/**
* If your source content has EIA-608 Line 21 Data Services, enable this feature to specify what MediaConvert does
* with the Extended Data Services (XDS) packets. You can choose to pass through XDS packets, or remove them from
* the output. For more information about XDS, see EIA-608 Line Data Services, section 9.5.1.5 05h Content Advisory.
*
* @param extendedDataServices
* If your source content has EIA-608 Line 21 Data Services, enable this feature to specify what MediaConvert
* does with the Extended Data Services (XDS) packets. You can choose to pass through XDS packets, or remove
* them from the output. For more information about XDS, see EIA-608 Line Data Services, section 9.5.1.5 05h
* Content Advisory.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobSettings withExtendedDataServices(ExtendedDataServices extendedDataServices) {
setExtendedDataServices(extendedDataServices);
return this;
}
/**
* Specify the input that MediaConvert references for your default output settings. MediaConvert uses this input's
* Resolution, Frame rate, and Pixel aspect ratio for all outputs that you don't manually specify different output
* settings for. Enabling this setting will disable "Follow source" for all other inputs. If MediaConvert cannot
* follow your source, for example if you specify an audio-only input, MediaConvert uses the first followable input
* instead. In your JSON job specification, enter an integer from 1 to 150 corresponding to the order of your inputs.
*
* @param followSource
* Specify the input that MediaConvert references for your default output settings. MediaConvert uses this
* input's Resolution, Frame rate, and Pixel aspect ratio for all outputs that you don't manually specify
* different output settings for. Enabling this setting will disable "Follow source" for all other inputs. If
* MediaConvert cannot follow your source, for example if you specify an audio-only input, MediaConvert uses
* the first followable input instead. In your JSON job specification, enter an integer from 1 to 150
* corresponding to the order of your inputs.
*/
public void setFollowSource(Integer followSource) {
this.followSource = followSource;
}
/**
* Specify the input that MediaConvert references for your default output settings. MediaConvert uses this input's
* Resolution, Frame rate, and Pixel aspect ratio for all outputs that you don't manually specify different output
* settings for. Enabling this setting will disable "Follow source" for all other inputs. If MediaConvert cannot
* follow your source, for example if you specify an audio-only input, MediaConvert uses the first followable input
* instead. In your JSON job specification, enter an integer from 1 to 150 corresponding to the order of your inputs.
*
* @return Specify the input that MediaConvert references for your default output settings. MediaConvert uses this
* input's Resolution, Frame rate, and Pixel aspect ratio for all outputs that you don't manually specify
* different output settings for. Enabling this setting will disable "Follow source" for all other inputs.
* If MediaConvert cannot follow your source, for example if you specify an audio-only input, MediaConvert
* uses the first followable input instead. In your JSON job specification, enter an integer from 1 to 150
* corresponding to the order of your inputs.
*/
public Integer getFollowSource() {
return this.followSource;
}
/**
* Specify the input that MediaConvert references for your default output settings. MediaConvert uses this input's
* Resolution, Frame rate, and Pixel aspect ratio for all outputs that you don't manually specify different output
* settings for. Enabling this setting will disable "Follow source" for all other inputs. If MediaConvert cannot
* follow your source, for example if you specify an audio-only input, MediaConvert uses the first followable input
* instead. In your JSON job specification, enter an integer from 1 to 150 corresponding to the order of your inputs.
*
* @param followSource
* Specify the input that MediaConvert references for your default output settings. MediaConvert uses this
* input's Resolution, Frame rate, and Pixel aspect ratio for all outputs that you don't manually specify
* different output settings for. Enabling this setting will disable "Follow source" for all other inputs. If
* MediaConvert cannot follow your source, for example if you specify an audio-only input, MediaConvert uses
* the first followable input instead. In your JSON job specification, enter an integer from 1 to 150
* corresponding to the order of your inputs.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobSettings withFollowSource(Integer followSource) {
setFollowSource(followSource);
return this;
}
/**
* Use 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.
*
* @return Use 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.
*/
public java.util.List getInputs() {
return inputs;
}
/**
* Use 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.
*
* @param inputs
* Use 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.
*/
public void setInputs(java.util.Collection inputs) {
if (inputs == null) {
this.inputs = null;
return;
}
this.inputs = new java.util.ArrayList(inputs);
}
/**
* Use 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.
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setInputs(java.util.Collection)} or {@link #withInputs(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param inputs
* Use 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobSettings withInputs(Input... inputs) {
if (this.inputs == null) {
setInputs(new java.util.ArrayList(inputs.length));
}
for (Input ele : inputs) {
this.inputs.add(ele);
}
return this;
}
/**
* Use 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.
*
* @param inputs
* Use 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobSettings withInputs(java.util.Collection inputs) {
setInputs(inputs);
return this;
}
/**
* 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.
*
* @param 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.
*/
public void setKantarWatermark(KantarWatermarkSettings kantarWatermark) {
this.kantarWatermark = 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.
*
* @return 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.
*/
public KantarWatermarkSettings getKantarWatermark() {
return this.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.
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobSettings withKantarWatermark(KantarWatermarkSettings kantarWatermark) {
setKantarWatermark(kantarWatermark);
return this;
}
/**
* 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.
*
* @param 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.
*/
public void setMotionImageInserter(MotionImageInserter motionImageInserter) {
this.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.
*
* @return 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.
*/
public MotionImageInserter getMotionImageInserter() {
return this.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.
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobSettings withMotionImageInserter(MotionImageInserter motionImageInserter) {
setMotionImageInserter(motionImageInserter);
return this;
}
/**
* Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these
* settings. When you enable Nielsen configuration, MediaConvert enables PCM to ID3 tagging for all outputs in the
* job.
*
* @param nielsenConfiguration
* Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these
* settings. When you enable Nielsen configuration, MediaConvert enables PCM to ID3 tagging for all outputs
* in the job.
*/
public void setNielsenConfiguration(NielsenConfiguration nielsenConfiguration) {
this.nielsenConfiguration = nielsenConfiguration;
}
/**
* Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these
* settings. When you enable Nielsen configuration, MediaConvert enables PCM to ID3 tagging for all outputs in the
* job.
*
* @return Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these
* settings. When you enable Nielsen configuration, MediaConvert enables PCM to ID3 tagging for all outputs
* in the job.
*/
public NielsenConfiguration getNielsenConfiguration() {
return this.nielsenConfiguration;
}
/**
* Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these
* settings. When you enable Nielsen configuration, MediaConvert enables PCM to ID3 tagging for all outputs in the
* job.
*
* @param nielsenConfiguration
* Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these
* settings. When you enable Nielsen configuration, MediaConvert enables PCM to ID3 tagging for all outputs
* in the job.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobSettings withNielsenConfiguration(NielsenConfiguration nielsenConfiguration) {
setNielsenConfiguration(nielsenConfiguration);
return this;
}
/**
* 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]
*
* @param 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]
*/
public void setNielsenNonLinearWatermark(NielsenNonLinearWatermarkSettings nielsenNonLinearWatermark) {
this.nielsenNonLinearWatermark = 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]
*
* @return 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]
*/
public NielsenNonLinearWatermarkSettings getNielsenNonLinearWatermark() {
return this.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]
*
* @param 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]
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobSettings withNielsenNonLinearWatermark(NielsenNonLinearWatermarkSettings nielsenNonLinearWatermark) {
setNielsenNonLinearWatermark(nielsenNonLinearWatermark);
return this;
}
/**
* 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
* is a group of settings that apply to the whole group. This required object depends on the value you set for Type.
* 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
*
* @return 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 is a group of settings that apply to the whole group. This required object depends on the
* value you set for Type. 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
*/
public java.util.List getOutputGroups() {
return 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
* is a group of settings that apply to the whole group. This required object depends on the value you set for Type.
* 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
*
* @param 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 is a group of settings that apply to the whole group. This required object depends on the
* value you set for Type. 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
*/
public void setOutputGroups(java.util.Collection outputGroups) {
if (outputGroups == null) {
this.outputGroups = null;
return;
}
this.outputGroups = new java.util.ArrayList(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
* is a group of settings that apply to the whole group. This required object depends on the value you set for Type.
* 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
* {@link #setOutputGroups(java.util.Collection)} or {@link #withOutputGroups(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param 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 is a group of settings that apply to the whole group. This required object depends on the
* value you set for Type. 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobSettings withOutputGroups(OutputGroup... outputGroups) {
if (this.outputGroups == null) {
setOutputGroups(new java.util.ArrayList(outputGroups.length));
}
for (OutputGroup ele : outputGroups) {
this.outputGroups.add(ele);
}
return this;
}
/**
* 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
* is a group of settings that apply to the whole group. This required object depends on the value you set for Type.
* 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
*
* @param 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 is a group of settings that apply to the whole group. This required object depends on the
* value you set for Type. 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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobSettings withOutputGroups(java.util.Collection outputGroups) {
setOutputGroups(outputGroups);
return this;
}
/**
* These settings control how the service handles timecodes throughout the job. These settings don't affect input
* clipping.
*
* @param timecodeConfig
* These settings control how the service handles timecodes throughout the job. These settings don't affect
* input clipping.
*/
public void setTimecodeConfig(TimecodeConfig timecodeConfig) {
this.timecodeConfig = timecodeConfig;
}
/**
* These settings control how the service handles timecodes throughout the job. These settings don't affect input
* clipping.
*
* @return These settings control how the service handles timecodes throughout the job. These settings don't affect
* input clipping.
*/
public TimecodeConfig getTimecodeConfig() {
return this.timecodeConfig;
}
/**
* These settings control how the service handles timecodes throughout the job. These settings don't affect input
* clipping.
*
* @param timecodeConfig
* These settings control how the service handles timecodes throughout the job. These settings don't affect
* input clipping.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobSettings withTimecodeConfig(TimecodeConfig timecodeConfig) {
setTimecodeConfig(timecodeConfig);
return this;
}
/**
* Insert user-defined custom ID3 metadata at timecodes that you specify. In each output that you want to include
* this metadata, you must set ID3 metadata to Passthrough.
*
* @param timedMetadataInsertion
* Insert user-defined custom ID3 metadata at timecodes that you specify. In each output that you want to
* include this metadata, you must set ID3 metadata to Passthrough.
*/
public void setTimedMetadataInsertion(TimedMetadataInsertion timedMetadataInsertion) {
this.timedMetadataInsertion = timedMetadataInsertion;
}
/**
* Insert user-defined custom ID3 metadata at timecodes that you specify. In each output that you want to include
* this metadata, you must set ID3 metadata to Passthrough.
*
* @return Insert user-defined custom ID3 metadata at timecodes that you specify. In each output that you want to
* include this metadata, you must set ID3 metadata to Passthrough.
*/
public TimedMetadataInsertion getTimedMetadataInsertion() {
return this.timedMetadataInsertion;
}
/**
* Insert user-defined custom ID3 metadata at timecodes that you specify. In each output that you want to include
* this metadata, you must set ID3 metadata to Passthrough.
*
* @param timedMetadataInsertion
* Insert user-defined custom ID3 metadata at timecodes that you specify. In each output that you want to
* include this metadata, you must set ID3 metadata to Passthrough.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public JobSettings withTimedMetadataInsertion(TimedMetadataInsertion timedMetadataInsertion) {
setTimedMetadataInsertion(timedMetadataInsertion);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getAdAvailOffset() != null)
sb.append("AdAvailOffset: ").append(getAdAvailOffset()).append(",");
if (getAvailBlanking() != null)
sb.append("AvailBlanking: ").append(getAvailBlanking()).append(",");
if (getColorConversion3DLUTSettings() != null)
sb.append("ColorConversion3DLUTSettings: ").append(getColorConversion3DLUTSettings()).append(",");
if (getEsam() != null)
sb.append("Esam: ").append(getEsam()).append(",");
if (getExtendedDataServices() != null)
sb.append("ExtendedDataServices: ").append(getExtendedDataServices()).append(",");
if (getFollowSource() != null)
sb.append("FollowSource: ").append(getFollowSource()).append(",");
if (getInputs() != null)
sb.append("Inputs: ").append(getInputs()).append(",");
if (getKantarWatermark() != null)
sb.append("KantarWatermark: ").append(getKantarWatermark()).append(",");
if (getMotionImageInserter() != null)
sb.append("MotionImageInserter: ").append(getMotionImageInserter()).append(",");
if (getNielsenConfiguration() != null)
sb.append("NielsenConfiguration: ").append(getNielsenConfiguration()).append(",");
if (getNielsenNonLinearWatermark() != null)
sb.append("NielsenNonLinearWatermark: ").append(getNielsenNonLinearWatermark()).append(",");
if (getOutputGroups() != null)
sb.append("OutputGroups: ").append(getOutputGroups()).append(",");
if (getTimecodeConfig() != null)
sb.append("TimecodeConfig: ").append(getTimecodeConfig()).append(",");
if (getTimedMetadataInsertion() != null)
sb.append("TimedMetadataInsertion: ").append(getTimedMetadataInsertion());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof JobSettings == false)
return false;
JobSettings other = (JobSettings) obj;
if (other.getAdAvailOffset() == null ^ this.getAdAvailOffset() == null)
return false;
if (other.getAdAvailOffset() != null && other.getAdAvailOffset().equals(this.getAdAvailOffset()) == false)
return false;
if (other.getAvailBlanking() == null ^ this.getAvailBlanking() == null)
return false;
if (other.getAvailBlanking() != null && other.getAvailBlanking().equals(this.getAvailBlanking()) == false)
return false;
if (other.getColorConversion3DLUTSettings() == null ^ this.getColorConversion3DLUTSettings() == null)
return false;
if (other.getColorConversion3DLUTSettings() != null && other.getColorConversion3DLUTSettings().equals(this.getColorConversion3DLUTSettings()) == false)
return false;
if (other.getEsam() == null ^ this.getEsam() == null)
return false;
if (other.getEsam() != null && other.getEsam().equals(this.getEsam()) == false)
return false;
if (other.getExtendedDataServices() == null ^ this.getExtendedDataServices() == null)
return false;
if (other.getExtendedDataServices() != null && other.getExtendedDataServices().equals(this.getExtendedDataServices()) == false)
return false;
if (other.getFollowSource() == null ^ this.getFollowSource() == null)
return false;
if (other.getFollowSource() != null && other.getFollowSource().equals(this.getFollowSource()) == false)
return false;
if (other.getInputs() == null ^ this.getInputs() == null)
return false;
if (other.getInputs() != null && other.getInputs().equals(this.getInputs()) == false)
return false;
if (other.getKantarWatermark() == null ^ this.getKantarWatermark() == null)
return false;
if (other.getKantarWatermark() != null && other.getKantarWatermark().equals(this.getKantarWatermark()) == false)
return false;
if (other.getMotionImageInserter() == null ^ this.getMotionImageInserter() == null)
return false;
if (other.getMotionImageInserter() != null && other.getMotionImageInserter().equals(this.getMotionImageInserter()) == false)
return false;
if (other.getNielsenConfiguration() == null ^ this.getNielsenConfiguration() == null)
return false;
if (other.getNielsenConfiguration() != null && other.getNielsenConfiguration().equals(this.getNielsenConfiguration()) == false)
return false;
if (other.getNielsenNonLinearWatermark() == null ^ this.getNielsenNonLinearWatermark() == null)
return false;
if (other.getNielsenNonLinearWatermark() != null && other.getNielsenNonLinearWatermark().equals(this.getNielsenNonLinearWatermark()) == false)
return false;
if (other.getOutputGroups() == null ^ this.getOutputGroups() == null)
return false;
if (other.getOutputGroups() != null && other.getOutputGroups().equals(this.getOutputGroups()) == false)
return false;
if (other.getTimecodeConfig() == null ^ this.getTimecodeConfig() == null)
return false;
if (other.getTimecodeConfig() != null && other.getTimecodeConfig().equals(this.getTimecodeConfig()) == false)
return false;
if (other.getTimedMetadataInsertion() == null ^ this.getTimedMetadataInsertion() == null)
return false;
if (other.getTimedMetadataInsertion() != null && other.getTimedMetadataInsertion().equals(this.getTimedMetadataInsertion()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAdAvailOffset() == null) ? 0 : getAdAvailOffset().hashCode());
hashCode = prime * hashCode + ((getAvailBlanking() == null) ? 0 : getAvailBlanking().hashCode());
hashCode = prime * hashCode + ((getColorConversion3DLUTSettings() == null) ? 0 : getColorConversion3DLUTSettings().hashCode());
hashCode = prime * hashCode + ((getEsam() == null) ? 0 : getEsam().hashCode());
hashCode = prime * hashCode + ((getExtendedDataServices() == null) ? 0 : getExtendedDataServices().hashCode());
hashCode = prime * hashCode + ((getFollowSource() == null) ? 0 : getFollowSource().hashCode());
hashCode = prime * hashCode + ((getInputs() == null) ? 0 : getInputs().hashCode());
hashCode = prime * hashCode + ((getKantarWatermark() == null) ? 0 : getKantarWatermark().hashCode());
hashCode = prime * hashCode + ((getMotionImageInserter() == null) ? 0 : getMotionImageInserter().hashCode());
hashCode = prime * hashCode + ((getNielsenConfiguration() == null) ? 0 : getNielsenConfiguration().hashCode());
hashCode = prime * hashCode + ((getNielsenNonLinearWatermark() == null) ? 0 : getNielsenNonLinearWatermark().hashCode());
hashCode = prime * hashCode + ((getOutputGroups() == null) ? 0 : getOutputGroups().hashCode());
hashCode = prime * hashCode + ((getTimecodeConfig() == null) ? 0 : getTimecodeConfig().hashCode());
hashCode = prime * hashCode + ((getTimedMetadataInsertion() == null) ? 0 : getTimedMetadataInsertion().hashCode());
return hashCode;
}
@Override
public JobSettings clone() {
try {
return (JobSettings) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.mediaconvert.model.transform.JobSettingsMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}