« blib/lib/Paws/MediaConvert/AvcIntraUhdSettings.pm
↑ Summary
blib/lib/Paws/MediaConvert/CancelJob.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MediaConvert::BurninDestinationSettings; | ||
| 3 | use Moose; | ||
| 4 | has Alignment => (is => 'ro', isa => 'Str', request_name => 'alignment', traits => ['NameInRequest']); | ||
| 5 | has BackgroundColor => (is => 'ro', isa => 'Str', request_name => 'backgroundColor', traits => ['NameInRequest']); | ||
| 6 | has BackgroundOpacity => (is => 'ro', isa => 'Int', request_name => 'backgroundOpacity', traits => ['NameInRequest']); | ||
| 7 | has FontColor => (is => 'ro', isa => 'Str', request_name => 'fontColor', traits => ['NameInRequest']); | ||
| 8 | has FontOpacity => (is => 'ro', isa => 'Int', request_name => 'fontOpacity', traits => ['NameInRequest']); | ||
| 9 | has FontResolution => (is => 'ro', isa => 'Int', request_name => 'fontResolution', traits => ['NameInRequest']); | ||
| 10 | has FontScript => (is => 'ro', isa => 'Str', request_name => 'fontScript', traits => ['NameInRequest']); | ||
| 11 | has FontSize => (is => 'ro', isa => 'Int', request_name => 'fontSize', traits => ['NameInRequest']); | ||
| 12 | has OutlineColor => (is => 'ro', isa => 'Str', request_name => 'outlineColor', traits => ['NameInRequest']); | ||
| 13 | has OutlineSize => (is => 'ro', isa => 'Int', request_name => 'outlineSize', traits => ['NameInRequest']); | ||
| 14 | has ShadowColor => (is => 'ro', isa => 'Str', request_name => 'shadowColor', traits => ['NameInRequest']); | ||
| 15 | has ShadowOpacity => (is => 'ro', isa => 'Int', request_name => 'shadowOpacity', traits => ['NameInRequest']); | ||
| 16 | has ShadowXOffset => (is => 'ro', isa => 'Int', request_name => 'shadowXOffset', traits => ['NameInRequest']); | ||
| 17 | has ShadowYOffset => (is => 'ro', isa => 'Int', request_name => 'shadowYOffset', traits => ['NameInRequest']); | ||
| 18 | has TeletextSpacing => (is => 'ro', isa => 'Str', request_name => 'teletextSpacing', traits => ['NameInRequest']); | ||
| 19 | has XPosition => (is => 'ro', isa => 'Int', request_name => 'xPosition', traits => ['NameInRequest']); | ||
| 20 | has YPosition => (is => 'ro', isa => 'Int', request_name => 'yPosition', traits => ['NameInRequest']); | ||
| 21 | |||
| 22 | 1; | ||
| 23 | |||
| 24 | ### main pod documentation begin ### | ||
| 25 | |||
| 26 | =head1 NAME | ||
| 27 | |||
| 28 | Paws::MediaConvert::BurninDestinationSettings | ||
| 29 | |||
| 30 | =head1 USAGE | ||
| 31 | |||
| 32 | This class represents one of two things: | ||
| 33 | |||
| 34 | =head3 Arguments in a call to a service | ||
| 35 | |||
| 36 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 37 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 38 | |||
| 39 | As an example, if Att1 is expected to be a Paws::MediaConvert::BurninDestinationSettings object: | ||
| 40 | |||
| 41 | $service_obj->Method(Att1 => { Alignment => $value, ..., YPosition => $value }); | ||
| 42 | |||
| 43 | =head3 Results returned from an API call | ||
| 44 | |||
| 45 | Use accessors for each attribute. If Att1 is expected to be an Paws::MediaConvert::BurninDestinationSettings object: | ||
| 46 | |||
| 47 | $result = $service_obj->Method(...); | ||
| 48 | $result->Att1->Alignment | ||
| 49 | |||
| 50 | =head1 DESCRIPTION | ||
| 51 | |||
| 52 | Settings related to burn-in captions. Set up burn-in captions in the | ||
| 53 | same output as your video. For more information, see | ||
| 54 | https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html. | ||
| 55 | When you work directly in your JSON job specification, include this | ||
| 56 | object and any required children when you set destinationType to | ||
| 57 | BURN_IN. | ||
| 58 | |||
| 59 | =head1 ATTRIBUTES | ||
| 60 | |||
| 61 | |||
| 62 | =head2 Alignment => Str | ||
| 63 | |||
| 64 | If no explicit x_position or y_position is provided, setting alignment | ||
| 65 | to centered will place the captions at the bottom center of the output. | ||
| 66 | Similarly, setting a left alignment will align captions to the bottom | ||
| 67 | left of the output. If x and y positions are given in conjunction with | ||
| 68 | the alignment parameter, the font will be justified (either left or | ||
| 69 | centered) relative to those coordinates. This option is not valid for | ||
| 70 | source captions that are STL, 608/embedded or teletext. These source | ||
| 71 | settings are already pre-defined by the caption stream. All burn-in and | ||
| 72 | DVB-Sub font settings must match. | ||
| 73 | |||
| 74 | |||
| 75 | =head2 BackgroundColor => Str | ||
| 76 | |||
| 77 | Specifies the color of the rectangle behind the captions. All burn-in | ||
| 78 | and DVB-Sub font settings must match. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 BackgroundOpacity => Int | ||
| 82 | |||
| 83 | Specifies the opacity of the background rectangle. 255 is opaque; 0 is | ||
| 84 | transparent. Leaving this parameter blank is equivalent to setting it | ||
| 85 | to 0 (transparent). All burn-in and DVB-Sub font settings must match. | ||
| 86 | |||
| 87 | |||
| 88 | =head2 FontColor => Str | ||
| 89 | |||
| 90 | Specifies the color of the burned-in captions. This option is not valid | ||
| 91 | for source captions that are STL, 608/embedded or teletext. These | ||
| 92 | source settings are already pre-defined by the caption stream. All | ||
| 93 | burn-in and DVB-Sub font settings must match. | ||
| 94 | |||
| 95 | |||
| 96 | =head2 FontOpacity => Int | ||
| 97 | |||
| 98 | Specifies the opacity of the burned-in captions. 255 is opaque; 0 is | ||
| 99 | transparent. All burn-in and DVB-Sub font settings must match. | ||
| 100 | |||
| 101 | |||
| 102 | =head2 FontResolution => Int | ||
| 103 | |||
| 104 | Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in | ||
| 105 | and DVB-Sub font settings must match. | ||
| 106 | |||
| 107 | |||
| 108 | =head2 FontScript => Str | ||
| 109 | |||
| 110 | Provide the font script, using an ISO 15924 script code, if the | ||
| 111 | LanguageCode is not sufficient for determining the script type. Where | ||
| 112 | LanguageCode or CustomLanguageCode is sufficient, use "AUTOMATIC" or | ||
| 113 | leave unset. This is used to help determine the appropriate font for | ||
| 114 | rendering burn-in captions. | ||
| 115 | |||
| 116 | |||
| 117 | =head2 FontSize => Int | ||
| 118 | |||
| 119 | A positive integer indicates the exact font size in points. Set to 0 | ||
| 120 | for automatic font size selection. All burn-in and DVB-Sub font | ||
| 121 | settings must match. | ||
| 122 | |||
| 123 | |||
| 124 | =head2 OutlineColor => Str | ||
| 125 | |||
| 126 | Specifies font outline color. This option is not valid for source | ||
| 127 | captions that are either 608/embedded or teletext. These source | ||
| 128 | settings are already pre-defined by the caption stream. All burn-in and | ||
| 129 | DVB-Sub font settings must match. | ||
| 130 | |||
| 131 | |||
| 132 | =head2 OutlineSize => Int | ||
| 133 | |||
| 134 | Specifies font outline size in pixels. This option is not valid for | ||
| 135 | source captions that are either 608/embedded or teletext. These source | ||
| 136 | settings are already pre-defined by the caption stream. All burn-in and | ||
| 137 | DVB-Sub font settings must match. | ||
| 138 | |||
| 139 | |||
| 140 | =head2 ShadowColor => Str | ||
| 141 | |||
| 142 | Specifies the color of the shadow cast by the captions. All burn-in and | ||
| 143 | DVB-Sub font settings must match. | ||
| 144 | |||
| 145 | |||
| 146 | =head2 ShadowOpacity => Int | ||
| 147 | |||
| 148 | Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. | ||
| 149 | Leaving this parameter blank is equivalent to setting it to 0 | ||
| 150 | (transparent). All burn-in and DVB-Sub font settings must match. | ||
| 151 | |||
| 152 | |||
| 153 | =head2 ShadowXOffset => Int | ||
| 154 | |||
| 155 | Specifies the horizontal offset of the shadow relative to the captions | ||
| 156 | in pixels. A value of -2 would result in a shadow offset 2 pixels to | ||
| 157 | the left. All burn-in and DVB-Sub font settings must match. | ||
| 158 | |||
| 159 | |||
| 160 | =head2 ShadowYOffset => Int | ||
| 161 | |||
| 162 | Specifies the vertical offset of the shadow relative to the captions in | ||
| 163 | pixels. A value of -2 would result in a shadow offset 2 pixels above | ||
| 164 | the text. All burn-in and DVB-Sub font settings must match. | ||
| 165 | |||
| 166 | |||
| 167 | =head2 TeletextSpacing => Str | ||
| 168 | |||
| 169 | Only applies to jobs with input captions in Teletext or STL formats. | ||
| 170 | Specify whether the spacing between letters in your captions is set by | ||
| 171 | the captions grid or varies depending on letter width. Choose fixed | ||
| 172 | grid to conform to the spacing specified in the captions file more | ||
| 173 | accurately. Choose proportional to make the text easier to read if the | ||
| 174 | captions are closed caption. | ||
| 175 | |||
| 176 | |||
| 177 | =head2 XPosition => Int | ||
| 178 | |||
| 179 | Specifies the horizontal position of the caption relative to the left | ||
| 180 | side of the output in pixels. A value of 10 would result in the | ||
| 181 | captions starting 10 pixels from the left of the output. If no explicit | ||
| 182 | x_position is provided, the horizontal caption position will be | ||
| 183 | determined by the alignment parameter. This option is not valid for | ||
| 184 | source captions that are STL, 608/embedded or teletext. These source | ||
| 185 | settings are already pre-defined by the caption stream. All burn-in and | ||
| 186 | DVB-Sub font settings must match. | ||
| 187 | |||
| 188 | |||
| 189 | =head2 YPosition => Int | ||
| 190 | |||
| 191 | Specifies the vertical position of the caption relative to the top of | ||
| 192 | the output in pixels. A value of 10 would result in the captions | ||
| 193 | starting 10 pixels from the top of the output. If no explicit | ||
| 194 | y_position is provided, the caption will be positioned towards the | ||
| 195 | bottom of the output. This option is not valid for source captions that | ||
| 196 | are STL, 608/embedded or teletext. These source settings are already | ||
| 197 | pre-defined by the caption stream. All burn-in and DVB-Sub font | ||
| 198 | settings must match. | ||
| 199 | |||
| 200 | |||
| 201 | |||
| 202 | =head1 SEE ALSO | ||
| 203 | |||
| 204 | This class forms part of L<Paws>, describing an object used in L<Paws::MediaConvert> | ||
| 205 | |||
| 206 | =head1 BUGS and CONTRIBUTIONS | ||
| 207 | |||
| 208 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 209 | |||
| 210 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 211 | |||
| 212 | =cut | ||
| 213 |