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

filter: Statementstmt 0.0% 0 / 22 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 24 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::Polly::StartSpeechSynthesisTask;
3 use Moose;
4 has Engine => (is => 'ro', isa => 'Str');
5 has LanguageCode => (is => 'ro', isa => 'Str');
6 has LexiconNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
7 has OutputFormat => (is => 'ro', isa => 'Str', required => 1);
8 has OutputS3BucketName => (is => 'ro', isa => 'Str', required => 1);
9 has OutputS3KeyPrefix => (is => 'ro', isa => 'Str');
10 has SampleRate => (is => 'ro', isa => 'Str');
11 has SnsTopicArn => (is => 'ro', isa => 'Str');
12 has SpeechMarkTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
13 has Text => (is => 'ro', isa => 'Str', required => 1);
14 has TextType => (is => 'ro', isa => 'Str');
15 has VoiceId => (is => 'ro', isa => 'Str', required => 1);
16  
17 use MooseX::ClassAttribute;
18  
19 class_has _api_call => (isa => 'Str', is => 'ro', default => 'StartSpeechSynthesisTask');
20 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/synthesisTasks');
21 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
22 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Polly::StartSpeechSynthesisTaskOutput');
23 1;
24  
25 ### main pod documentation begin ###
26  
27 =head1 NAME
28  
29 Paws::Polly::StartSpeechSynthesisTask - Arguments for method StartSpeechSynthesisTask on L<Paws::Polly>
30  
31 =head1 DESCRIPTION
32  
33 This class represents the parameters used for calling the method StartSpeechSynthesisTask on the
34 L<Amazon Polly|Paws::Polly> service. Use the attributes of this class
35 as arguments to method StartSpeechSynthesisTask.
36  
37 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartSpeechSynthesisTask.
38  
39 =head1 SYNOPSIS
40  
41 my $polly = Paws->service('Polly');
42 my $StartSpeechSynthesisTaskOutput = $polly->StartSpeechSynthesisTask(
43 OutputFormat => 'json',
44 OutputS3BucketName => 'MyOutputS3BucketName',
45 Text => 'MyText',
46 VoiceId => 'Aditi',
47 Engine => 'standard', # OPTIONAL
48 LanguageCode => 'arb', # OPTIONAL
49 LexiconNames => [ 'MyLexiconName', ... ], # OPTIONAL
50 OutputS3KeyPrefix => 'MyOutputS3KeyPrefix', # OPTIONAL
51 SampleRate => 'MySampleRate', # OPTIONAL
52 SnsTopicArn => 'MySnsTopicArn', # OPTIONAL
53 SpeechMarkTypes => [
54 'sentence', ... # values: sentence, ssml, viseme, word
55 ], # OPTIONAL
56 TextType => 'ssml', # OPTIONAL
57 );
58  
59 # Results:
60 my $SynthesisTask = $StartSpeechSynthesisTaskOutput->SynthesisTask;
61  
62 # Returns a L<Paws::Polly::StartSpeechSynthesisTaskOutput> object.
63  
64 Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.
65 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/polly/StartSpeechSynthesisTask>
66  
67 =head1 ATTRIBUTES
68  
69  
70 =head2 Engine => Str
71  
72 Specifies the engine (C<standard> or C<neural>) for Amazon Polly to use
73 when processing input text for speech synthesis. Using a voice that is
74 not supported for the engine selected will result in an error.
75  
76 Valid values are: C<"standard">, C<"neural">
77  
78 =head2 LanguageCode => Str
79  
80 Optional language code for the Speech Synthesis request. This is only
81 necessary if using a bilingual voice, such as Aditi, which can be used
82 for either Indian English (en-IN) or Hindi (hi-IN).
83  
84 If a bilingual voice is used and no language code is specified, Amazon
85 Polly will use the default language of the bilingual voice. The default
86 language for any voice is the one returned by the DescribeVoices
87 (https://docs.aws.amazon.com/polly/latest/dg/API_DescribeVoices.html)
88 operation for the C<LanguageCode> parameter. For example, if no
89 language code is specified, Aditi will use Indian English rather than
90 Hindi.
91  
92 Valid values are: C<"arb">, C<"cmn-CN">, C<"cy-GB">, C<"da-DK">, C<"de-DE">, C<"en-AU">, C<"en-GB">, C<"en-GB-WLS">, C<"en-IN">, C<"en-US">, C<"es-ES">, C<"es-MX">, C<"es-US">, C<"fr-CA">, C<"fr-FR">, C<"is-IS">, C<"it-IT">, C<"ja-JP">, C<"hi-IN">, C<"ko-KR">, C<"nb-NO">, C<"nl-NL">, C<"pl-PL">, C<"pt-BR">, C<"pt-PT">, C<"ro-RO">, C<"ru-RU">, C<"sv-SE">, C<"tr-TR">
93  
94 =head2 LexiconNames => ArrayRef[Str|Undef]
95  
96 List of one or more pronunciation lexicon names you want the service to
97 apply during synthesis. Lexicons are applied only if the language of
98 the lexicon is the same as the language of the voice.
99  
100  
101  
102 =head2 B<REQUIRED> OutputFormat => Str
103  
104 The format in which the returned output will be encoded. For audio
105 stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this
106 will be json.
107  
108 Valid values are: C<"json">, C<"mp3">, C<"ogg_vorbis">, C<"pcm">
109  
110 =head2 B<REQUIRED> OutputS3BucketName => Str
111  
112 Amazon S3 bucket name to which the output file will be saved.
113  
114  
115  
116 =head2 OutputS3KeyPrefix => Str
117  
118 The Amazon S3 key prefix for the output speech file.
119  
120  
121  
122 =head2 SampleRate => Str
123  
124 The audio frequency specified in Hz.
125  
126 The valid values for mp3 and ogg_vorbis are "8000", "16000", "22050",
127 and "24000". The default value for standard voices is "22050". The
128 default value for neural voices is "24000".
129  
130 Valid values for pcm are "8000" and "16000" The default value is
131 "16000".
132  
133  
134  
135 =head2 SnsTopicArn => Str
136  
137 ARN for the SNS topic optionally used for providing status notification
138 for a speech synthesis task.
139  
140  
141  
142 =head2 SpeechMarkTypes => ArrayRef[Str|Undef]
143  
144 The type of speech marks returned for the input text.
145  
146  
147  
148 =head2 B<REQUIRED> Text => Str
149  
150 The input text to synthesize. If you specify ssml as the TextType,
151 follow the SSML format for the input text.
152  
153  
154  
155 =head2 TextType => Str
156  
157 Specifies whether the input text is plain text or SSML. The default
158 value is plain text.
159  
160 Valid values are: C<"ssml">, C<"text">
161  
162 =head2 B<REQUIRED> VoiceId => Str
163  
164 Voice ID to use for the synthesis.
165  
166 Valid values are: C<"Aditi">, C<"Amy">, C<"Astrid">, C<"Bianca">, C<"Brian">, C<"Camila">, C<"Carla">, C<"Carmen">, C<"Celine">, C<"Chantal">, C<"Conchita">, C<"Cristiano">, C<"Dora">, C<"Emma">, C<"Enrique">, C<"Ewa">, C<"Filiz">, C<"Gabrielle">, C<"Geraint">, C<"Giorgio">, C<"Gwyneth">, C<"Hans">, C<"Ines">, C<"Ivy">, C<"Jacek">, C<"Jan">, C<"Joanna">, C<"Joey">, C<"Justin">, C<"Karl">, C<"Kendra">, C<"Kevin">, C<"Kimberly">, C<"Lea">, C<"Liv">, C<"Lotte">, C<"Lucia">, C<"Lupe">, C<"Mads">, C<"Maja">, C<"Marlene">, C<"Mathieu">, C<"Matthew">, C<"Maxim">, C<"Mia">, C<"Miguel">, C<"Mizuki">, C<"Naja">, C<"Nicole">, C<"Olivia">, C<"Penelope">, C<"Raveena">, C<"Ricardo">, C<"Ruben">, C<"Russell">, C<"Salli">, C<"Seoyeon">, C<"Takumi">, C<"Tatyana">, C<"Vicki">, C<"Vitoria">, C<"Zeina">, C<"Zhiyu">
167  
168  
169 =head1 SEE ALSO
170  
171 This class forms part of L<Paws>, documenting arguments for method StartSpeechSynthesisTask in L<Paws::Polly>
172  
173 =head1 BUGS and CONTRIBUTIONS
174  
175 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
176  
177 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
178  
179 =cut
180