File Coverage

blib/lib/Paws/ElasticTranscoder/Captions.pm
Criterion Covered Total %
statement 3 3 100.0
branch n/a
condition n/a
subroutine 1 1 100.0
pod n/a
total 4 4 100.0


line stmt bran cond sub pod time code
1             package Paws::ElasticTranscoder::Captions;
2 1     1   486 use Moose;
  1         3  
  1         9  
3             has CaptionFormats => (is => 'ro', isa => 'ArrayRef[Paws::ElasticTranscoder::CaptionFormat]');
4             has CaptionSources => (is => 'ro', isa => 'ArrayRef[Paws::ElasticTranscoder::CaptionSource]');
5             has MergePolicy => (is => 'ro', isa => 'Str');
6             1;
7              
8             ### main pod documentation begin ###
9              
10             =head1 NAME
11              
12             Paws::ElasticTranscoder::Captions
13              
14             =head1 USAGE
15              
16             This class represents one of two things:
17              
18             =head3 Arguments in a call to a service
19              
20             Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
21             Each attribute should be used as a named argument in the calls that expect this type of object.
22              
23             As an example, if Att1 is expected to be a Paws::ElasticTranscoder::Captions object:
24              
25             $service_obj->Method(Att1 => { CaptionFormats => $value, ..., MergePolicy => $value });
26              
27             =head3 Results returned from an API call
28              
29             Use accessors for each attribute. If Att1 is expected to be an Paws::ElasticTranscoder::Captions object:
30              
31             $result = $service_obj->Method(...);
32             $result->Att1->CaptionFormats
33              
34             =head1 DESCRIPTION
35              
36             The captions to be created, if any.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 CaptionFormats => ArrayRef[L<Paws::ElasticTranscoder::CaptionFormat>]
42              
43             The array of file formats for the output captions. If you leave this
44             value blank, Elastic Transcoder returns an error.
45              
46              
47             =head2 CaptionSources => ArrayRef[L<Paws::ElasticTranscoder::CaptionSource>]
48              
49             Source files for the input sidecar captions used during the transcoding
50             process. To omit all sidecar captions, leave C<CaptionSources> blank.
51              
52              
53             =head2 MergePolicy => Str
54              
55             A policy that determines how Elastic Transcoder handles the existence
56             of multiple captions.
57              
58             =over
59              
60             =item *
61              
62             B<MergeOverride:> Elastic Transcoder transcodes both embedded and
63             sidecar captions into outputs. If captions for a language are embedded
64             in the input file and also appear in a sidecar file, Elastic Transcoder
65             uses the sidecar captions and ignores the embedded captions for that
66             language.
67              
68             =item *
69              
70             B<MergeRetain:> Elastic Transcoder transcodes both embedded and sidecar
71             captions into outputs. If captions for a language are embedded in the
72             input file and also appear in a sidecar file, Elastic Transcoder uses
73             the embedded captions and ignores the sidecar captions for that
74             language. If C<CaptionSources> is empty, Elastic Transcoder omits all
75             sidecar captions from the output files.
76              
77             =item *
78              
79             B<Override:> Elastic Transcoder transcodes only the sidecar captions
80             that you specify in C<CaptionSources>.
81              
82             =back
83              
84             C<MergePolicy> cannot be null.
85              
86              
87              
88             =head1 SEE ALSO
89              
90             This class forms part of L<Paws>, describing an object used in L<Paws::ElasticTranscoder>
91              
92             =head1 BUGS and CONTRIBUTIONS
93              
94             The source code is located here: https://github.com/pplu/aws-sdk-perl
95              
96             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
97              
98             =cut
99