AWS SDK for C++  1.9.67
AWS SDK for C++
Public Member Functions | List of all members
Aws::MediaConvert::Model::JobSettings Class Reference

#include <JobSettings.h>

Public Member Functions

 JobSettings ()
 
 JobSettings (Aws::Utils::Json::JsonView jsonValue)
 
JobSettingsoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
int GetAdAvailOffset () const
 
bool AdAvailOffsetHasBeenSet () const
 
void SetAdAvailOffset (int value)
 
JobSettingsWithAdAvailOffset (int value)
 
const AvailBlankingGetAvailBlanking () const
 
bool AvailBlankingHasBeenSet () const
 
void SetAvailBlanking (const AvailBlanking &value)
 
void SetAvailBlanking (AvailBlanking &&value)
 
JobSettingsWithAvailBlanking (const AvailBlanking &value)
 
JobSettingsWithAvailBlanking (AvailBlanking &&value)
 
const EsamSettingsGetEsam () const
 
bool EsamHasBeenSet () const
 
void SetEsam (const EsamSettings &value)
 
void SetEsam (EsamSettings &&value)
 
JobSettingsWithEsam (const EsamSettings &value)
 
JobSettingsWithEsam (EsamSettings &&value)
 
const Aws::Vector< Input > & GetInputs () const
 
bool InputsHasBeenSet () const
 
void SetInputs (const Aws::Vector< Input > &value)
 
void SetInputs (Aws::Vector< Input > &&value)
 
JobSettingsWithInputs (const Aws::Vector< Input > &value)
 
JobSettingsWithInputs (Aws::Vector< Input > &&value)
 
JobSettingsAddInputs (const Input &value)
 
JobSettingsAddInputs (Input &&value)
 
const KantarWatermarkSettingsGetKantarWatermark () const
 
bool KantarWatermarkHasBeenSet () const
 
void SetKantarWatermark (const KantarWatermarkSettings &value)
 
void SetKantarWatermark (KantarWatermarkSettings &&value)
 
JobSettingsWithKantarWatermark (const KantarWatermarkSettings &value)
 
JobSettingsWithKantarWatermark (KantarWatermarkSettings &&value)
 
const MotionImageInserterGetMotionImageInserter () const
 
bool MotionImageInserterHasBeenSet () const
 
void SetMotionImageInserter (const MotionImageInserter &value)
 
void SetMotionImageInserter (MotionImageInserter &&value)
 
JobSettingsWithMotionImageInserter (const MotionImageInserter &value)
 
JobSettingsWithMotionImageInserter (MotionImageInserter &&value)
 
const NielsenConfigurationGetNielsenConfiguration () const
 
bool NielsenConfigurationHasBeenSet () const
 
void SetNielsenConfiguration (const NielsenConfiguration &value)
 
void SetNielsenConfiguration (NielsenConfiguration &&value)
 
JobSettingsWithNielsenConfiguration (const NielsenConfiguration &value)
 
JobSettingsWithNielsenConfiguration (NielsenConfiguration &&value)
 
const NielsenNonLinearWatermarkSettingsGetNielsenNonLinearWatermark () const
 
bool NielsenNonLinearWatermarkHasBeenSet () const
 
void SetNielsenNonLinearWatermark (const NielsenNonLinearWatermarkSettings &value)
 
void SetNielsenNonLinearWatermark (NielsenNonLinearWatermarkSettings &&value)
 
JobSettingsWithNielsenNonLinearWatermark (const NielsenNonLinearWatermarkSettings &value)
 
JobSettingsWithNielsenNonLinearWatermark (NielsenNonLinearWatermarkSettings &&value)
 
const Aws::Vector< OutputGroup > & GetOutputGroups () const
 
bool OutputGroupsHasBeenSet () const
 
void SetOutputGroups (const Aws::Vector< OutputGroup > &value)
 
void SetOutputGroups (Aws::Vector< OutputGroup > &&value)
 
JobSettingsWithOutputGroups (const Aws::Vector< OutputGroup > &value)
 
JobSettingsWithOutputGroups (Aws::Vector< OutputGroup > &&value)
 
JobSettingsAddOutputGroups (const OutputGroup &value)
 
JobSettingsAddOutputGroups (OutputGroup &&value)
 
const TimecodeConfigGetTimecodeConfig () const
 
bool TimecodeConfigHasBeenSet () const
 
void SetTimecodeConfig (const TimecodeConfig &value)
 
void SetTimecodeConfig (TimecodeConfig &&value)
 
JobSettingsWithTimecodeConfig (const TimecodeConfig &value)
 
JobSettingsWithTimecodeConfig (TimecodeConfig &&value)
 
const TimedMetadataInsertionGetTimedMetadataInsertion () const
 
bool TimedMetadataInsertionHasBeenSet () const
 
void SetTimedMetadataInsertion (const TimedMetadataInsertion &value)
 
void SetTimedMetadataInsertion (TimedMetadataInsertion &&value)
 
JobSettingsWithTimedMetadataInsertion (const TimedMetadataInsertion &value)
 
JobSettingsWithTimedMetadataInsertion (TimedMetadataInsertion &&value)
 

Detailed Description

JobSettings contains all the transcode settings for a job.

See Also:

AWS API Reference

Definition at line 42 of file JobSettings.h.

Constructor & Destructor Documentation

◆ JobSettings() [1/2]

Aws::MediaConvert::Model::JobSettings::JobSettings ( )

◆ JobSettings() [2/2]

Aws::MediaConvert::Model::JobSettings::JobSettings ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ AdAvailOffsetHasBeenSet()

bool Aws::MediaConvert::Model::JobSettings::AdAvailOffsetHasBeenSet ( ) const
inline

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

Definition at line 61 of file JobSettings.h.

◆ AddInputs() [1/2]

JobSettings& Aws::MediaConvert::Model::JobSettings::AddInputs ( const Input value)
inline

Use Inputs (inputs) to define source file used in the transcode job. There can be multiple inputs add in a job. These inputs will be concantenated together to create the output.

Definition at line 197 of file JobSettings.h.

◆ AddInputs() [2/2]

JobSettings& Aws::MediaConvert::Model::JobSettings::AddInputs ( Input &&  value)
inline

Use Inputs (inputs) to define source file used in the transcode job. There can be multiple inputs add in a job. These inputs will be concantenated together to create the output.

Definition at line 204 of file JobSettings.h.

◆ AddOutputGroups() [1/2]

JobSettings& Aws::MediaConvert::Model::JobSettings::AddOutputGroups ( const OutputGroup value)
inline

(OutputGroups) contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings

Definition at line 547 of file JobSettings.h.

◆ AddOutputGroups() [2/2]

JobSettings& Aws::MediaConvert::Model::JobSettings::AddOutputGroups ( OutputGroup &&  value)
inline

(OutputGroups) contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings

Definition at line 561 of file JobSettings.h.

◆ AvailBlankingHasBeenSet()

bool Aws::MediaConvert::Model::JobSettings::AvailBlankingHasBeenSet ( ) const
inline

Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails.

Definition at line 86 of file JobSettings.h.

◆ EsamHasBeenSet()

bool Aws::MediaConvert::Model::JobSettings::EsamHasBeenSet ( ) const
inline

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

Definition at line 123 of file JobSettings.h.

◆ GetAdAvailOffset()

int Aws::MediaConvert::Model::JobSettings::GetAdAvailOffset ( ) const
inline

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

Definition at line 55 of file JobSettings.h.

◆ GetAvailBlanking()

const AvailBlanking& Aws::MediaConvert::Model::JobSettings::GetAvailBlanking ( ) const
inline

Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails.

Definition at line 80 of file JobSettings.h.

◆ GetEsam()

const EsamSettings& Aws::MediaConvert::Model::JobSettings::GetEsam ( ) const
inline

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

Definition at line 117 of file JobSettings.h.

◆ GetInputs()

const Aws::Vector<Input>& Aws::MediaConvert::Model::JobSettings::GetInputs ( ) const
inline

Use Inputs (inputs) to define source file used in the transcode job. There can be multiple inputs add in a job. These inputs will be concantenated together to create the output.

Definition at line 155 of file JobSettings.h.

◆ GetKantarWatermark()

const KantarWatermarkSettings& Aws::MediaConvert::Model::JobSettings::GetKantarWatermark ( ) const
inline

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.

Definition at line 215 of file JobSettings.h.

◆ GetMotionImageInserter()

const MotionImageInserter& Aws::MediaConvert::Model::JobSettings::GetMotionImageInserter ( ) const
inline

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.

Definition at line 274 of file JobSettings.h.

◆ GetNielsenConfiguration()

const NielsenConfiguration& Aws::MediaConvert::Model::JobSettings::GetNielsenConfiguration ( ) const
inline

Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these settings. When you enable Nielsen configuration (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs in the job. To enable Nielsen configuration programmatically, include an instance of nielsenConfiguration in your JSON job specification. Even if you don't include any children of nielsenConfiguration, you still enable the setting.

Definition at line 326 of file JobSettings.h.

◆ GetNielsenNonLinearWatermark()

const NielsenNonLinearWatermarkSettings& Aws::MediaConvert::Model::JobSettings::GetNielsenNonLinearWatermark ( ) const
inline

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]

Definition at line 393 of file JobSettings.h.

◆ GetOutputGroups()

const Aws::Vector<OutputGroup>& Aws::MediaConvert::Model::JobSettings::GetOutputGroups ( ) const
inline

(OutputGroups) contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings

Definition at line 463 of file JobSettings.h.

◆ GetTimecodeConfig()

const TimecodeConfig& Aws::MediaConvert::Model::JobSettings::GetTimecodeConfig ( ) const
inline

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

Definition at line 568 of file JobSettings.h.

◆ GetTimedMetadataInsertion()

const TimedMetadataInsertion& Aws::MediaConvert::Model::JobSettings::GetTimedMetadataInsertion ( ) const
inline

Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in any HLS outputs. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects.

Definition at line 607 of file JobSettings.h.

◆ InputsHasBeenSet()

bool Aws::MediaConvert::Model::JobSettings::InputsHasBeenSet ( ) const
inline

Use Inputs (inputs) to define source file used in the transcode job. There can be multiple inputs add in a job. These inputs will be concantenated together to create the output.

Definition at line 162 of file JobSettings.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::MediaConvert::Model::JobSettings::Jsonize ( ) const

◆ KantarWatermarkHasBeenSet()

bool Aws::MediaConvert::Model::JobSettings::KantarWatermarkHasBeenSet ( ) const
inline

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.

Definition at line 225 of file JobSettings.h.

◆ MotionImageInserterHasBeenSet()

bool Aws::MediaConvert::Model::JobSettings::MotionImageInserterHasBeenSet ( ) const
inline

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.

Definition at line 282 of file JobSettings.h.

◆ NielsenConfigurationHasBeenSet()

bool Aws::MediaConvert::Model::JobSettings::NielsenConfigurationHasBeenSet ( ) const
inline

Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these settings. When you enable Nielsen configuration (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs in the job. To enable Nielsen configuration programmatically, include an instance of nielsenConfiguration in your JSON job specification. Even if you don't include any children of nielsenConfiguration, you still enable the setting.

Definition at line 337 of file JobSettings.h.

◆ NielsenNonLinearWatermarkHasBeenSet()

bool Aws::MediaConvert::Model::JobSettings::NielsenNonLinearWatermarkHasBeenSet ( ) const
inline

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]

Definition at line 404 of file JobSettings.h.

◆ operator=()

JobSettings& Aws::MediaConvert::Model::JobSettings::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ OutputGroupsHasBeenSet()

bool Aws::MediaConvert::Model::JobSettings::OutputGroupsHasBeenSet ( ) const
inline

(OutputGroups) contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings

Definition at line 477 of file JobSettings.h.

◆ SetAdAvailOffset()

void Aws::MediaConvert::Model::JobSettings::SetAdAvailOffset ( int  value)
inline

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

Definition at line 67 of file JobSettings.h.

◆ SetAvailBlanking() [1/2]

void Aws::MediaConvert::Model::JobSettings::SetAvailBlanking ( AvailBlanking &&  value)
inline

Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails.

Definition at line 98 of file JobSettings.h.

◆ SetAvailBlanking() [2/2]

void Aws::MediaConvert::Model::JobSettings::SetAvailBlanking ( const AvailBlanking value)
inline

Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails.

Definition at line 92 of file JobSettings.h.

◆ SetEsam() [1/2]

void Aws::MediaConvert::Model::JobSettings::SetEsam ( const EsamSettings value)
inline

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

Definition at line 129 of file JobSettings.h.

◆ SetEsam() [2/2]

void Aws::MediaConvert::Model::JobSettings::SetEsam ( EsamSettings &&  value)
inline

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

Definition at line 135 of file JobSettings.h.

◆ SetInputs() [1/2]

void Aws::MediaConvert::Model::JobSettings::SetInputs ( Aws::Vector< Input > &&  value)
inline

Use Inputs (inputs) to define source file used in the transcode job. There can be multiple inputs add in a job. These inputs will be concantenated together to create the output.

Definition at line 176 of file JobSettings.h.

◆ SetInputs() [2/2]

void Aws::MediaConvert::Model::JobSettings::SetInputs ( const Aws::Vector< Input > &  value)
inline

Use Inputs (inputs) to define source file used in the transcode job. There can be multiple inputs add in a job. These inputs will be concantenated together to create the output.

Definition at line 169 of file JobSettings.h.

◆ SetKantarWatermark() [1/2]

void Aws::MediaConvert::Model::JobSettings::SetKantarWatermark ( const KantarWatermarkSettings value)
inline

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.

Definition at line 235 of file JobSettings.h.

◆ SetKantarWatermark() [2/2]

void Aws::MediaConvert::Model::JobSettings::SetKantarWatermark ( KantarWatermarkSettings &&  value)
inline

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.

Definition at line 245 of file JobSettings.h.

◆ SetMotionImageInserter() [1/2]

void Aws::MediaConvert::Model::JobSettings::SetMotionImageInserter ( const MotionImageInserter value)
inline

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.

Definition at line 290 of file JobSettings.h.

◆ SetMotionImageInserter() [2/2]

void Aws::MediaConvert::Model::JobSettings::SetMotionImageInserter ( MotionImageInserter &&  value)
inline

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.

Definition at line 298 of file JobSettings.h.

◆ SetNielsenConfiguration() [1/2]

void Aws::MediaConvert::Model::JobSettings::SetNielsenConfiguration ( const NielsenConfiguration value)
inline

Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these settings. When you enable Nielsen configuration (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs in the job. To enable Nielsen configuration programmatically, include an instance of nielsenConfiguration in your JSON job specification. Even if you don't include any children of nielsenConfiguration, you still enable the setting.

Definition at line 348 of file JobSettings.h.

◆ SetNielsenConfiguration() [2/2]

void Aws::MediaConvert::Model::JobSettings::SetNielsenConfiguration ( NielsenConfiguration &&  value)
inline

Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these settings. When you enable Nielsen configuration (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs in the job. To enable Nielsen configuration programmatically, include an instance of nielsenConfiguration in your JSON job specification. Even if you don't include any children of nielsenConfiguration, you still enable the setting.

Definition at line 359 of file JobSettings.h.

◆ SetNielsenNonLinearWatermark() [1/2]

void Aws::MediaConvert::Model::JobSettings::SetNielsenNonLinearWatermark ( const NielsenNonLinearWatermarkSettings value)
inline

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]

Definition at line 415 of file JobSettings.h.

◆ SetNielsenNonLinearWatermark() [2/2]

void Aws::MediaConvert::Model::JobSettings::SetNielsenNonLinearWatermark ( NielsenNonLinearWatermarkSettings &&  value)
inline

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]

Definition at line 426 of file JobSettings.h.

◆ SetOutputGroups() [1/2]

void Aws::MediaConvert::Model::JobSettings::SetOutputGroups ( Aws::Vector< OutputGroup > &&  value)
inline

(OutputGroups) contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings

Definition at line 505 of file JobSettings.h.

◆ SetOutputGroups() [2/2]

void Aws::MediaConvert::Model::JobSettings::SetOutputGroups ( const Aws::Vector< OutputGroup > &  value)
inline

(OutputGroups) contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings

Definition at line 491 of file JobSettings.h.

◆ SetTimecodeConfig() [1/2]

void Aws::MediaConvert::Model::JobSettings::SetTimecodeConfig ( const TimecodeConfig value)
inline

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

Definition at line 580 of file JobSettings.h.

◆ SetTimecodeConfig() [2/2]

void Aws::MediaConvert::Model::JobSettings::SetTimecodeConfig ( TimecodeConfig &&  value)
inline

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

Definition at line 586 of file JobSettings.h.

◆ SetTimedMetadataInsertion() [1/2]

void Aws::MediaConvert::Model::JobSettings::SetTimedMetadataInsertion ( const TimedMetadataInsertion value)
inline

Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in any HLS outputs. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects.

Definition at line 623 of file JobSettings.h.

◆ SetTimedMetadataInsertion() [2/2]

void Aws::MediaConvert::Model::JobSettings::SetTimedMetadataInsertion ( TimedMetadataInsertion &&  value)
inline

Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in any HLS outputs. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects.

Definition at line 631 of file JobSettings.h.

◆ TimecodeConfigHasBeenSet()

bool Aws::MediaConvert::Model::JobSettings::TimecodeConfigHasBeenSet ( ) const
inline

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

Definition at line 574 of file JobSettings.h.

◆ TimedMetadataInsertionHasBeenSet()

bool Aws::MediaConvert::Model::JobSettings::TimedMetadataInsertionHasBeenSet ( ) const
inline

Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in any HLS outputs. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects.

Definition at line 615 of file JobSettings.h.

◆ WithAdAvailOffset()

JobSettings& Aws::MediaConvert::Model::JobSettings::WithAdAvailOffset ( int  value)
inline

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

Definition at line 73 of file JobSettings.h.

◆ WithAvailBlanking() [1/2]

JobSettings& Aws::MediaConvert::Model::JobSettings::WithAvailBlanking ( AvailBlanking &&  value)
inline

Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails.

Definition at line 110 of file JobSettings.h.

◆ WithAvailBlanking() [2/2]

JobSettings& Aws::MediaConvert::Model::JobSettings::WithAvailBlanking ( const AvailBlanking value)
inline

Settings for ad avail blanking. Video can be blanked or overlaid with an image, and audio muted during SCTE-35 triggered ad avails.

Definition at line 104 of file JobSettings.h.

◆ WithEsam() [1/2]

JobSettings& Aws::MediaConvert::Model::JobSettings::WithEsam ( const EsamSettings value)
inline

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

Definition at line 141 of file JobSettings.h.

◆ WithEsam() [2/2]

JobSettings& Aws::MediaConvert::Model::JobSettings::WithEsam ( EsamSettings &&  value)
inline

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

Definition at line 147 of file JobSettings.h.

◆ WithInputs() [1/2]

JobSettings& Aws::MediaConvert::Model::JobSettings::WithInputs ( Aws::Vector< Input > &&  value)
inline

Use Inputs (inputs) to define source file used in the transcode job. There can be multiple inputs add in a job. These inputs will be concantenated together to create the output.

Definition at line 190 of file JobSettings.h.

◆ WithInputs() [2/2]

JobSettings& Aws::MediaConvert::Model::JobSettings::WithInputs ( const Aws::Vector< Input > &  value)
inline

Use Inputs (inputs) to define source file used in the transcode job. There can be multiple inputs add in a job. These inputs will be concantenated together to create the output.

Definition at line 183 of file JobSettings.h.

◆ WithKantarWatermark() [1/2]

JobSettings& Aws::MediaConvert::Model::JobSettings::WithKantarWatermark ( const KantarWatermarkSettings value)
inline

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.

Definition at line 255 of file JobSettings.h.

◆ WithKantarWatermark() [2/2]

JobSettings& Aws::MediaConvert::Model::JobSettings::WithKantarWatermark ( KantarWatermarkSettings &&  value)
inline

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.

Definition at line 265 of file JobSettings.h.

◆ WithMotionImageInserter() [1/2]

JobSettings& Aws::MediaConvert::Model::JobSettings::WithMotionImageInserter ( const MotionImageInserter value)
inline

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.

Definition at line 306 of file JobSettings.h.

◆ WithMotionImageInserter() [2/2]

JobSettings& Aws::MediaConvert::Model::JobSettings::WithMotionImageInserter ( MotionImageInserter &&  value)
inline

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.

Definition at line 314 of file JobSettings.h.

◆ WithNielsenConfiguration() [1/2]

JobSettings& Aws::MediaConvert::Model::JobSettings::WithNielsenConfiguration ( const NielsenConfiguration value)
inline

Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these settings. When you enable Nielsen configuration (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs in the job. To enable Nielsen configuration programmatically, include an instance of nielsenConfiguration in your JSON job specification. Even if you don't include any children of nielsenConfiguration, you still enable the setting.

Definition at line 370 of file JobSettings.h.

◆ WithNielsenConfiguration() [2/2]

JobSettings& Aws::MediaConvert::Model::JobSettings::WithNielsenConfiguration ( NielsenConfiguration &&  value)
inline

Settings for your Nielsen configuration. If you don't do Nielsen measurement and analytics, ignore these settings. When you enable Nielsen configuration (nielsenConfiguration), MediaConvert enables PCM to ID3 tagging for all outputs in the job. To enable Nielsen configuration programmatically, include an instance of nielsenConfiguration in your JSON job specification. Even if you don't include any children of nielsenConfiguration, you still enable the setting.

Definition at line 381 of file JobSettings.h.

◆ WithNielsenNonLinearWatermark() [1/2]

JobSettings& Aws::MediaConvert::Model::JobSettings::WithNielsenNonLinearWatermark ( const NielsenNonLinearWatermarkSettings value)
inline

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]

Definition at line 437 of file JobSettings.h.

◆ WithNielsenNonLinearWatermark() [2/2]

JobSettings& Aws::MediaConvert::Model::JobSettings::WithNielsenNonLinearWatermark ( NielsenNonLinearWatermarkSettings &&  value)
inline

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]

Definition at line 448 of file JobSettings.h.

◆ WithOutputGroups() [1/2]

JobSettings& Aws::MediaConvert::Model::JobSettings::WithOutputGroups ( Aws::Vector< OutputGroup > &&  value)
inline

(OutputGroups) contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings

Definition at line 533 of file JobSettings.h.

◆ WithOutputGroups() [2/2]

JobSettings& Aws::MediaConvert::Model::JobSettings::WithOutputGroups ( const Aws::Vector< OutputGroup > &  value)
inline

(OutputGroups) contains one group of settings for each set of outputs that share a common package type. All unpackaged files (MPEG-4, MPEG-2 TS, Quicktime, MXF, and no container) are grouped in a single output group as well. Required in (OutputGroups) is a group of settings that apply to the whole group. This required object depends on the value you set for (Type) under (OutputGroups)>(OutputGroupSettings). Type, settings object pairs are as follows. * FILE_GROUP_SETTINGS, FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, CmafGroupSettings

Definition at line 519 of file JobSettings.h.

◆ WithTimecodeConfig() [1/2]

JobSettings& Aws::MediaConvert::Model::JobSettings::WithTimecodeConfig ( const TimecodeConfig value)
inline

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

Definition at line 592 of file JobSettings.h.

◆ WithTimecodeConfig() [2/2]

JobSettings& Aws::MediaConvert::Model::JobSettings::WithTimecodeConfig ( TimecodeConfig &&  value)
inline

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

Definition at line 598 of file JobSettings.h.

◆ WithTimedMetadataInsertion() [1/2]

JobSettings& Aws::MediaConvert::Model::JobSettings::WithTimedMetadataInsertion ( const TimedMetadataInsertion value)
inline

Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in any HLS outputs. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects.

Definition at line 639 of file JobSettings.h.

◆ WithTimedMetadataInsertion() [2/2]

JobSettings& Aws::MediaConvert::Model::JobSettings::WithTimedMetadataInsertion ( TimedMetadataInsertion &&  value)
inline

Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 tags in any HLS outputs. To include timed metadata, you must enable it here, enable it in each output container, and specify tags and timecodes in ID3 insertion (Id3Insertion) objects.

Definition at line 647 of file JobSettings.h.


The documentation for this class was generated from the following file: