File Coverage

blib/lib/Paws/Polly/SynthesizeSpeech.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::Polly::SynthesizeSpeech;
3 1     1   1612 use Moose;
  1         14  
  1         29  
4             has LexiconNames => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
5             has OutputFormat => (is => 'ro', isa => 'Str', required => 1);
6             has SampleRate => (is => 'ro', isa => 'Str');
7             has SpeechMarkTypes => (is => 'ro', isa => 'ArrayRef[Str|Undef]');
8             has Text => (is => 'ro', isa => 'Str', required => 1);
9             has TextType => (is => 'ro', isa => 'Str');
10             has VoiceId => (is => 'ro', isa => 'Str', required => 1);
11              
12 1     1   16916 use MooseX::ClassAttribute;
  1         4  
  1         12  
13              
14             class_has _api_call => (isa => 'Str', is => 'ro', default => 'SynthesizeSpeech');
15             class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/speech');
16             class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
17             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Polly::SynthesizeSpeechOutput');
18             class_has _result_key => (isa => 'Str', is => 'ro');
19             1;
20              
21             ### main pod documentation begin ###
22              
23             =head1 NAME
24              
25             Paws::Polly::SynthesizeSpeech - Arguments for method SynthesizeSpeech on Paws::Polly
26              
27             =head1 DESCRIPTION
28              
29             This class represents the parameters used for calling the method SynthesizeSpeech on the
30             Amazon Polly service. Use the attributes of this class
31             as arguments to method SynthesizeSpeech.
32              
33             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SynthesizeSpeech.
34              
35             As an example:
36              
37             $service_obj->SynthesizeSpeech(Att1 => $value1, Att2 => $value2, ...);
38              
39             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.
40              
41             =head1 ATTRIBUTES
42              
43              
44             =head2 LexiconNames => ArrayRef[Str|Undef]
45              
46             List of one or more pronunciation lexicon names you want the service to
47             apply during synthesis. Lexicons are applied only if the language of
48             the lexicon is the same as the language of the voice. For information
49             about storing lexicons, see PutLexicon.
50              
51              
52              
53             =head2 B<REQUIRED> OutputFormat => Str
54              
55             The format in which the returned output will be encoded. For audio
56             stream, this will be mp3, ogg_vorbis, or pcm. For speech marks, this
57             will be json.
58              
59             Valid values are: C<"json">, C<"mp3">, C<"ogg_vorbis">, C<"pcm">
60              
61             =head2 SampleRate => Str
62              
63             The audio frequency specified in Hz.
64              
65             The valid values for C<mp3> and C<ogg_vorbis> are "8000", "16000", and
66             "22050". The default value is "22050".
67              
68             Valid values for C<pcm> are "8000" and "16000" The default value is
69             "16000".
70              
71              
72              
73             =head2 SpeechMarkTypes => ArrayRef[Str|Undef]
74              
75             The type of speech marks returned for the input text.
76              
77              
78              
79             =head2 B<REQUIRED> Text => Str
80              
81             Input text to synthesize. If you specify C<ssml> as the C<TextType>,
82             follow the SSML format for the input text.
83              
84              
85              
86             =head2 TextType => Str
87              
88             Specifies whether the input text is plain text or SSML. The default
89             value is plain text. For more information, see Using SSML.
90              
91             Valid values are: C<"ssml">, C<"text">
92              
93             =head2 B<REQUIRED> VoiceId => Str
94              
95             Voice ID to use for the synthesis. You can get a list of available
96             voice IDs by calling the DescribeVoices operation.
97              
98             Valid values are: C<"Geraint">, C<"Gwyneth">, C<"Mads">, C<"Naja">, C<"Hans">, C<"Marlene">, C<"Nicole">, C<"Russell">, C<"Amy">, C<"Brian">, C<"Emma">, C<"Raveena">, C<"Ivy">, C<"Joanna">, C<"Joey">, C<"Justin">, C<"Kendra">, C<"Kimberly">, C<"Salli">, C<"Conchita">, C<"Enrique">, C<"Miguel">, C<"Penelope">, C<"Chantal">, C<"Celine">, C<"Mathieu">, C<"Dora">, C<"Karl">, C<"Carla">, C<"Giorgio">, C<"Mizuki">, C<"Liv">, C<"Lotte">, C<"Ruben">, C<"Ewa">, C<"Jacek">, C<"Jan">, C<"Maja">, C<"Ricardo">, C<"Vitoria">, C<"Cristiano">, C<"Ines">, C<"Carmen">, C<"Maxim">, C<"Tatyana">, C<"Astrid">, C<"Filiz">, C<"Vicki">
99              
100              
101             =head1 SEE ALSO
102              
103             This class forms part of L<Paws>, documenting arguments for method SynthesizeSpeech in L<Paws::Polly>
104              
105             =head1 BUGS and CONTRIBUTIONS
106              
107             The source code is located here: https://github.com/pplu/aws-sdk-perl
108              
109             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
110              
111             =cut
112