« blib/lib/Paws/MediaConvert/VideoCodecSettings.pm
↑ Summary
blib/lib/Paws/MediaConvert/VideoDetail.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MediaConvert::VideoDescription; | ||
| 3 | use Moose; | ||
| 4 | has AfdSignaling => (is => 'ro', isa => 'Str', request_name => 'afdSignaling', traits => ['NameInRequest']); | ||
| 5 | has AntiAlias => (is => 'ro', isa => 'Str', request_name => 'antiAlias', traits => ['NameInRequest']); | ||
| 6 | has CodecSettings => (is => 'ro', isa => 'Paws::MediaConvert::VideoCodecSettings', request_name => 'codecSettings', traits => ['NameInRequest']); | ||
| 7 | has ColorMetadata => (is => 'ro', isa => 'Str', request_name => 'colorMetadata', traits => ['NameInRequest']); | ||
| 8 | has Crop => (is => 'ro', isa => 'Paws::MediaConvert::Rectangle', request_name => 'crop', traits => ['NameInRequest']); | ||
| 9 | has DropFrameTimecode => (is => 'ro', isa => 'Str', request_name => 'dropFrameTimecode', traits => ['NameInRequest']); | ||
| 10 | has FixedAfd => (is => 'ro', isa => 'Int', request_name => 'fixedAfd', traits => ['NameInRequest']); | ||
| 11 | has Height => (is => 'ro', isa => 'Int', request_name => 'height', traits => ['NameInRequest']); | ||
| 12 | has Position => (is => 'ro', isa => 'Paws::MediaConvert::Rectangle', request_name => 'position', traits => ['NameInRequest']); | ||
| 13 | has RespondToAfd => (is => 'ro', isa => 'Str', request_name => 'respondToAfd', traits => ['NameInRequest']); | ||
| 14 | has ScalingBehavior => (is => 'ro', isa => 'Str', request_name => 'scalingBehavior', traits => ['NameInRequest']); | ||
| 15 | has Sharpness => (is => 'ro', isa => 'Int', request_name => 'sharpness', traits => ['NameInRequest']); | ||
| 16 | has TimecodeInsertion => (is => 'ro', isa => 'Str', request_name => 'timecodeInsertion', traits => ['NameInRequest']); | ||
| 17 | has VideoPreprocessors => (is => 'ro', isa => 'Paws::MediaConvert::VideoPreprocessor', request_name => 'videoPreprocessors', traits => ['NameInRequest']); | ||
| 18 | has Width => (is => 'ro', isa => 'Int', request_name => 'width', traits => ['NameInRequest']); | ||
| 19 | |||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::MediaConvert::VideoDescription | ||
| 27 | |||
| 28 | =head1 USAGE | ||
| 29 | |||
| 30 | This class represents one of two things: | ||
| 31 | |||
| 32 | =head3 Arguments in a call to a service | ||
| 33 | |||
| 34 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 35 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 36 | |||
| 37 | As an example, if Att1 is expected to be a Paws::MediaConvert::VideoDescription object: | ||
| 38 | |||
| 39 | $service_obj->Method(Att1 => { AfdSignaling => $value, ..., Width => $value }); | ||
| 40 | |||
| 41 | =head3 Results returned from an API call | ||
| 42 | |||
| 43 | Use accessors for each attribute. If Att1 is expected to be an Paws::MediaConvert::VideoDescription object: | ||
| 44 | |||
| 45 | $result = $service_obj->Method(...); | ||
| 46 | $result->Att1->AfdSignaling | ||
| 47 | |||
| 48 | =head1 DESCRIPTION | ||
| 49 | |||
| 50 | Settings related to video encoding of your output. The specific video | ||
| 51 | settings depend on the video codec that you choose. When you work | ||
| 52 | directly in your JSON job specification, include one instance of Video | ||
| 53 | description (VideoDescription) per output. | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 AfdSignaling => Str | ||
| 59 | |||
| 60 | This setting only applies to H.264, H.265, and MPEG2 outputs. Use | ||
| 61 | Insert AFD signaling (AfdSignaling) to specify whether the service | ||
| 62 | includes AFD values in the output video data and what those values are. | ||
| 63 | * Choose None to remove all AFD values from this output. * Choose Fixed | ||
| 64 | to ignore input AFD values and instead encode the value specified in | ||
| 65 | the job. * Choose Auto to calculate output AFD values based on the | ||
| 66 | input AFD scaler data. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 AntiAlias => Str | ||
| 70 | |||
| 71 | The anti-alias filter is automatically applied to all outputs. The | ||
| 72 | service no longer accepts the value DISABLED for AntiAlias. If you | ||
| 73 | specify that in your job, the service will ignore the setting. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 CodecSettings => L<Paws::MediaConvert::VideoCodecSettings> | ||
| 77 | |||
| 78 | Video codec settings, (CodecSettings) under (VideoDescription), | ||
| 79 | contains the group of settings related to video encoding. The settings | ||
| 80 | in this group vary depending on the value that you choose for Video | ||
| 81 | codec (Codec). For each codec enum that you choose, define the | ||
| 82 | corresponding settings object. The following lists the codec enum, | ||
| 83 | settings object pairs. * AV1, Av1Settings * AVC_INTRA, AvcIntraSettings | ||
| 84 | * FRAME_CAPTURE, FrameCaptureSettings * H_264, H264Settings * H_265, | ||
| 85 | H265Settings * MPEG2, Mpeg2Settings * PRORES, ProresSettings * VC3, | ||
| 86 | Vc3Settings * VP8, Vp8Settings * VP9, Vp9Settings * XAVC, XavcSettings | ||
| 87 | |||
| 88 | |||
| 89 | =head2 ColorMetadata => Str | ||
| 90 | |||
| 91 | Choose Insert (INSERT) for this setting to include color metadata in | ||
| 92 | this output. Choose Ignore (IGNORE) to exclude color metadata from this | ||
| 93 | output. If you don't specify a value, the service sets this to Insert | ||
| 94 | by default. | ||
| 95 | |||
| 96 | |||
| 97 | =head2 Crop => L<Paws::MediaConvert::Rectangle> | ||
| 98 | |||
| 99 | Use Cropping selection (crop) to specify the video area that the | ||
| 100 | service will include in the output video frame. | ||
| 101 | |||
| 102 | |||
| 103 | =head2 DropFrameTimecode => Str | ||
| 104 | |||
| 105 | Applies only to 29.97 fps outputs. When this feature is enabled, the | ||
| 106 | service will use drop-frame timecode on outputs. If it is not possible | ||
| 107 | to use drop-frame timecode, the system will fall back to | ||
| 108 | non-drop-frame. This setting is enabled by default when Timecode | ||
| 109 | insertion (TimecodeInsertion) is enabled. | ||
| 110 | |||
| 111 | |||
| 112 | =head2 FixedAfd => Int | ||
| 113 | |||
| 114 | Applies only if you set AFD Signaling(AfdSignaling) to Fixed (FIXED). | ||
| 115 | Use Fixed (FixedAfd) to specify a four-bit AFD value which the service | ||
| 116 | will write on all frames of this video output. | ||
| 117 | |||
| 118 | |||
| 119 | =head2 Height => Int | ||
| 120 | |||
| 121 | Use the Height (Height) setting to define the video resolution height | ||
| 122 | for this output. Specify in pixels. If you don't provide a value here, | ||
| 123 | the service will use the input height. | ||
| 124 | |||
| 125 | |||
| 126 | =head2 Position => L<Paws::MediaConvert::Rectangle> | ||
| 127 | |||
| 128 | Use Selection placement (position) to define the video area in your | ||
| 129 | output frame. The area outside of the rectangle that you specify here | ||
| 130 | is black. | ||
| 131 | |||
| 132 | |||
| 133 | =head2 RespondToAfd => Str | ||
| 134 | |||
| 135 | Use Respond to AFD (RespondToAfd) to specify how the service changes | ||
| 136 | the video itself in response to AFD values in the input. * Choose | ||
| 137 | Respond to clip the input video frame according to the AFD value, input | ||
| 138 | display aspect ratio, and output display aspect ratio. * Choose | ||
| 139 | Passthrough to include the input AFD values. Do not choose this when | ||
| 140 | AfdSignaling is set to (NONE). A preferred implementation of this | ||
| 141 | workflow is to set RespondToAfd to (NONE) and set AfdSignaling to | ||
| 142 | (AUTO). * Choose None to remove all input AFD values from this output. | ||
| 143 | |||
| 144 | |||
| 145 | =head2 ScalingBehavior => Str | ||
| 146 | |||
| 147 | Specify how the service handles outputs that have a different aspect | ||
| 148 | ratio from the input aspect ratio. Choose Stretch to output | ||
| 149 | (STRETCH_TO_OUTPUT) to have the service stretch your video image to | ||
| 150 | fit. Keep the setting Default (DEFAULT) to have the service letterbox | ||
| 151 | your video instead. This setting overrides any value that you specify | ||
| 152 | for the setting Selection placement (position) in this output. | ||
| 153 | |||
| 154 | |||
| 155 | =head2 Sharpness => Int | ||
| 156 | |||
| 157 | Use Sharpness (Sharpness) setting to specify the strength of | ||
| 158 | anti-aliasing. This setting changes the width of the anti-alias filter | ||
| 159 | kernel used for scaling. Sharpness only applies if your output | ||
| 160 | resolution is different from your input resolution. 0 is the softest | ||
| 161 | setting, 100 the sharpest, and 50 recommended for most content. | ||
| 162 | |||
| 163 | |||
| 164 | =head2 TimecodeInsertion => Str | ||
| 165 | |||
| 166 | Applies only to H.264, H.265, MPEG2, and ProRes outputs. Only enable | ||
| 167 | Timecode insertion when the input frame rate is identical to the output | ||
| 168 | frame rate. To include timecodes in this output, set Timecode insertion | ||
| 169 | (VideoTimecodeInsertion) to PIC_TIMING_SEI. To leave them out, set it | ||
| 170 | to DISABLED. Default is DISABLED. When the service inserts timecodes in | ||
| 171 | an output, by default, it uses any embedded timecodes from the input. | ||
| 172 | If none are present, the service will set the timecode for the first | ||
| 173 | output frame to zero. To change this default behavior, adjust the | ||
| 174 | settings under Timecode configuration (TimecodeConfig). In the console, | ||
| 175 | these settings are located under Job E<gt> Job settings E<gt> Timecode | ||
| 176 | configuration. Note - Timecode source under input settings | ||
| 177 | (InputTimecodeSource) does not affect the timecodes that are inserted | ||
| 178 | in the output. Source under Job settings E<gt> Timecode configuration | ||
| 179 | (TimecodeSource) does. | ||
| 180 | |||
| 181 | |||
| 182 | =head2 VideoPreprocessors => L<Paws::MediaConvert::VideoPreprocessor> | ||
| 183 | |||
| 184 | Find additional transcoding features under Preprocessors | ||
| 185 | (VideoPreprocessors). Enable the features at each output individually. | ||
| 186 | These features are disabled by default. | ||
| 187 | |||
| 188 | |||
| 189 | =head2 Width => Int | ||
| 190 | |||
| 191 | Use Width (Width) to define the video resolution width, in pixels, for | ||
| 192 | this output. If you don't provide a value here, the service will use | ||
| 193 | the input width. | ||
| 194 | |||
| 195 | |||
| 196 | |||
| 197 | =head1 SEE ALSO | ||
| 198 | |||
| 199 | This class forms part of L<Paws>, describing an object used in L<Paws::MediaConvert> | ||
| 200 | |||
| 201 | =head1 BUGS and CONTRIBUTIONS | ||
| 202 | |||
| 203 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 204 | |||
| 205 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 206 | |||
| 207 | =cut | ||
| 208 |