blib/lib/Paws/MediaConvert/CaptionDescription.pm untested

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