Interface JobTemplateSettings.Builder

All Superinterfaces:
Buildable, CopyableBuilder<JobTemplateSettings.Builder,JobTemplateSettings>, SdkBuilder<JobTemplateSettings.Builder,JobTemplateSettings>, SdkPojo
Enclosing class:
JobTemplateSettings

public static interface JobTemplateSettings.Builder extends SdkPojo, CopyableBuilder<JobTemplateSettings.Builder,JobTemplateSettings>
  • Method Details

    • adAvailOffset

      JobTemplateSettings.Builder adAvailOffset(Integer adAvailOffset)
      When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.
      Parameters:
      adAvailOffset - When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • availBlanking

      JobTemplateSettings.Builder availBlanking(AvailBlanking availBlanking)
      Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails.
      Parameters:
      availBlanking - Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • availBlanking

      default JobTemplateSettings.Builder availBlanking(Consumer<AvailBlanking.Builder> availBlanking)
      Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails. This is a convenience method that creates an instance of the AvailBlanking.Builder avoiding the need to create one manually via AvailBlanking.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to availBlanking(AvailBlanking).

      Parameters:
      availBlanking - a consumer that will call methods on AvailBlanking.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • colorConversion3DLUTSettings

      JobTemplateSettings.Builder colorConversion3DLUTSettings(Collection<ColorConversion3DLUTSetting> 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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • colorConversion3DLUTSettings

      JobTemplateSettings.Builder colorConversion3DLUTSettings(ColorConversion3DLUTSetting... 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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • colorConversion3DLUTSettings

      JobTemplateSettings.Builder colorConversion3DLUTSettings(Consumer<ColorConversion3DLUTSetting.Builder>... 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. This is a convenience method that creates an instance of the ColorConversion3DLUTSetting.Builder avoiding the need to create one manually via ColorConversion3DLUTSetting.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to colorConversion3DLUTSettings(List<ColorConversion3DLUTSetting>).

      Parameters:
      colorConversion3DLUTSettings - a consumer that will call methods on ColorConversion3DLUTSetting.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • esam

      Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these settings.
      Parameters:
      esam - Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these settings.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • esam

      Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these settings. This is a convenience method that creates an instance of the EsamSettings.Builder avoiding the need to create one manually via EsamSettings.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to esam(EsamSettings).

      Parameters:
      esam - a consumer that will call methods on EsamSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • extendedDataServices

      JobTemplateSettings.Builder extendedDataServices(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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • extendedDataServices

      default JobTemplateSettings.Builder extendedDataServices(Consumer<ExtendedDataServices.Builder> 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. This is a convenience method that creates an instance of the ExtendedDataServices.Builder avoiding the need to create one manually via ExtendedDataServices.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to extendedDataServices(ExtendedDataServices).

      Parameters:
      extendedDataServices - a consumer that will call methods on ExtendedDataServices.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • followSource

      JobTemplateSettings.Builder followSource(Integer 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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • inputs

      Use 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 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.
    • inputs

      Use 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 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.
    • inputs

      Use 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. This is a convenience method that creates an instance of the InputTemplate.Builder avoiding the need to create one manually via InputTemplate.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inputs(List<InputTemplate>).

      Parameters:
      inputs - a consumer that will call methods on InputTemplate.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • kantarWatermark

      JobTemplateSettings.Builder kantarWatermark(KantarWatermarkSettings kantarWatermark)
      Use these settings only when you use Kantar watermarking. Specify the values that MediaConvert uses to generate and place Kantar watermarks in your output audio. These settings apply to every output in your job. In addition to specifying these values, you also need to store your Kantar credentials in AWS Secrets Manager. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/kantar-watermarking.html.
      Parameters:
      kantarWatermark - Use these settings only when you use Kantar watermarking. Specify the values that MediaConvert uses to generate and place Kantar watermarks in your output audio. These settings apply to every output in your job. In addition to specifying these values, you also need to store your Kantar credentials in AWS Secrets Manager. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/kantar-watermarking.html.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • kantarWatermark

      default JobTemplateSettings.Builder kantarWatermark(Consumer<KantarWatermarkSettings.Builder> kantarWatermark)
      Use these settings only when you use Kantar watermarking. Specify the values that MediaConvert uses to generate and place Kantar watermarks in your output audio. These settings apply to every output in your job. In addition to specifying these values, you also need to store your Kantar credentials in AWS Secrets Manager. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/kantar-watermarking.html. This is a convenience method that creates an instance of the KantarWatermarkSettings.Builder avoiding the need to create one manually via KantarWatermarkSettings.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to kantarWatermark(KantarWatermarkSettings).

      Parameters:
      kantarWatermark - a consumer that will call methods on KantarWatermarkSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • motionImageInserter

      JobTemplateSettings.Builder motionImageInserter(MotionImageInserter motionImageInserter)
      Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in all output groups. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/motion-graphic-overlay.html.
      Parameters:
      motionImageInserter - Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in all output groups. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/motion-graphic-overlay.html.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • motionImageInserter

      default JobTemplateSettings.Builder motionImageInserter(Consumer<MotionImageInserter.Builder> motionImageInserter)
      Overlay motion graphics on top of your video. The motion graphics that you specify here appear on all outputs in all output groups. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/motion-graphic-overlay.html. This is a convenience method that creates an instance of the MotionImageInserter.Builder avoiding the need to create one manually via MotionImageInserter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to motionImageInserter(MotionImageInserter).

      Parameters:
      motionImageInserter - a consumer that will call methods on MotionImageInserter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • nielsenConfiguration

      JobTemplateSettings.Builder nielsenConfiguration(NielsenConfiguration nielsenConfiguration)
      Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these settings. When you enable Nielsen configuration, MediaConvert enables PCM to ID3 tagging for all outputs in the job.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • nielsenConfiguration

      default JobTemplateSettings.Builder nielsenConfiguration(Consumer<NielsenConfiguration.Builder> nielsenConfiguration)
      Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these settings. When you enable Nielsen configuration, MediaConvert enables PCM to ID3 tagging for all outputs in the job. This is a convenience method that creates an instance of the NielsenConfiguration.Builder avoiding the need to create one manually via NielsenConfiguration.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to nielsenConfiguration(NielsenConfiguration).

      Parameters:
      nielsenConfiguration - a consumer that will call methods on NielsenConfiguration.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • nielsenNonLinearWatermark

      JobTemplateSettings.Builder nielsenNonLinearWatermark(NielsenNonLinearWatermarkSettings nielsenNonLinearWatermark)
      Ignore these settings unless you are using Nielsen non-linear watermarking. Specify the values that MediaConvert uses to generate and place Nielsen watermarks in your output audio. In addition to specifying these values, you also need to set up your cloud TIC server. These settings apply to every output in your job. The MediaConvert implementation is currently with the following Nielsen versions: Nielsen Watermark SDK Version 5.2.1 Nielsen NLM Watermark Engine Version 1.2.7 Nielsen Watermark Authenticator [SID_TIC] Version [5.0.0]
      Parameters:
      nielsenNonLinearWatermark - Ignore these settings unless you are using Nielsen non-linear watermarking. Specify the values that MediaConvert uses to generate and place Nielsen watermarks in your output audio. In addition to specifying these values, you also need to set up your cloud TIC server. These settings apply to every output in your job. The MediaConvert implementation is currently with the following Nielsen versions: Nielsen Watermark SDK Version 5.2.1 Nielsen NLM Watermark Engine Version 1.2.7 Nielsen Watermark Authenticator [SID_TIC] Version [5.0.0]
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • nielsenNonLinearWatermark

      default JobTemplateSettings.Builder nielsenNonLinearWatermark(Consumer<NielsenNonLinearWatermarkSettings.Builder> nielsenNonLinearWatermark)
      Ignore these settings unless you are using Nielsen non-linear watermarking. Specify the values that MediaConvert uses to generate and place Nielsen watermarks in your output audio. In addition to specifying these values, you also need to set up your cloud TIC server. These settings apply to every output in your job. The MediaConvert implementation is currently with the following Nielsen versions: Nielsen Watermark SDK Version 5.2.1 Nielsen NLM Watermark Engine Version 1.2.7 Nielsen Watermark Authenticator [SID_TIC] Version [5.0.0] This is a convenience method that creates an instance of the NielsenNonLinearWatermarkSettings.Builder avoiding the need to create one manually via NielsenNonLinearWatermarkSettings.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to nielsenNonLinearWatermark(NielsenNonLinearWatermarkSettings).

      Parameters:
      nielsenNonLinearWatermark - a consumer that will call methods on NielsenNonLinearWatermarkSettings.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • outputGroups

      JobTemplateSettings.Builder outputGroups(Collection<OutputGroup> 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
      Parameters:
      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
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • outputGroups

      JobTemplateSettings.Builder outputGroups(OutputGroup... 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
      Parameters:
      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
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • 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 This is a convenience method that creates an instance of the OutputGroup.Builder avoiding the need to create one manually via OutputGroup.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to outputGroups(List<OutputGroup>).

      Parameters:
      outputGroups - a consumer that will call methods on OutputGroup.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • timecodeConfig

      JobTemplateSettings.Builder timecodeConfig(TimecodeConfig timecodeConfig)
      These settings control how the service handles timecodes throughout the job. These settings don't affect input clipping.
      Parameters:
      timecodeConfig - These settings control how the service handles timecodes throughout the job. These settings don't affect input clipping.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • timecodeConfig

      default JobTemplateSettings.Builder timecodeConfig(Consumer<TimecodeConfig.Builder> timecodeConfig)
      These settings control how the service handles timecodes throughout the job. These settings don't affect input clipping. This is a convenience method that creates an instance of the TimecodeConfig.Builder avoiding the need to create one manually via TimecodeConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timecodeConfig(TimecodeConfig).

      Parameters:
      timecodeConfig - a consumer that will call methods on TimecodeConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • timedMetadataInsertion

      JobTemplateSettings.Builder timedMetadataInsertion(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.
      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • timedMetadataInsertion

      default JobTemplateSettings.Builder timedMetadataInsertion(Consumer<TimedMetadataInsertion.Builder> 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. This is a convenience method that creates an instance of the TimedMetadataInsertion.Builder avoiding the need to create one manually via TimedMetadataInsertion.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to timedMetadataInsertion(TimedMetadataInsertion).

      Parameters:
      timedMetadataInsertion - a consumer that will call methods on TimedMetadataInsertion.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: