« blib/lib/Paws/MediaLive/BlackoutSlate.pm
↑ Summary
blib/lib/Paws/MediaLive/CancelInputDeviceTransfer.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MediaLive::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 Font => (is => 'ro', isa => 'Paws::MediaLive::InputLocation', request_name => 'font', traits => ['NameInRequest']); | ||
| 8 | has FontColor => (is => 'ro', isa => 'Str', request_name => 'fontColor', traits => ['NameInRequest']); | ||
| 9 | has FontOpacity => (is => 'ro', isa => 'Int', request_name => 'fontOpacity', traits => ['NameInRequest']); | ||
| 10 | has FontResolution => (is => 'ro', isa => 'Int', request_name => 'fontResolution', traits => ['NameInRequest']); | ||
| 11 | has FontSize => (is => 'ro', isa => 'Str', 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 TeletextGridControl => (is => 'ro', isa => 'Str', request_name => 'teletextGridControl', 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::MediaLive::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::MediaLive::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::MediaLive::BurnInDestinationSettings object: | ||
| 46 | |||
| 47 | $result = $service_obj->Method(...); | ||
| 48 | $result->Att1->Alignment | ||
| 49 | |||
| 50 | =head1 DESCRIPTION | ||
| 51 | |||
| 52 | Burn In Destination Settings | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 Alignment => Str | ||
| 58 | |||
| 59 | If no explicit xPosition or yPosition is provided, setting alignment to | ||
| 60 | centered will place the captions at the bottom center of the output. | ||
| 61 | Similarly, setting a left alignment will align captions to the bottom | ||
| 62 | left of the output. If x and y positions are given in conjunction with | ||
| 63 | the alignment parameter, the font will be justified (either left or | ||
| 64 | centered) relative to those coordinates. Selecting "smart" | ||
| 65 | justification will left-justify live subtitles and center-justify | ||
| 66 | pre-recorded subtitles. All burn-in and DVB-Sub font settings must | ||
| 67 | match. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 BackgroundColor => Str | ||
| 71 | |||
| 72 | Specifies the color of the rectangle behind the captions. All burn-in | ||
| 73 | and DVB-Sub font settings must match. | ||
| 74 | |||
| 75 | |||
| 76 | =head2 BackgroundOpacity => Int | ||
| 77 | |||
| 78 | Specifies the opacity of the background rectangle. 255 is opaque; 0 is | ||
| 79 | transparent. Leaving this parameter out is equivalent to setting it to | ||
| 80 | 0 (transparent). All burn-in and DVB-Sub font settings must match. | ||
| 81 | |||
| 82 | |||
| 83 | =head2 Font => L<Paws::MediaLive::InputLocation> | ||
| 84 | |||
| 85 | External font file used for caption burn-in. File extension must be | ||
| 86 | 'ttf' or 'tte'. Although the user can select output fonts for many | ||
| 87 | different types of input captions, embedded, STL and teletext sources | ||
| 88 | use a strict grid system. Using external fonts with these caption | ||
| 89 | sources could cause unexpected display of proportional fonts. All | ||
| 90 | burn-in and DVB-Sub font settings must match. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 FontColor => Str | ||
| 94 | |||
| 95 | Specifies the color of the burned-in captions. This option is not valid | ||
| 96 | for source captions that are STL, 608/embedded or teletext. These | ||
| 97 | source settings are already pre-defined by the caption stream. All | ||
| 98 | burn-in and DVB-Sub font settings must match. | ||
| 99 | |||
| 100 | |||
| 101 | =head2 FontOpacity => Int | ||
| 102 | |||
| 103 | Specifies the opacity of the burned-in captions. 255 is opaque; 0 is | ||
| 104 | transparent. All burn-in and DVB-Sub font settings must match. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 FontResolution => Int | ||
| 108 | |||
| 109 | Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in | ||
| 110 | and DVB-Sub font settings must match. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 FontSize => Str | ||
| 114 | |||
| 115 | When set to 'auto' fontSize will scale depending on the size of the | ||
| 116 | output. Giving a positive integer will specify the exact font size in | ||
| 117 | points. All burn-in and DVB-Sub font settings must match. | ||
| 118 | |||
| 119 | |||
| 120 | =head2 OutlineColor => Str | ||
| 121 | |||
| 122 | Specifies font outline color. This option is not valid for source | ||
| 123 | captions that are either 608/embedded or teletext. These source | ||
| 124 | settings are already pre-defined by the caption stream. All burn-in and | ||
| 125 | DVB-Sub font settings must match. | ||
| 126 | |||
| 127 | |||
| 128 | =head2 OutlineSize => Int | ||
| 129 | |||
| 130 | Specifies font outline size in pixels. This option is not valid for | ||
| 131 | source captions that are either 608/embedded or teletext. These source | ||
| 132 | settings are already pre-defined by the caption stream. All burn-in and | ||
| 133 | DVB-Sub font settings must match. | ||
| 134 | |||
| 135 | |||
| 136 | =head2 ShadowColor => Str | ||
| 137 | |||
| 138 | Specifies the color of the shadow cast by the captions. All burn-in and | ||
| 139 | DVB-Sub font settings must match. | ||
| 140 | |||
| 141 | |||
| 142 | =head2 ShadowOpacity => Int | ||
| 143 | |||
| 144 | Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. | ||
| 145 | Leaving this parameter out is equivalent to setting it to 0 | ||
| 146 | (transparent). All burn-in and DVB-Sub font settings must match. | ||
| 147 | |||
| 148 | |||
| 149 | =head2 ShadowXOffset => Int | ||
| 150 | |||
| 151 | Specifies the horizontal offset of the shadow relative to the captions | ||
| 152 | in pixels. A value of -2 would result in a shadow offset 2 pixels to | ||
| 153 | the left. All burn-in and DVB-Sub font settings must match. | ||
| 154 | |||
| 155 | |||
| 156 | =head2 ShadowYOffset => Int | ||
| 157 | |||
| 158 | Specifies the vertical offset of the shadow relative to the captions in | ||
| 159 | pixels. A value of -2 would result in a shadow offset 2 pixels above | ||
| 160 | the text. All burn-in and DVB-Sub font settings must match. | ||
| 161 | |||
| 162 | |||
| 163 | =head2 TeletextGridControl => Str | ||
| 164 | |||
| 165 | Controls whether a fixed grid size will be used to generate the output | ||
| 166 | subtitles bitmap. Only applicable for Teletext inputs and | ||
| 167 | DVB-Sub/Burn-in outputs. | ||
| 168 | |||
| 169 | |||
| 170 | =head2 XPosition => Int | ||
| 171 | |||
| 172 | Specifies the horizontal position of the caption relative to the left | ||
| 173 | side of the output in pixels. A value of 10 would result in the | ||
| 174 | captions starting 10 pixels from the left of the output. If no explicit | ||
| 175 | xPosition is provided, the horizontal caption position will be | ||
| 176 | determined by the alignment parameter. All burn-in and DVB-Sub font | ||
| 177 | settings must match. | ||
| 178 | |||
| 179 | |||
| 180 | =head2 YPosition => Int | ||
| 181 | |||
| 182 | Specifies the vertical position of the caption relative to the top of | ||
| 183 | the output in pixels. A value of 10 would result in the captions | ||
| 184 | starting 10 pixels from the top of the output. If no explicit yPosition | ||
| 185 | is provided, the caption will be positioned towards the bottom of the | ||
| 186 | output. All burn-in and DVB-Sub font settings must match. | ||
| 187 | |||
| 188 | |||
| 189 | |||
| 190 | =head1 SEE ALSO | ||
| 191 | |||
| 192 | This class forms part of L<Paws>, describing an object used in L<Paws::MediaLive> | ||
| 193 | |||
| 194 | =head1 BUGS and CONTRIBUTIONS | ||
| 195 | |||
| 196 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 197 | |||
| 198 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 199 | |||
| 200 | =cut | ||
| 201 |