« blib/lib/Paws/MediaConvert/JobTemplate.pm
↑ Summary
blib/lib/Paws/MediaConvert/KantarWatermarkSettings.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MediaConvert::JobTemplateSettings; | ||
| 3 | use Moose; | ||
| 4 | has AdAvailOffset => (is => 'ro', isa => 'Int', request_name => 'adAvailOffset', traits => ['NameInRequest']); | ||
| 5 | has AvailBlanking => (is => 'ro', isa => 'Paws::MediaConvert::AvailBlanking', request_name => 'availBlanking', traits => ['NameInRequest']); | ||
| 6 | has Esam => (is => 'ro', isa => 'Paws::MediaConvert::EsamSettings', request_name => 'esam', traits => ['NameInRequest']); | ||
| 7 | has Inputs => (is => 'ro', isa => 'ArrayRef[Paws::MediaConvert::InputTemplate]', request_name => 'inputs', traits => ['NameInRequest']); | ||
| 8 | has KantarWatermark => (is => 'ro', isa => 'Paws::MediaConvert::KantarWatermarkSettings', request_name => 'kantarWatermark', traits => ['NameInRequest']); | ||
| 9 | has MotionImageInserter => (is => 'ro', isa => 'Paws::MediaConvert::MotionImageInserter', request_name => 'motionImageInserter', traits => ['NameInRequest']); | ||
| 10 | has NielsenConfiguration => (is => 'ro', isa => 'Paws::MediaConvert::NielsenConfiguration', request_name => 'nielsenConfiguration', traits => ['NameInRequest']); | ||
| 11 | has NielsenNonLinearWatermark => (is => 'ro', isa => 'Paws::MediaConvert::NielsenNonLinearWatermarkSettings', request_name => 'nielsenNonLinearWatermark', traits => ['NameInRequest']); | ||
| 12 | has OutputGroups => (is => 'ro', isa => 'ArrayRef[Paws::MediaConvert::OutputGroup]', request_name => 'outputGroups', traits => ['NameInRequest']); | ||
| 13 | has TimecodeConfig => (is => 'ro', isa => 'Paws::MediaConvert::TimecodeConfig', request_name => 'timecodeConfig', traits => ['NameInRequest']); | ||
| 14 | has TimedMetadataInsertion => (is => 'ro', isa => 'Paws::MediaConvert::TimedMetadataInsertion', request_name => 'timedMetadataInsertion', traits => ['NameInRequest']); | ||
| 15 | |||
| 16 | 1; | ||
| 17 | |||
| 18 | ### main pod documentation begin ### | ||
| 19 | |||
| 20 | =head1 NAME | ||
| 21 | |||
| 22 | Paws::MediaConvert::JobTemplateSettings | ||
| 23 | |||
| 24 | =head1 USAGE | ||
| 25 | |||
| 26 | This class represents one of two things: | ||
| 27 | |||
| 28 | =head3 Arguments in a call to a service | ||
| 29 | |||
| 30 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 31 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 32 | |||
| 33 | As an example, if Att1 is expected to be a Paws::MediaConvert::JobTemplateSettings object: | ||
| 34 | |||
| 35 | $service_obj->Method(Att1 => { AdAvailOffset => $value, ..., TimedMetadataInsertion => $value }); | ||
| 36 | |||
| 37 | =head3 Results returned from an API call | ||
| 38 | |||
| 39 | Use accessors for each attribute. If Att1 is expected to be an Paws::MediaConvert::JobTemplateSettings object: | ||
| 40 | |||
| 41 | $result = $service_obj->Method(...); | ||
| 42 | $result->Att1->AdAvailOffset | ||
| 43 | |||
| 44 | =head1 DESCRIPTION | ||
| 45 | |||
| 46 | JobTemplateSettings contains all the transcode settings saved in the | ||
| 47 | template that will be applied to jobs created from it. | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 AdAvailOffset => Int | ||
| 53 | |||
| 54 | When specified, this offset (in milliseconds) is added to the input Ad | ||
| 55 | Avail PTS time. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 AvailBlanking => L<Paws::MediaConvert::AvailBlanking> | ||
| 59 | |||
| 60 | Settings for ad avail blanking. Video can be blanked or overlaid with | ||
| 61 | an image, and audio muted during SCTE-35 triggered ad avails. | ||
| 62 | |||
| 63 | |||
| 64 | =head2 Esam => L<Paws::MediaConvert::EsamSettings> | ||
| 65 | |||
| 66 | Settings for Event Signaling And Messaging (ESAM). If you don't do ad | ||
| 67 | insertion, you can ignore these settings. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 Inputs => ArrayRef[L<Paws::MediaConvert::InputTemplate>] | ||
| 71 | |||
| 72 | Use Inputs (inputs) to define the source file used in the transcode | ||
| 73 | job. There can only be one input in a job template. Using the API, you | ||
| 74 | can include multiple inputs when referencing a job template. | ||
| 75 | |||
| 76 | |||
| 77 | =head2 KantarWatermark => L<Paws::MediaConvert::KantarWatermarkSettings> | ||
| 78 | |||
| 79 | Use these settings only when you use Kantar watermarking. Specify the | ||
| 80 | values that MediaConvert uses to generate and place Kantar watermarks | ||
| 81 | in your output audio. These settings apply to every output in your job. | ||
| 82 | In addition to specifying these values, you also need to store your | ||
| 83 | Kantar credentials in AWS Secrets Manager. For more information, see | ||
| 84 | https://docs.aws.amazon.com/mediaconvert/latest/ug/kantar-watermarking.html. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 MotionImageInserter => L<Paws::MediaConvert::MotionImageInserter> | ||
| 88 | |||
| 89 | Overlay motion graphics on top of your video. The motion graphics that | ||
| 90 | you specify here appear on all outputs in all output groups. For more | ||
| 91 | information, see | ||
| 92 | https://docs.aws.amazon.com/mediaconvert/latest/ug/motion-graphic-overlay.html. | ||
| 93 | |||
| 94 | |||
| 95 | =head2 NielsenConfiguration => L<Paws::MediaConvert::NielsenConfiguration> | ||
| 96 | |||
| 97 | Settings for your Nielsen configuration. If you don't do Nielsen | ||
| 98 | measurement and analytics, ignore these settings. When you enable | ||
| 99 | Nielsen configuration (nielsenConfiguration), MediaConvert enables PCM | ||
| 100 | to ID3 tagging for all outputs in the job. To enable Nielsen | ||
| 101 | configuration programmatically, include an instance of | ||
| 102 | nielsenConfiguration in your JSON job specification. Even if you don't | ||
| 103 | include any children of nielsenConfiguration, you still enable the | ||
| 104 | setting. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 NielsenNonLinearWatermark => L<Paws::MediaConvert::NielsenNonLinearWatermarkSettings> | ||
| 108 | |||
| 109 | Ignore these settings unless you are using Nielsen non-linear | ||
| 110 | watermarking. Specify the values that MediaConvert uses to generate and | ||
| 111 | place Nielsen watermarks in your output audio. In addition to | ||
| 112 | specifying these values, you also need to set up your cloud TIC server. | ||
| 113 | These settings apply to every output in your job. The MediaConvert | ||
| 114 | implementation is currently with the following Nielsen versions: | ||
| 115 | Nielsen Watermark SDK Version 5.2.1 Nielsen NLM Watermark Engine | ||
| 116 | Version 1.2.7 Nielsen Watermark Authenticator [SID_TIC] Version [5.0.0] | ||
| 117 | |||
| 118 | |||
| 119 | =head2 OutputGroups => ArrayRef[L<Paws::MediaConvert::OutputGroup>] | ||
| 120 | |||
| 121 | (OutputGroups) contains one group of settings for each set of outputs | ||
| 122 | that share a common package type. All unpackaged files (MPEG-4, MPEG-2 | ||
| 123 | TS, Quicktime, MXF, and no container) are grouped in a single output | ||
| 124 | group as well. Required in (OutputGroups) is a group of settings that | ||
| 125 | apply to the whole group. This required object depends on the value you | ||
| 126 | set for (Type) under (OutputGroups)E<gt>(OutputGroupSettings). Type, | ||
| 127 | settings object pairs are as follows. * FILE_GROUP_SETTINGS, | ||
| 128 | FileGroupSettings * HLS_GROUP_SETTINGS, HlsGroupSettings * | ||
| 129 | DASH_ISO_GROUP_SETTINGS, DashIsoGroupSettings * | ||
| 130 | MS_SMOOTH_GROUP_SETTINGS, MsSmoothGroupSettings * CMAF_GROUP_SETTINGS, | ||
| 131 | CmafGroupSettings | ||
| 132 | |||
| 133 | |||
| 134 | =head2 TimecodeConfig => L<Paws::MediaConvert::TimecodeConfig> | ||
| 135 | |||
| 136 | These settings control how the service handles timecodes throughout the | ||
| 137 | job. These settings don't affect input clipping. | ||
| 138 | |||
| 139 | |||
| 140 | =head2 TimedMetadataInsertion => L<Paws::MediaConvert::TimedMetadataInsertion> | ||
| 141 | |||
| 142 | Enable Timed metadata insertion (TimedMetadataInsertion) to include ID3 | ||
| 143 | tags in any HLS outputs. To include timed metadata, you must enable it | ||
| 144 | here, enable it in each output container, and specify tags and | ||
| 145 | timecodes in ID3 insertion (Id3Insertion) objects. | ||
| 146 | |||
| 147 | |||
| 148 | |||
| 149 | =head1 SEE ALSO | ||
| 150 | |||
| 151 | This class forms part of L<Paws>, describing an object used in L<Paws::MediaConvert> | ||
| 152 | |||
| 153 | =head1 BUGS and CONTRIBUTIONS | ||
| 154 | |||
| 155 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 156 | |||
| 157 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 158 | |||
| 159 | =cut | ||
| 160 |