« blib/lib/Paws/MediaConvert/CaptionDescription.pm
↑ Summary
blib/lib/Paws/MediaConvert/CaptionDestinationSettings.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MediaConvert::CaptionDescriptionPreset; | ||
| 3 | use Moose; | ||
| 4 | has CustomLanguageCode => (is => 'ro', isa => 'Str', request_name => 'customLanguageCode', traits => ['NameInRequest']); | ||
| 5 | has DestinationSettings => (is => 'ro', isa => 'Paws::MediaConvert::CaptionDestinationSettings', request_name => 'destinationSettings', traits => ['NameInRequest']); | ||
| 6 | has LanguageCode => (is => 'ro', isa => 'Str', request_name => 'languageCode', traits => ['NameInRequest']); | ||
| 7 | has LanguageDescription => (is => 'ro', isa => 'Str', request_name => 'languageDescription', traits => ['NameInRequest']); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::MediaConvert::CaptionDescriptionPreset | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::MediaConvert::CaptionDescriptionPreset object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { CustomLanguageCode => $value, ..., LanguageDescription => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::MediaConvert::CaptionDescriptionPreset object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->CustomLanguageCode | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Caption Description for preset | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 CustomLanguageCode => Str | ||
| 45 | |||
| 46 | Specify the language for this captions output track. For most captions | ||
| 47 | output formats, the encoder puts this language information in the | ||
| 48 | output captions metadata. If your output captions format is DVB-Sub or | ||
| 49 | Burn in, the encoder uses this language information when automatically | ||
| 50 | selecting the font script for rendering the captions text. For all | ||
| 51 | outputs, you can use an ISO 639-2 or ISO 639-3 code. For streaming | ||
| 52 | outputs, you can also use any other code in the full RFC-5646 | ||
| 53 | specification. Streaming outputs are those that are in one of the | ||
| 54 | following output groups: CMAF, DASH ISO, Apple HLS, or Microsoft Smooth | ||
| 55 | Streaming. | ||
| 56 | |||
| 57 | |||
| 58 | =head2 DestinationSettings => L<Paws::MediaConvert::CaptionDestinationSettings> | ||
| 59 | |||
| 60 | Settings related to one captions tab on the MediaConvert console. In | ||
| 61 | your job JSON, an instance of captions DestinationSettings is | ||
| 62 | equivalent to one captions tab in the console. Usually, one captions | ||
| 63 | tab corresponds to one output captions track. Depending on your output | ||
| 64 | captions format, one tab might correspond to a set of output captions | ||
| 65 | tracks. For more information, see | ||
| 66 | https://docs.aws.amazon.com/mediaconvert/latest/ug/including-captions.html. | ||
| 67 | |||
| 68 | |||
| 69 | =head2 LanguageCode => Str | ||
| 70 | |||
| 71 | Specify the language of this captions output track. For most captions | ||
| 72 | output formats, the encoder puts this language information in the | ||
| 73 | output captions metadata. If your output captions format is DVB-Sub or | ||
| 74 | Burn in, the encoder uses this language information to choose the font | ||
| 75 | language for rendering the captions text. | ||
| 76 | |||
| 77 | |||
| 78 | =head2 LanguageDescription => Str | ||
| 79 | |||
| 80 | Specify a label for this set of output captions. For example, | ||
| 81 | "English", "Director commentary", or "track_2". For streaming outputs, | ||
| 82 | MediaConvert passes this information into destination manifests for | ||
| 83 | display on the end-viewer's player device. For outputs in other output | ||
| 84 | groups, the service ignores this setting. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head1 SEE ALSO | ||
| 89 | |||
| 90 | This class forms part of L<Paws>, describing an object used in L<Paws::MediaConvert> | ||
| 91 | |||
| 92 | =head1 BUGS and CONTRIBUTIONS | ||
| 93 | |||
| 94 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 95 | |||
| 96 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 97 | |||
| 98 | =cut | ||
| 99 |