blib/lib/Paws/Polly/SynthesisTask.pm untested

filter: Statementstmt 0.0% 0 / 18 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 19 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::Polly::SynthesisTask;
3 use Moose;
4 has CreationTime => (is => 'ro', isa => 'Str');
5 has Engine => (is => 'ro', isa => 'Str');
6 has LanguageCode => (is => 'ro', isa => 'Str');
7 has LexiconNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
8 has OutputFormat => (is => 'ro', isa => 'Str');
9 has OutputUri => (is => 'ro', isa => 'Str');
10 has RequestCharacters => (is => 'ro', isa => 'Int');
11 has SampleRate => (is => 'ro', isa => 'Str');
12 has SnsTopicArn => (is => 'ro', isa => 'Str');
13 has SpeechMarkTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
14 has TaskId => (is => 'ro', isa => 'Str');
15 has TaskStatus => (is => 'ro', isa => 'Str');
16 has TaskStatusReason => (is => 'ro', isa => 'Str');
17 has TextType => (is => 'ro', isa => 'Str');
18 has VoiceId => (is => 'ro', isa => 'Str');
19  
20 1;
21  
22 ### main pod documentation begin ###
23  
24 =head1 NAME
25  
26 Paws::Polly::SynthesisTask
27  
28 =head1 USAGE
29  
30 This class represents one of two things:
31  
32 =head3 Arguments in a call to a service
33  
34 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
35 Each attribute should be used as a named argument in the calls that expect this type of object.
36  
37 As an example, if Att1 is expected to be a Paws::Polly::SynthesisTask object:
38  
39 $service_obj->Method(Att1 => { CreationTime => $value, ..., VoiceId => $value });
40  
41 =head3 Results returned from an API call
42  
43 Use accessors for each attribute. If Att1 is expected to be an Paws::Polly::SynthesisTask object:
44  
45 $result = $service_obj->Method(...);
46 $result->Att1->CreationTime
47  
48 =head1 DESCRIPTION
49  
50 SynthesisTask object that provides information about a speech synthesis
51 task.
52  
53 =head1 ATTRIBUTES
54  
55  
56 =head2 CreationTime => Str
57  
58 Timestamp for the time the synthesis task was started.
59  
60  
61 =head2 Engine => Str
62  
63 Specifies the engine (C<standard> or C<neural>) for Amazon Polly to use
64 when processing input text for speech synthesis. Using a voice that is
65 not supported for the engine selected will result in an error.
66  
67  
68 =head2 LanguageCode => Str
69  
70 Optional language code for a synthesis task. This is only necessary if
71 using a bilingual voice, such as Aditi, which can be used for either
72 Indian English (en-IN) or Hindi (hi-IN).
73  
74 If a bilingual voice is used and no language code is specified, Amazon
75 Polly will use the default language of the bilingual voice. The default
76 language for any voice is the one returned by the DescribeVoices
77 (https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html)
78 operation for the C<LanguageCode> parameter. For example, if no
79 language code is specified, Aditi will use Indian English rather than
80 Hindi.
81  
82  
83 =head2 LexiconNames => ArrayRef[Str|Undef]
84  
85 List of one or more pronunciation lexicon names you want the service to
86 apply during synthesis. Lexicons are applied only if the language of
87 the lexicon is the same as the language of the voice.
88  
89  
90 =head2 OutputFormat => Str
91  
92 The format in which the returned output will be encoded. For audio
93 stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this
94 will be json.
95  
96  
97 =head2 OutputUri => Str
98  
99 Pathway for the output speech file.
100  
101  
102 =head2 RequestCharacters => Int
103  
104 Number of billable characters synthesized.
105  
106  
107 =head2 SampleRate => Str
108  
109 The audio frequency specified in Hz.
110  
111 The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050",
112 and "24000". The default value for standard voices is "22050". The
113 default value for neural voices is "24000".
114  
115 Valid values for pcm are "8000" and "16000" The default value is
116 "16000".
117  
118  
119 =head2 SnsTopicArn => Str
120  
121 ARN for the SNS topic optionally used for providing status notification
122 for a speech synthesis task.
123  
124  
125 =head2 SpeechMarkTypes => ArrayRef[Str|Undef]
126  
127 The type of speech marks returned for the input text.
128  
129  
130 =head2 TaskId => Str
131  
132 The Amazon Polly generated identifier for a speech synthesis task.
133  
134  
135 =head2 TaskStatus => Str
136  
137 Current status of the individual speech synthesis task.
138  
139  
140 =head2 TaskStatusReason => Str
141  
142 Reason for the current status of a specific speech synthesis task,
143 including errors if the task has failed.
144  
145  
146 =head2 TextType => Str
147  
148 Specifies whether the input text is plain text or SSML. The default
149 value is plain text.
150  
151  
152 =head2 VoiceId => Str
153  
154 Voice ID to use for the synthesis.
155  
156  
157  
158 =head1 SEE ALSO
159  
160 This class forms part of L<Paws>, describing an object used in L<Paws::Polly>
161  
162 =head1 BUGS and CONTRIBUTIONS
163  
164 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
165  
166 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
167  
168 =cut
169