Class: Aws::MediaConvert::Types::JobTemplateSettings

Inherits:

Struct

• Object
• Struct
• Aws::MediaConvert::Types::JobTemplateSettings

Defined in:

gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #ad_avail_offset ⇒ Integer

  When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.

• #avail_blanking ⇒ Types::AvailBlanking

  Settings for ad avail blanking.

• #color_conversion_3_dlut_settings ⇒ Array<Types::ColorConversion3DLUTSetting>

  Use 3D LUTs to specify custom color mapping behavior when you convert from one color space into another.

• #esam ⇒ Types::EsamSettings

  Settings for Event Signaling And Messaging (ESAM).

• #extended_data_services ⇒ Types::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.

• #follow_source ⇒ Integer

  Specify the input that MediaConvert references for your default output settings.

• #inputs ⇒ Array<Types::InputTemplate>

  Use Inputs to define the source file used in the transcode job.

• #kantar_watermark ⇒ Types::KantarWatermarkSettings

  Use these settings only when you use Kantar watermarking.

• #motion_image_inserter ⇒ Types::MotionImageInserter

  Overlay motion graphics on top of your video.

• #nielsen_configuration ⇒ Types::NielsenConfiguration

  Settings for your Nielsen configuration.

• #nielsen_non_linear_watermark ⇒ Types::NielsenNonLinearWatermarkSettings

  Ignore these settings unless you are using Nielsen non-linear watermarking.

• #output_groups ⇒ Array<Types::OutputGroup>

  Contains one group of settings for each set of outputs that share a common package type.

• #timecode_config ⇒ Types::TimecodeConfig

  These settings control how the service handles timecodes throughout the job.

• #timed_metadata_insertion ⇒ Types::TimedMetadataInsertion

  Insert user-defined custom ID3 metadata at timecodes that you specify.

Instance Attribute Details

#ad_avail_offset ⇒ Integer

When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.

Returns:

• (Integer)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8312

class JobTemplateSettings < Struct.new(
  :ad_avail_offset,
  :avail_blanking,
  :color_conversion_3_dlut_settings,
  :esam,
  :extended_data_services,
  :follow_source,
  :inputs,
  :kantar_watermark,
  :motion_image_inserter,
  :nielsen_configuration,
  :nielsen_non_linear_watermark,
  :output_groups,
  :timecode_config,
  :timed_metadata_insertion)
  SENSITIVE = []
  include Aws::Structure
end

#avail_blanking ⇒ Types::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:

• (Types::AvailBlanking)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8312

class JobTemplateSettings < Struct.new(
  :ad_avail_offset,
  :avail_blanking,
  :color_conversion_3_dlut_settings,
  :esam,
  :extended_data_services,
  :follow_source,
  :inputs,
  :kantar_watermark,
  :motion_image_inserter,
  :nielsen_configuration,
  :nielsen_non_linear_watermark,
  :output_groups,
  :timecode_config,
  :timed_metadata_insertion)
  SENSITIVE = []
  include Aws::Structure
end

#color_conversion_3_dlut_settings ⇒ Array<Types::ColorConversion3DLUTSetting>

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

Returns:

• (Array<Types::ColorConversion3DLUTSetting>)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8312

class JobTemplateSettings < Struct.new(
  :ad_avail_offset,
  :avail_blanking,
  :color_conversion_3_dlut_settings,
  :esam,
  :extended_data_services,
  :follow_source,
  :inputs,
  :kantar_watermark,
  :motion_image_inserter,
  :nielsen_configuration,
  :nielsen_non_linear_watermark,
  :output_groups,
  :timecode_config,
  :timed_metadata_insertion)
  SENSITIVE = []
  include Aws::Structure
end

#esam ⇒ Types::EsamSettings

Settings for Event Signaling And Messaging (ESAM). If you don't do ad insertion, you can ignore these settings.

Returns:

• (Types::EsamSettings)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8312

class JobTemplateSettings < Struct.new(
  :ad_avail_offset,
  :avail_blanking,
  :color_conversion_3_dlut_settings,
  :esam,
  :extended_data_services,
  :follow_source,
  :inputs,
  :kantar_watermark,
  :motion_image_inserter,
  :nielsen_configuration,
  :nielsen_non_linear_watermark,
  :output_groups,
  :timecode_config,
  :timed_metadata_insertion)
  SENSITIVE = []
  include Aws::Structure
end

#extended_data_services ⇒ Types::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:

• (Types::ExtendedDataServices)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8312

class JobTemplateSettings < Struct.new(
  :ad_avail_offset,
  :avail_blanking,
  :color_conversion_3_dlut_settings,
  :esam,
  :extended_data_services,
  :follow_source,
  :inputs,
  :kantar_watermark,
  :motion_image_inserter,
  :nielsen_configuration,
  :nielsen_non_linear_watermark,
  :output_groups,
  :timecode_config,
  :timed_metadata_insertion)
  SENSITIVE = []
  include Aws::Structure
end

#follow_source ⇒ Integer

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:

• (Integer)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8312

class JobTemplateSettings < Struct.new(
  :ad_avail_offset,
  :avail_blanking,
  :color_conversion_3_dlut_settings,
  :esam,
  :extended_data_services,
  :follow_source,
  :inputs,
  :kantar_watermark,
  :motion_image_inserter,
  :nielsen_configuration,
  :nielsen_non_linear_watermark,
  :output_groups,
  :timecode_config,
  :timed_metadata_insertion)
  SENSITIVE = []
  include Aws::Structure
end

#inputs ⇒ Array<Types::InputTemplate>

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:

• (Array<Types::InputTemplate>)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8312

class JobTemplateSettings < Struct.new(
  :ad_avail_offset,
  :avail_blanking,
  :color_conversion_3_dlut_settings,
  :esam,
  :extended_data_services,
  :follow_source,
  :inputs,
  :kantar_watermark,
  :motion_image_inserter,
  :nielsen_configuration,
  :nielsen_non_linear_watermark,
  :output_groups,
  :timecode_config,
  :timed_metadata_insertion)
  SENSITIVE = []
  include Aws::Structure
end

#kantar_watermark ⇒ Types::KantarWatermarkSettings

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:

• (Types::KantarWatermarkSettings)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8312

class JobTemplateSettings < Struct.new(
  :ad_avail_offset,
  :avail_blanking,
  :color_conversion_3_dlut_settings,
  :esam,
  :extended_data_services,
  :follow_source,
  :inputs,
  :kantar_watermark,
  :motion_image_inserter,
  :nielsen_configuration,
  :nielsen_non_linear_watermark,
  :output_groups,
  :timecode_config,
  :timed_metadata_insertion)
  SENSITIVE = []
  include Aws::Structure
end

#motion_image_inserter ⇒ Types::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:

• (Types::MotionImageInserter)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8312

class JobTemplateSettings < Struct.new(
  :ad_avail_offset,
  :avail_blanking,
  :color_conversion_3_dlut_settings,
  :esam,
  :extended_data_services,
  :follow_source,
  :inputs,
  :kantar_watermark,
  :motion_image_inserter,
  :nielsen_configuration,
  :nielsen_non_linear_watermark,
  :output_groups,
  :timecode_config,
  :timed_metadata_insertion)
  SENSITIVE = []
  include Aws::Structure
end

#nielsen_configuration ⇒ Types::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:

• (Types::NielsenConfiguration)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8312

class JobTemplateSettings < Struct.new(
  :ad_avail_offset,
  :avail_blanking,
  :color_conversion_3_dlut_settings,
  :esam,
  :extended_data_services,
  :follow_source,
  :inputs,
  :kantar_watermark,
  :motion_image_inserter,
  :nielsen_configuration,
  :nielsen_non_linear_watermark,
  :output_groups,
  :timecode_config,
  :timed_metadata_insertion)
  SENSITIVE = []
  include Aws::Structure
end

#nielsen_non_linear_watermark ⇒ Types::NielsenNonLinearWatermarkSettings

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:

• (Types::NielsenNonLinearWatermarkSettings)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8312

class JobTemplateSettings < Struct.new(
  :ad_avail_offset,
  :avail_blanking,
  :color_conversion_3_dlut_settings,
  :esam,
  :extended_data_services,
  :follow_source,
  :inputs,
  :kantar_watermark,
  :motion_image_inserter,
  :nielsen_configuration,
  :nielsen_non_linear_watermark,
  :output_groups,
  :timecode_config,
  :timed_metadata_insertion)
  SENSITIVE = []
  include Aws::Structure
end

#output_groups ⇒ Array<Types::OutputGroup>

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:

• (Array<Types::OutputGroup>)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8312

class JobTemplateSettings < Struct.new(
  :ad_avail_offset,
  :avail_blanking,
  :color_conversion_3_dlut_settings,
  :esam,
  :extended_data_services,
  :follow_source,
  :inputs,
  :kantar_watermark,
  :motion_image_inserter,
  :nielsen_configuration,
  :nielsen_non_linear_watermark,
  :output_groups,
  :timecode_config,
  :timed_metadata_insertion)
  SENSITIVE = []
  include Aws::Structure
end

#timecode_config ⇒ Types::TimecodeConfig

These settings control how the service handles timecodes throughout the job. These settings don't affect input clipping.

Returns:

• (Types::TimecodeConfig)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8312

class JobTemplateSettings < Struct.new(
  :ad_avail_offset,
  :avail_blanking,
  :color_conversion_3_dlut_settings,
  :esam,
  :extended_data_services,
  :follow_source,
  :inputs,
  :kantar_watermark,
  :motion_image_inserter,
  :nielsen_configuration,
  :nielsen_non_linear_watermark,
  :output_groups,
  :timecode_config,
  :timed_metadata_insertion)
  SENSITIVE = []
  include Aws::Structure
end

#timed_metadata_insertion ⇒ Types::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:

• (Types::TimedMetadataInsertion)

# File 'gems/aws-sdk-mediaconvert/lib/aws-sdk-mediaconvert/types.rb', line 8312

class JobTemplateSettings < Struct.new(
  :ad_avail_offset,
  :avail_blanking,
  :color_conversion_3_dlut_settings,
  :esam,
  :extended_data_services,
  :follow_source,
  :inputs,
  :kantar_watermark,
  :motion_image_inserter,
  :nielsen_configuration,
  :nielsen_non_linear_watermark,
  :output_groups,
  :timecode_config,
  :timed_metadata_insertion)
  SENSITIVE = []
  include Aws::Structure
end