Struct aws_sdk_mediaconvert::types::JobTemplateSettings
source · #[non_exhaustive]pub struct JobTemplateSettings {Show 14 fields
pub ad_avail_offset: Option<i32>,
pub avail_blanking: Option<AvailBlanking>,
pub color_conversion3_dlut_settings: Option<Vec<ColorConversion3DlutSetting>>,
pub esam: Option<EsamSettings>,
pub extended_data_services: Option<ExtendedDataServices>,
pub follow_source: Option<i32>,
pub inputs: Option<Vec<InputTemplate>>,
pub kantar_watermark: Option<KantarWatermarkSettings>,
pub motion_image_inserter: Option<MotionImageInserter>,
pub nielsen_configuration: Option<NielsenConfiguration>,
pub nielsen_non_linear_watermark: Option<NielsenNonLinearWatermarkSettings>,
pub output_groups: Option<Vec<OutputGroup>>,
pub timecode_config: Option<TimecodeConfig>,
pub timed_metadata_insertion: Option<TimedMetadataInsertion>,
}
Expand description
JobTemplateSettings contains all the transcode settings saved in the template that will be applied to jobs created from it.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.ad_avail_offset: Option<i32>
When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.
avail_blanking: Option<AvailBlanking>
Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails.
color_conversion3_dlut_settings: Option<Vec<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
esam: Option<EsamSettings>
Settings for Event Signaling And Messaging (ESAM). If you don’t do ad insertion, you can ignore these settings.
extended_data_services: Option<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.
follow_source: Option<i32>
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.
inputs: Option<Vec<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.
kantar_watermark: Option<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.
motion_image_inserter: Option<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.
nielsen_configuration: Option<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.
nielsen_non_linear_watermark: Option<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]
output_groups: Option<Vec<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
timecode_config: Option<TimecodeConfig>
These settings control how the service handles timecodes throughout the job. These settings don’t affect input clipping.
timed_metadata_insertion: Option<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.
Implementations§
source§impl JobTemplateSettings
impl JobTemplateSettings
sourcepub fn ad_avail_offset(&self) -> Option<i32>
pub fn ad_avail_offset(&self) -> Option<i32>
When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time.
sourcepub fn avail_blanking(&self) -> Option<&AvailBlanking>
pub fn avail_blanking(&self) -> Option<&AvailBlanking>
Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails.
sourcepub fn color_conversion3_dlut_settings(&self) -> &[ColorConversion3DlutSetting]
pub fn color_conversion3_dlut_settings(&self) -> &[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
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .color_conversion3_dlut_settings.is_none()
.
sourcepub fn esam(&self) -> Option<&EsamSettings>
pub fn esam(&self) -> Option<&EsamSettings>
Settings for Event Signaling And Messaging (ESAM). If you don’t do ad insertion, you can ignore these settings.
sourcepub fn extended_data_services(&self) -> Option<&ExtendedDataServices>
pub fn extended_data_services(&self) -> Option<&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.
sourcepub fn follow_source(&self) -> Option<i32>
pub fn follow_source(&self) -> Option<i32>
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.
sourcepub fn inputs(&self) -> &[InputTemplate]
pub fn inputs(&self) -> &[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.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .inputs.is_none()
.
sourcepub fn kantar_watermark(&self) -> Option<&KantarWatermarkSettings>
pub fn kantar_watermark(&self) -> Option<&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.
sourcepub fn motion_image_inserter(&self) -> Option<&MotionImageInserter>
pub fn motion_image_inserter(&self) -> Option<&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.
sourcepub fn nielsen_configuration(&self) -> Option<&NielsenConfiguration>
pub fn nielsen_configuration(&self) -> Option<&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.
sourcepub fn nielsen_non_linear_watermark(
&self
) -> Option<&NielsenNonLinearWatermarkSettings>
pub fn nielsen_non_linear_watermark( &self ) -> Option<&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]
sourcepub fn output_groups(&self) -> &[OutputGroup]
pub fn output_groups(&self) -> &[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
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .output_groups.is_none()
.
sourcepub fn timecode_config(&self) -> Option<&TimecodeConfig>
pub fn timecode_config(&self) -> Option<&TimecodeConfig>
These settings control how the service handles timecodes throughout the job. These settings don’t affect input clipping.
sourcepub fn timed_metadata_insertion(&self) -> Option<&TimedMetadataInsertion>
pub fn timed_metadata_insertion(&self) -> Option<&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.
source§impl JobTemplateSettings
impl JobTemplateSettings
sourcepub fn builder() -> JobTemplateSettingsBuilder
pub fn builder() -> JobTemplateSettingsBuilder
Creates a new builder-style object to manufacture JobTemplateSettings
.
Trait Implementations§
source§impl Clone for JobTemplateSettings
impl Clone for JobTemplateSettings
source§fn clone(&self) -> JobTemplateSettings
fn clone(&self) -> JobTemplateSettings
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for JobTemplateSettings
impl Debug for JobTemplateSettings
source§impl PartialEq for JobTemplateSettings
impl PartialEq for JobTemplateSettings
source§fn eq(&self, other: &JobTemplateSettings) -> bool
fn eq(&self, other: &JobTemplateSettings) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for JobTemplateSettings
Auto Trait Implementations§
impl Freeze for JobTemplateSettings
impl RefUnwindSafe for JobTemplateSettings
impl Send for JobTemplateSettings
impl Sync for JobTemplateSettings
impl Unpin for JobTemplateSettings
impl UnwindSafe for JobTemplateSettings
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more