« blib/lib/Paws/MediaConvert/DvbSdtSettings.pm
↑ Summary
blib/lib/Paws/MediaConvert/DvbSubSourceSettings.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MediaConvert::DvbSubDestinationSettings; | ||
| 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 DdsHandling => (is => 'ro', isa => 'Str', request_name => 'ddsHandling', traits => ['NameInRequest']); | ||
| 8 | has DdsXCoordinate => (is => 'ro', isa => 'Int', request_name => 'ddsXCoordinate', traits => ['NameInRequest']); | ||
| 9 | has DdsYCoordinate => (is => 'ro', isa => 'Int', request_name => 'ddsYCoordinate', traits => ['NameInRequest']); | ||
| 10 | has FontColor => (is => 'ro', isa => 'Str', request_name => 'fontColor', traits => ['NameInRequest']); | ||
| 11 | has FontOpacity => (is => 'ro', isa => 'Int', request_name => 'fontOpacity', traits => ['NameInRequest']); | ||
| 12 | has FontResolution => (is => 'ro', isa => 'Int', request_name => 'fontResolution', traits => ['NameInRequest']); | ||
| 13 | has FontScript => (is => 'ro', isa => 'Str', request_name => 'fontScript', traits => ['NameInRequest']); | ||
| 14 | has FontSize => (is => 'ro', isa => 'Int', request_name => 'fontSize', traits => ['NameInRequest']); | ||
| 15 | has Height => (is => 'ro', isa => 'Int', request_name => 'height', traits => ['NameInRequest']); | ||
| 16 | has OutlineColor => (is => 'ro', isa => 'Str', request_name => 'outlineColor', traits => ['NameInRequest']); | ||
| 17 | has OutlineSize => (is => 'ro', isa => 'Int', request_name => 'outlineSize', traits => ['NameInRequest']); | ||
| 18 | has ShadowColor => (is => 'ro', isa => 'Str', request_name => 'shadowColor', traits => ['NameInRequest']); | ||
| 19 | has ShadowOpacity => (is => 'ro', isa => 'Int', request_name => 'shadowOpacity', traits => ['NameInRequest']); | ||
| 20 | has ShadowXOffset => (is => 'ro', isa => 'Int', request_name => 'shadowXOffset', traits => ['NameInRequest']); | ||
| 21 | has ShadowYOffset => (is => 'ro', isa => 'Int', request_name => 'shadowYOffset', traits => ['NameInRequest']); | ||
| 22 | has SubtitlingType => (is => 'ro', isa => 'Str', request_name => 'subtitlingType', traits => ['NameInRequest']); | ||
| 23 | has TeletextSpacing => (is => 'ro', isa => 'Str', request_name => 'teletextSpacing', traits => ['NameInRequest']); | ||
| 24 | has Width => (is => 'ro', isa => 'Int', request_name => 'width', traits => ['NameInRequest']); | ||
| 25 | has XPosition => (is => 'ro', isa => 'Int', request_name => 'xPosition', traits => ['NameInRequest']); | ||
| 26 | has YPosition => (is => 'ro', isa => 'Int', request_name => 'yPosition', traits => ['NameInRequest']); | ||
| 27 | |||
| 28 | 1; | ||
| 29 | |||
| 30 | ### main pod documentation begin ### | ||
| 31 | |||
| 32 | =head1 NAME | ||
| 33 | |||
| 34 | Paws::MediaConvert::DvbSubDestinationSettings | ||
| 35 | |||
| 36 | =head1 USAGE | ||
| 37 | |||
| 38 | This class represents one of two things: | ||
| 39 | |||
| 40 | =head3 Arguments in a call to a service | ||
| 41 | |||
| 42 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 43 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 44 | |||
| 45 | As an example, if Att1 is expected to be a Paws::MediaConvert::DvbSubDestinationSettings object: | ||
| 46 | |||
| 47 | $service_obj->Method(Att1 => { Alignment => $value, ..., YPosition => $value }); | ||
| 48 | |||
| 49 | =head3 Results returned from an API call | ||
| 50 | |||
| 51 | Use accessors for each attribute. If Att1 is expected to be an Paws::MediaConvert::DvbSubDestinationSettings object: | ||
| 52 | |||
| 53 | $result = $service_obj->Method(...); | ||
| 54 | $result->Att1->Alignment | ||
| 55 | |||
| 56 | =head1 DESCRIPTION | ||
| 57 | |||
| 58 | Settings related to DVB-Sub captions. Set up DVB-Sub captions in the | ||
| 59 | same output as your video. For more information, see | ||
| 60 | https://docs.aws.amazon.com/mediaconvert/latest/ug/dvb-sub-output-captions.html. | ||
| 61 | When you work directly in your JSON job specification, include this | ||
| 62 | object and any required children when you set destinationType to | ||
| 63 | DVB_SUB. | ||
| 64 | |||
| 65 | =head1 ATTRIBUTES | ||
| 66 | |||
| 67 | |||
| 68 | =head2 Alignment => Str | ||
| 69 | |||
| 70 | If no explicit x_position or y_position is provided, setting alignment | ||
| 71 | to centered will place the captions at the bottom center of the output. | ||
| 72 | Similarly, setting a left alignment will align captions to the bottom | ||
| 73 | left of the output. If x and y positions are given in conjunction with | ||
| 74 | the alignment parameter, the font will be justified (either left or | ||
| 75 | centered) relative to those coordinates. This option is not valid for | ||
| 76 | source captions that are STL, 608/embedded or teletext. These source | ||
| 77 | settings are already pre-defined by the caption stream. All burn-in and | ||
| 78 | DVB-Sub font settings must match. | ||
| 79 | |||
| 80 | |||
| 81 | =head2 BackgroundColor => Str | ||
| 82 | |||
| 83 | Specifies the color of the rectangle behind the captions. All burn-in | ||
| 84 | and DVB-Sub font settings must match. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 BackgroundOpacity => Int | ||
| 88 | |||
| 89 | Specifies the opacity of the background rectangle. 255 is opaque; 0 is | ||
| 90 | transparent. Leaving this parameter blank is equivalent to setting it | ||
| 91 | to 0 (transparent). All burn-in and DVB-Sub font settings must match. | ||
| 92 | |||
| 93 | |||
| 94 | =head2 DdsHandling => Str | ||
| 95 | |||
| 96 | Specify how MediaConvert handles the display definition segment (DDS). | ||
| 97 | Keep the default, None (NONE), to exclude the DDS from this set of | ||
| 98 | captions. Choose No display window (NO_DISPLAY_WINDOW) to have | ||
| 99 | MediaConvert include the DDS but not include display window data. In | ||
| 100 | this case, MediaConvert writes that information to the page composition | ||
| 101 | segment (PCS) instead. Choose Specify (SPECIFIED) to have MediaConvert | ||
| 102 | set up the display window based on the values that you specify in | ||
| 103 | related job settings. For video resolutions that are 576 pixels or | ||
| 104 | smaller in height, MediaConvert doesn't include the DDS, regardless of | ||
| 105 | the value you choose for DDS handling (ddsHandling). In this case, it | ||
| 106 | doesn't write the display window data to the PCS either. Related | ||
| 107 | settings: Use the settings DDS x-coordinate (ddsXCoordinate) and DDS | ||
| 108 | y-coordinate (ddsYCoordinate) to specify the offset between the top | ||
| 109 | left corner of the display window and the top left corner of the video | ||
| 110 | frame. All burn-in and DVB-Sub font settings must match. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 DdsXCoordinate => Int | ||
| 114 | |||
| 115 | Use this setting, along with DDS y-coordinate (ddsYCoordinate), to | ||
| 116 | specify the upper left corner of the display definition segment (DDS) | ||
| 117 | display window. With this setting, specify the distance, in pixels, | ||
| 118 | between the left side of the frame and the left side of the DDS display | ||
| 119 | window. Keep the default value, 0, to have MediaConvert automatically | ||
| 120 | choose this offset. Related setting: When you use this setting, you | ||
| 121 | must set DDS handling (ddsHandling) to a value other than None (NONE). | ||
| 122 | MediaConvert uses these values to determine whether to write page | ||
| 123 | position data to the DDS or to the page composition segment (PCS). All | ||
| 124 | burn-in and DVB-Sub font settings must match. | ||
| 125 | |||
| 126 | |||
| 127 | =head2 DdsYCoordinate => Int | ||
| 128 | |||
| 129 | Use this setting, along with DDS x-coordinate (ddsXCoordinate), to | ||
| 130 | specify the upper left corner of the display definition segment (DDS) | ||
| 131 | display window. With this setting, specify the distance, in pixels, | ||
| 132 | between the top of the frame and the top of the DDS display window. | ||
| 133 | Keep the default value, 0, to have MediaConvert automatically choose | ||
| 134 | this offset. Related setting: When you use this setting, you must set | ||
| 135 | DDS handling (ddsHandling) to a value other than None (NONE). | ||
| 136 | MediaConvert uses these values to determine whether to write page | ||
| 137 | position data to the DDS or to the page composition segment (PCS). All | ||
| 138 | burn-in and DVB-Sub font settings must match. | ||
| 139 | |||
| 140 | |||
| 141 | =head2 FontColor => Str | ||
| 142 | |||
| 143 | Specifies the color of the burned-in captions. This option is not valid | ||
| 144 | for source captions that are STL, 608/embedded or teletext. These | ||
| 145 | source settings are already pre-defined by the caption stream. All | ||
| 146 | burn-in and DVB-Sub font settings must match. | ||
| 147 | |||
| 148 | |||
| 149 | =head2 FontOpacity => Int | ||
| 150 | |||
| 151 | Specifies the opacity of the burned-in captions. 255 is opaque; 0 is | ||
| 152 | transparent. All burn-in and DVB-Sub font settings must match. | ||
| 153 | |||
| 154 | |||
| 155 | =head2 FontResolution => Int | ||
| 156 | |||
| 157 | Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in | ||
| 158 | and DVB-Sub font settings must match. | ||
| 159 | |||
| 160 | |||
| 161 | =head2 FontScript => Str | ||
| 162 | |||
| 163 | Provide the font script, using an ISO 15924 script code, if the | ||
| 164 | LanguageCode is not sufficient for determining the script type. Where | ||
| 165 | LanguageCode or CustomLanguageCode is sufficient, use "AUTOMATIC" or | ||
| 166 | leave unset. This is used to help determine the appropriate font for | ||
| 167 | rendering DVB-Sub captions. | ||
| 168 | |||
| 169 | |||
| 170 | =head2 FontSize => Int | ||
| 171 | |||
| 172 | A positive integer indicates the exact font size in points. Set to 0 | ||
| 173 | for automatic font size selection. All burn-in and DVB-Sub font | ||
| 174 | settings must match. | ||
| 175 | |||
| 176 | |||
| 177 | =head2 Height => Int | ||
| 178 | |||
| 179 | Specify the height, in pixels, of this set of DVB-Sub captions. The | ||
| 180 | default value is 576 pixels. Related setting: When you use this | ||
| 181 | setting, you must set DDS handling (ddsHandling) to a value other than | ||
| 182 | None (NONE). All burn-in and DVB-Sub font settings must match. | ||
| 183 | |||
| 184 | |||
| 185 | =head2 OutlineColor => Str | ||
| 186 | |||
| 187 | Specifies font outline color. This option is not valid for source | ||
| 188 | captions that are either 608/embedded or teletext. These source | ||
| 189 | settings are already pre-defined by the caption stream. All burn-in and | ||
| 190 | DVB-Sub font settings must match. | ||
| 191 | |||
| 192 | |||
| 193 | =head2 OutlineSize => Int | ||
| 194 | |||
| 195 | Specifies font outline size in pixels. This option is not valid for | ||
| 196 | source captions that are either 608/embedded or teletext. These source | ||
| 197 | settings are already pre-defined by the caption stream. All burn-in and | ||
| 198 | DVB-Sub font settings must match. | ||
| 199 | |||
| 200 | |||
| 201 | =head2 ShadowColor => Str | ||
| 202 | |||
| 203 | Specifies the color of the shadow cast by the captions. All burn-in and | ||
| 204 | DVB-Sub font settings must match. | ||
| 205 | |||
| 206 | |||
| 207 | =head2 ShadowOpacity => Int | ||
| 208 | |||
| 209 | Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. | ||
| 210 | Leaving this parameter blank is equivalent to setting it to 0 | ||
| 211 | (transparent). All burn-in and DVB-Sub font settings must match. | ||
| 212 | |||
| 213 | |||
| 214 | =head2 ShadowXOffset => Int | ||
| 215 | |||
| 216 | Specifies the horizontal offset of the shadow relative to the captions | ||
| 217 | in pixels. A value of -2 would result in a shadow offset 2 pixels to | ||
| 218 | the left. All burn-in and DVB-Sub font settings must match. | ||
| 219 | |||
| 220 | |||
| 221 | =head2 ShadowYOffset => Int | ||
| 222 | |||
| 223 | Specifies the vertical offset of the shadow relative to the captions in | ||
| 224 | pixels. A value of -2 would result in a shadow offset 2 pixels above | ||
| 225 | the text. All burn-in and DVB-Sub font settings must match. | ||
| 226 | |||
| 227 | |||
| 228 | =head2 SubtitlingType => Str | ||
| 229 | |||
| 230 | Specify whether your DVB subtitles are standard or for hearing | ||
| 231 | impaired. Choose hearing impaired if your subtitles include audio | ||
| 232 | descriptions and dialogue. Choose standard if your subtitles include | ||
| 233 | only dialogue. | ||
| 234 | |||
| 235 | |||
| 236 | =head2 TeletextSpacing => Str | ||
| 237 | |||
| 238 | Only applies to jobs with input captions in Teletext or STL formats. | ||
| 239 | Specify whether the spacing between letters in your captions is set by | ||
| 240 | the captions grid or varies depending on letter width. Choose fixed | ||
| 241 | grid to conform to the spacing specified in the captions file more | ||
| 242 | accurately. Choose proportional to make the text easier to read if the | ||
| 243 | captions are closed caption. | ||
| 244 | |||
| 245 | |||
| 246 | =head2 Width => Int | ||
| 247 | |||
| 248 | Specify the width, in pixels, of this set of DVB-Sub captions. The | ||
| 249 | default value is 720 pixels. Related setting: When you use this | ||
| 250 | setting, you must set DDS handling (ddsHandling) to a value other than | ||
| 251 | None (NONE). All burn-in and DVB-Sub font settings must match. | ||
| 252 | |||
| 253 | |||
| 254 | =head2 XPosition => Int | ||
| 255 | |||
| 256 | Specifies the horizontal position of the caption relative to the left | ||
| 257 | side of the output in pixels. A value of 10 would result in the | ||
| 258 | captions starting 10 pixels from the left of the output. If no explicit | ||
| 259 | x_position is provided, the horizontal caption position will be | ||
| 260 | determined by the alignment parameter. This option is not valid for | ||
| 261 | source captions that are STL, 608/embedded or teletext. These source | ||
| 262 | settings are already pre-defined by the caption stream. All burn-in and | ||
| 263 | DVB-Sub font settings must match. | ||
| 264 | |||
| 265 | |||
| 266 | =head2 YPosition => Int | ||
| 267 | |||
| 268 | Specifies the vertical position of the caption relative to the top of | ||
| 269 | the output in pixels. A value of 10 would result in the captions | ||
| 270 | starting 10 pixels from the top of the output. If no explicit | ||
| 271 | y_position is provided, the caption will be positioned towards the | ||
| 272 | bottom of the output. This option is not valid for source captions that | ||
| 273 | are STL, 608/embedded or teletext. These source settings are already | ||
| 274 | pre-defined by the caption stream. All burn-in and DVB-Sub font | ||
| 275 | settings must match. | ||
| 276 | |||
| 277 | |||
| 278 | |||
| 279 | =head1 SEE ALSO | ||
| 280 | |||
| 281 | This class forms part of L<Paws>, describing an object used in L<Paws::MediaConvert> | ||
| 282 | |||
| 283 | =head1 BUGS and CONTRIBUTIONS | ||
| 284 | |||
| 285 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 286 | |||
| 287 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 288 | |||
| 289 | =cut | ||
| 290 |