blib/lib/Paws/Transcribe/Settings.pm untested

filter: Statementstmt 0.0% 0 / 11 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 1 Podpod n/a totaltotal 0.0% 0 / 12 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
CRAP 2.0
1 # Generated by default/object.tt
2 package Paws::Transcribe::Settings;
3 use Moose;
4 has ChannelIdentification => (is => 'ro', isa => 'Bool');
5 has MaxAlternatives => (is => 'ro', isa => 'Int');
6 has MaxSpeakerLabels => (is => 'ro', isa => 'Int');
7 has ShowAlternatives => (is => 'ro', isa => 'Bool');
8 has ShowSpeakerLabels => (is => 'ro', isa => 'Bool');
9 has VocabularyFilterMethod => (is => 'ro', isa => 'Str');
10 has VocabularyFilterName => (is => 'ro', isa => 'Str');
11 has VocabularyName => (is => 'ro', isa => 'Str');
12  
13 1;
14  
15 ### main pod documentation begin ###
16  
17 =head1 NAME
18  
19 Paws::Transcribe::Settings
20  
21 =head1 USAGE
22  
23 This class represents one of two things:
24  
25 =head3 Arguments in a call to a service
26  
27 Use the attributes of this class as arguments to methods. You shouldn't make instances of this class.
28 Each attribute should be used as a named argument in the calls that expect this type of object.
29  
30 As an example, if Att1 is expected to be a Paws::Transcribe::Settings object:
31  
32 $service_obj->Method(Att1 => { ChannelIdentification => $value, ..., VocabularyName => $value });
33  
34 =head3 Results returned from an API call
35  
36 Use accessors for each attribute. If Att1 is expected to be an Paws::Transcribe::Settings object:
37  
38 $result = $service_obj->Method(...);
39 $result->Att1->ChannelIdentification
40  
41 =head1 DESCRIPTION
42  
43 Provides optional settings for the C<StartTranscriptionJob> operation.
44  
45 =head1 ATTRIBUTES
46  
47  
48 =head2 ChannelIdentification => Bool
49  
50 Instructs Amazon Transcribe to process each audio channel separately
51 and then merge the transcription output of each channel into a single
52 transcription.
53  
54 Amazon Transcribe also produces a transcription of each item detected
55 on an audio channel, including the start time and end time of the item
56 and alternative transcriptions of the item including the confidence
57 that Amazon Transcribe has in the transcription.
58  
59 You can't set both C<ShowSpeakerLabels> and C<ChannelIdentification> in
60 the same request. If you set both, your request returns a
61 C<BadRequestException>.
62  
63  
64 =head2 MaxAlternatives => Int
65  
66 The number of alternative transcriptions that the service should
67 return. If you specify the C<MaxAlternatives> field, you must set the
68 C<ShowAlternatives> field to true.
69  
70  
71 =head2 MaxSpeakerLabels => Int
72  
73 The maximum number of speakers to identify in the input audio. If there
74 are more speakers in the audio than this number, multiple speakers are
75 identified as a single speaker. If you specify the C<MaxSpeakerLabels>
76 field, you must set the C<ShowSpeakerLabels> field to true.
77  
78  
79 =head2 ShowAlternatives => Bool
80  
81 Determines whether the transcription contains alternative
82 transcriptions. If you set the C<ShowAlternatives> field to true, you
83 must also set the maximum number of alternatives to return in the
84 C<MaxAlternatives> field.
85  
86  
87 =head2 ShowSpeakerLabels => Bool
88  
89 Determines whether the transcription job uses speaker recognition to
90 identify different speakers in the input audio. Speaker recognition
91 labels individual speakers in the audio file. If you set the
92 C<ShowSpeakerLabels> field to true, you must also set the maximum
93 number of speaker labels C<MaxSpeakerLabels> field.
94  
95 You can't set both C<ShowSpeakerLabels> and C<ChannelIdentification> in
96 the same request. If you set both, your request returns a
97 C<BadRequestException>.
98  
99  
100 =head2 VocabularyFilterMethod => Str
101  
102 Set to C<mask> to remove filtered text from the transcript and replace
103 it with three asterisks ("***") as placeholder text. Set to C<remove>
104 to remove filtered text from the transcript without using placeholder
105 text. Set to C<tag> to mark the word in the transcription output that
106 matches the vocabulary filter. When you set the filter method to
107 C<tag>, the words matching your vocabulary filter are not masked or
108 removed.
109  
110  
111 =head2 VocabularyFilterName => Str
112  
113 The name of the vocabulary filter to use when transcribing the audio.
114 The filter that you specify must have the same language code as the
115 transcription job.
116  
117  
118 =head2 VocabularyName => Str
119  
120 The name of a vocabulary to use when processing the transcription job.
121  
122  
123  
124 =head1 SEE ALSO
125  
126 This class forms part of L<Paws>, describing an object used in L<Paws::Transcribe>
127  
128 =head1 BUGS and CONTRIBUTIONS
129  
130 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
131  
132 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
133  
134 =cut
135