« blib/lib/Paws/MediaConvert/CaptionSourceFramerate.pm
↑ Summary
blib/lib/Paws/MediaConvert/ChannelMapping.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::MediaConvert::CaptionSourceSettings; | ||
| 3 | use Moose; | ||
| 4 | has AncillarySourceSettings => (is => 'ro', isa => 'Paws::MediaConvert::AncillarySourceSettings', request_name => 'ancillarySourceSettings', traits => ['NameInRequest']); | ||
| 5 | has DvbSubSourceSettings => (is => 'ro', isa => 'Paws::MediaConvert::DvbSubSourceSettings', request_name => 'dvbSubSourceSettings', traits => ['NameInRequest']); | ||
| 6 | has EmbeddedSourceSettings => (is => 'ro', isa => 'Paws::MediaConvert::EmbeddedSourceSettings', request_name => 'embeddedSourceSettings', traits => ['NameInRequest']); | ||
| 7 | has FileSourceSettings => (is => 'ro', isa => 'Paws::MediaConvert::FileSourceSettings', request_name => 'fileSourceSettings', traits => ['NameInRequest']); | ||
| 8 | has SourceType => (is => 'ro', isa => 'Str', request_name => 'sourceType', traits => ['NameInRequest']); | ||
| 9 | has TeletextSourceSettings => (is => 'ro', isa => 'Paws::MediaConvert::TeletextSourceSettings', request_name => 'teletextSourceSettings', traits => ['NameInRequest']); | ||
| 10 | has TrackSourceSettings => (is => 'ro', isa => 'Paws::MediaConvert::TrackSourceSettings', request_name => 'trackSourceSettings', traits => ['NameInRequest']); | ||
| 11 | has WebvttHlsSourceSettings => (is => 'ro', isa => 'Paws::MediaConvert::WebvttHlsSourceSettings', request_name => 'webvttHlsSourceSettings', traits => ['NameInRequest']); | ||
| 12 | |||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::MediaConvert::CaptionSourceSettings | ||
| 20 | |||
| 21 | =head1 USAGE | ||
| 22 | |||
| 23 | This class represents one of two things: | ||
| 24 | |||
| 25 | =head3 Arguments in a call to a service | ||
| 26 | |||
| 27 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 28 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 29 | |||
| 30 | As an example, if Att1 is expected to be a Paws::MediaConvert::CaptionSourceSettings object: | ||
| 31 | |||
| 32 | $service_obj->Method(Att1 => { AncillarySourceSettings => $value, ..., WebvttHlsSourceSettings => $value }); | ||
| 33 | |||
| 34 | =head3 Results returned from an API call | ||
| 35 | |||
| 36 | Use accessors for each attribute. If Att1 is expected to be an Paws::MediaConvert::CaptionSourceSettings object: | ||
| 37 | |||
| 38 | $result = $service_obj->Method(...); | ||
| 39 | $result->Att1->AncillarySourceSettings | ||
| 40 | |||
| 41 | =head1 DESCRIPTION | ||
| 42 | |||
| 43 | If your input captions are SCC, TTML, STL, SMI, SRT, or IMSC in an xml | ||
| 44 | file, specify the URI of the input captions source file. If your input | ||
| 45 | captions are IMSC in an IMF package, use TrackSourceSettings instead of | ||
| 46 | FileSoureSettings. | ||
| 47 | |||
| 48 | =head1 ATTRIBUTES | ||
| 49 | |||
| 50 | |||
| 51 | =head2 AncillarySourceSettings => L<Paws::MediaConvert::AncillarySourceSettings> | ||
| 52 | |||
| 53 | Settings for ancillary captions source. | ||
| 54 | |||
| 55 | |||
| 56 | =head2 DvbSubSourceSettings => L<Paws::MediaConvert::DvbSubSourceSettings> | ||
| 57 | |||
| 58 | DVB Sub Source Settings | ||
| 59 | |||
| 60 | |||
| 61 | =head2 EmbeddedSourceSettings => L<Paws::MediaConvert::EmbeddedSourceSettings> | ||
| 62 | |||
| 63 | Settings for embedded captions Source | ||
| 64 | |||
| 65 | |||
| 66 | =head2 FileSourceSettings => L<Paws::MediaConvert::FileSourceSettings> | ||
| 67 | |||
| 68 | If your input captions are SCC, SMI, SRT, STL, TTML, WebVTT, or IMSC | ||
| 69 | 1.1 in an xml file, specify the URI of the input caption source file. | ||
| 70 | If your caption source is IMSC in an IMF package, use | ||
| 71 | TrackSourceSettings instead of FileSoureSettings. | ||
| 72 | |||
| 73 | |||
| 74 | =head2 SourceType => Str | ||
| 75 | |||
| 76 | Use Source (SourceType) to identify the format of your input captions. | ||
| 77 | The service cannot auto-detect caption format. | ||
| 78 | |||
| 79 | |||
| 80 | =head2 TeletextSourceSettings => L<Paws::MediaConvert::TeletextSourceSettings> | ||
| 81 | |||
| 82 | Settings specific to Teletext caption sources, including Page number. | ||
| 83 | |||
| 84 | |||
| 85 | =head2 TrackSourceSettings => L<Paws::MediaConvert::TrackSourceSettings> | ||
| 86 | |||
| 87 | Settings specific to caption sources that are specified by track | ||
| 88 | number. Currently, this is only IMSC captions in an IMF package. If | ||
| 89 | your caption source is IMSC 1.1 in a separate xml file, use | ||
| 90 | FileSourceSettings instead of TrackSourceSettings. | ||
| 91 | |||
| 92 | |||
| 93 | =head2 WebvttHlsSourceSettings => L<Paws::MediaConvert::WebvttHlsSourceSettings> | ||
| 94 | |||
| 95 | Settings specific to WebVTT sources in HLS alternative rendition group. | ||
| 96 | Specify the properties (renditionGroupId, renditionName or | ||
| 97 | renditionLanguageCode) to identify the unique subtitle track among the | ||
| 98 | alternative rendition groups present in the HLS manifest. If no unique | ||
| 99 | track is found, or multiple tracks match the specified properties, the | ||
| 100 | job fails. If there is only one subtitle track in the rendition group, | ||
| 101 | the settings can be left empty and the default subtitle track will be | ||
| 102 | chosen. If your caption source is a sidecar file, use | ||
| 103 | FileSourceSettings instead of WebvttHlsSourceSettings. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head1 SEE ALSO | ||
| 108 | |||
| 109 | This class forms part of L<Paws>, describing an object used in L<Paws::MediaConvert> | ||
| 110 | |||
| 111 | =head1 BUGS and CONTRIBUTIONS | ||
| 112 | |||
| 113 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 114 | |||
| 115 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 116 | |||
| 117 | =cut | ||
| 118 |