« blib/lib/Paws/MediaConvert/CaptionDescriptionPreset.pm
↑ Summary
blib/lib/Paws/MediaConvert/CaptionSelector.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MediaConvert::CaptionDestinationSettings; | ||
| 3 | use Moose; | ||
| 4 | has BurninDestinationSettings => (is => 'ro', isa => 'Paws::MediaConvert::BurninDestinationSettings', request_name => 'burninDestinationSettings', traits => ['NameInRequest']); | ||
| 5 | has DestinationType => (is => 'ro', isa => 'Str', request_name => 'destinationType', traits => ['NameInRequest']); | ||
| 6 | has DvbSubDestinationSettings => (is => 'ro', isa => 'Paws::MediaConvert::DvbSubDestinationSettings', request_name => 'dvbSubDestinationSettings', traits => ['NameInRequest']); | ||
| 7 | has EmbeddedDestinationSettings => (is => 'ro', isa => 'Paws::MediaConvert::EmbeddedDestinationSettings', request_name => 'embeddedDestinationSettings', traits => ['NameInRequest']); | ||
| 8 | has ImscDestinationSettings => (is => 'ro', isa => 'Paws::MediaConvert::ImscDestinationSettings', request_name => 'imscDestinationSettings', traits => ['NameInRequest']); | ||
| 9 | has SccDestinationSettings => (is => 'ro', isa => 'Paws::MediaConvert::SccDestinationSettings', request_name => 'sccDestinationSettings', traits => ['NameInRequest']); | ||
| 10 | has TeletextDestinationSettings => (is => 'ro', isa => 'Paws::MediaConvert::TeletextDestinationSettings', request_name => 'teletextDestinationSettings', traits => ['NameInRequest']); | ||
| 11 | has TtmlDestinationSettings => (is => 'ro', isa => 'Paws::MediaConvert::TtmlDestinationSettings', request_name => 'ttmlDestinationSettings', traits => ['NameInRequest']); | ||
| 12 | has WebvttDestinationSettings => (is => 'ro', isa => 'Paws::MediaConvert::WebvttDestinationSettings', request_name => 'webvttDestinationSettings', traits => ['NameInRequest']); | ||
| 13 | |||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::MediaConvert::CaptionDestinationSettings | ||
| 21 | |||
| 22 | =head1 USAGE | ||
| 23 | |||
| 24 | This class represents one of two things: | ||
| 25 | |||
| 26 | =head3 Arguments in a call to a service | ||
| 27 | |||
| 28 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 29 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 30 | |||
| 31 | As an example, if Att1 is expected to be a Paws::MediaConvert::CaptionDestinationSettings object: | ||
| 32 | |||
| 33 | $service_obj->Method(Att1 => { BurninDestinationSettings => $value, ..., WebvttDestinationSettings => $value }); | ||
| 34 | |||
| 35 | =head3 Results returned from an API call | ||
| 36 | |||
| 37 | Use accessors for each attribute. If Att1 is expected to be an Paws::MediaConvert::CaptionDestinationSettings object: | ||
| 38 | |||
| 39 | $result = $service_obj->Method(...); | ||
| 40 | $result->Att1->BurninDestinationSettings | ||
| 41 | |||
| 42 | =head1 DESCRIPTION | ||
| 43 | |||
| 44 | Settings related to one captions tab on the MediaConvert console. In | ||
| 45 | your job JSON, an instance of captions DestinationSettings is | ||
| 46 | equivalent to one captions tab in the console. Usually, one captions | ||
| 47 | tab corresponds to one output captions track. Depending on your output | ||
| 48 | captions format, one tab might correspond to a set of output captions | ||
| 49 | tracks. For more information, see | ||
| 50 | https://docs.aws.amazon.com/mediaconvert/latest/ug/including-captions.html. | ||
| 51 | |||
| 52 | =head1 ATTRIBUTES | ||
| 53 | |||
| 54 | |||
| 55 | =head2 BurninDestinationSettings => L<Paws::MediaConvert::BurninDestinationSettings> | ||
| 56 | |||
| 57 | Settings related to burn-in captions. Set up burn-in captions in the | ||
| 58 | same output as your video. For more information, see | ||
| 59 | https://docs.aws.amazon.com/mediaconvert/latest/ug/burn-in-output-captions.html. | ||
| 60 | When you work directly in your JSON job specification, include this | ||
| 61 | object and any required children when you set destinationType to | ||
| 62 | BURN_IN. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 DestinationType => Str | ||
| 66 | |||
| 67 | Specify the format for this set of captions on this output. The default | ||
| 68 | format is embedded without SCTE-20. Note that your choice of video | ||
| 69 | output container constrains your choice of output captions format. For | ||
| 70 | more information, see | ||
| 71 | https://docs.aws.amazon.com/mediaconvert/latest/ug/captions-support-tables.html. | ||
| 72 | If you are using SCTE-20 and you want to create an output that complies | ||
| 73 | with the SCTE-43 spec, choose SCTE-20 plus embedded | ||
| 74 | (SCTE20_PLUS_EMBEDDED). To create a non-compliant output where the | ||
| 75 | embedded captions come first, choose Embedded plus SCTE-20 | ||
| 76 | (EMBEDDED_PLUS_SCTE20). | ||
| 77 | |||
| 78 | |||
| 79 | =head2 DvbSubDestinationSettings => L<Paws::MediaConvert::DvbSubDestinationSettings> | ||
| 80 | |||
| 81 | Settings related to DVB-Sub captions. Set up DVB-Sub captions in the | ||
| 82 | same output as your video. For more information, see | ||
| 83 | https://docs.aws.amazon.com/mediaconvert/latest/ug/dvb-sub-output-captions.html. | ||
| 84 | When you work directly in your JSON job specification, include this | ||
| 85 | object and any required children when you set destinationType to | ||
| 86 | DVB_SUB. | ||
| 87 | |||
| 88 | |||
| 89 | =head2 EmbeddedDestinationSettings => L<Paws::MediaConvert::EmbeddedDestinationSettings> | ||
| 90 | |||
| 91 | Settings related to CEA/EIA-608 and CEA/EIA-708 (also called embedded | ||
| 92 | or ancillary) captions. Set up embedded captions in the same output as | ||
| 93 | your video. For more information, see | ||
| 94 | https://docs.aws.amazon.com/mediaconvert/latest/ug/embedded-output-captions.html. | ||
| 95 | When you work directly in your JSON job specification, include this | ||
| 96 | object and any required children when you set destinationType to | ||
| 97 | EMBEDDED, EMBEDDED_PLUS_SCTE20, or SCTE20_PLUS_EMBEDDED. | ||
| 98 | |||
| 99 | |||
| 100 | =head2 ImscDestinationSettings => L<Paws::MediaConvert::ImscDestinationSettings> | ||
| 101 | |||
| 102 | Settings related to IMSC captions. IMSC is a sidecar format that holds | ||
| 103 | captions in a file that is separate from the video container. Set up | ||
| 104 | sidecar captions in the same output group, but different output from | ||
| 105 | your video. For more information, see | ||
| 106 | https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. | ||
| 107 | When you work directly in your JSON job specification, include this | ||
| 108 | object and any required children when you set destinationType to IMSC. | ||
| 109 | |||
| 110 | |||
| 111 | =head2 SccDestinationSettings => L<Paws::MediaConvert::SccDestinationSettings> | ||
| 112 | |||
| 113 | Settings related to SCC captions. SCC is a sidecar format that holds | ||
| 114 | captions in a file that is separate from the video container. Set up | ||
| 115 | sidecar captions in the same output group, but different output from | ||
| 116 | your video. For more information, see | ||
| 117 | https://docs.aws.amazon.com/mediaconvert/latest/ug/scc-srt-output-captions.html. | ||
| 118 | When you work directly in your JSON job specification, include this | ||
| 119 | object and any required children when you set destinationType to SCC. | ||
| 120 | |||
| 121 | |||
| 122 | =head2 TeletextDestinationSettings => L<Paws::MediaConvert::TeletextDestinationSettings> | ||
| 123 | |||
| 124 | Settings related to teletext captions. Set up teletext captions in the | ||
| 125 | same output as your video. For more information, see | ||
| 126 | https://docs.aws.amazon.com/mediaconvert/latest/ug/teletext-output-captions.html. | ||
| 127 | When you work directly in your JSON job specification, include this | ||
| 128 | object and any required children when you set destinationType to | ||
| 129 | TELETEXT. | ||
| 130 | |||
| 131 | |||
| 132 | =head2 TtmlDestinationSettings => L<Paws::MediaConvert::TtmlDestinationSettings> | ||
| 133 | |||
| 134 | Settings related to TTML captions. TTML is a sidecar format that holds | ||
| 135 | captions in a file that is separate from the video container. Set up | ||
| 136 | sidecar captions in the same output group, but different output from | ||
| 137 | your video. For more information, see | ||
| 138 | https://docs.aws.amazon.com/mediaconvert/latest/ug/ttml-and-webvtt-output-captions.html. | ||
| 139 | When you work directly in your JSON job specification, include this | ||
| 140 | object and any required children when you set destinationType to TTML. | ||
| 141 | |||
| 142 | |||
| 143 | =head2 WebvttDestinationSettings => L<Paws::MediaConvert::WebvttDestinationSettings> | ||
| 144 | |||
| 145 | WEBVTT Destination Settings | ||
| 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 |