This repository has been archived by the owner on Sep 16, 2023. It is now read-only.
/
AudioConfigOrBuilder.java
209 lines (201 loc) · 6.79 KB
/
AudioConfigOrBuilder.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
/*
* Copyright 2019 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/cloud/texttospeech/v1/cloud_tts.proto
package com.google.cloud.texttospeech.v1;
public interface AudioConfigOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.cloud.texttospeech.v1.AudioConfig)
com.google.protobuf.MessageOrBuilder {
/**
*
*
* <pre>
* Required. The format of the audio byte stream.
* </pre>
*
* <code>
* .google.cloud.texttospeech.v1.AudioEncoding audio_encoding = 1 [(.google.api.field_behavior) = REQUIRED];
* </code>
*
* @return The enum numeric value on the wire for audioEncoding.
*/
int getAudioEncodingValue();
/**
*
*
* <pre>
* Required. The format of the audio byte stream.
* </pre>
*
* <code>
* .google.cloud.texttospeech.v1.AudioEncoding audio_encoding = 1 [(.google.api.field_behavior) = REQUIRED];
* </code>
*
* @return The audioEncoding.
*/
com.google.cloud.texttospeech.v1.AudioEncoding getAudioEncoding();
/**
*
*
* <pre>
* Optional. Input only. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is
* the normal native speed supported by the specific voice. 2.0 is twice as
* fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0
* speed. Any other values < 0.25 or > 4.0 will return an error.
* </pre>
*
* <code>
* double speaking_rate = 2 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
* </code>
*
* @return The speakingRate.
*/
double getSpeakingRate();
/**
*
*
* <pre>
* Optional. Input only. Speaking pitch, in the range [-20.0, 20.0]. 20 means
* increase 20 semitones from the original pitch. -20 means decrease 20
* semitones from the original pitch.
* </pre>
*
* <code>
* double pitch = 3 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
* </code>
*
* @return The pitch.
*/
double getPitch();
/**
*
*
* <pre>
* Optional. Input only. Volume gain (in dB) of the normal native volume
* supported by the specific voice, in the range [-96.0, 16.0]. If unset, or
* set to a value of 0.0 (dB), will play at normal native signal amplitude. A
* value of -6.0 (dB) will play at approximately half the amplitude of the
* normal native signal amplitude. A value of +6.0 (dB) will play at
* approximately twice the amplitude of the normal native signal amplitude.
* Strongly recommend not to exceed +10 (dB) as there's usually no effective
* increase in loudness for any value greater than that.
* </pre>
*
* <code>
* double volume_gain_db = 4 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
* </code>
*
* @return The volumeGainDb.
*/
double getVolumeGainDb();
/**
*
*
* <pre>
* Optional. The synthesis sample rate (in hertz) for this audio. When this is
* specified in SynthesizeSpeechRequest, if this is different from the voice's
* natural sample rate, then the synthesizer will honor this request by
* converting to the desired sample rate (which might result in worse audio
* quality), unless the specified sample rate is not supported for the
* encoding chosen, in which case it will fail the request and return
* [google.rpc.Code.INVALID_ARGUMENT][].
* </pre>
*
* <code>int32 sample_rate_hertz = 5 [(.google.api.field_behavior) = OPTIONAL];</code>
*
* @return The sampleRateHertz.
*/
int getSampleRateHertz();
/**
*
*
* <pre>
* Optional. Input only. An identifier which selects 'audio effects' profiles
* that are applied on (post synthesized) text to speech. Effects are applied
* on top of each other in the order they are given. See
* [audio
* profiles](https://cloud.google.com/text-to-speech/docs/audio-profiles) for
* current supported profile ids.
* </pre>
*
* <code>
* repeated string effects_profile_id = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
* </code>
*
* @return A list containing the effectsProfileId.
*/
java.util.List<java.lang.String> getEffectsProfileIdList();
/**
*
*
* <pre>
* Optional. Input only. An identifier which selects 'audio effects' profiles
* that are applied on (post synthesized) text to speech. Effects are applied
* on top of each other in the order they are given. See
* [audio
* profiles](https://cloud.google.com/text-to-speech/docs/audio-profiles) for
* current supported profile ids.
* </pre>
*
* <code>
* repeated string effects_profile_id = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
* </code>
*
* @return The count of effectsProfileId.
*/
int getEffectsProfileIdCount();
/**
*
*
* <pre>
* Optional. Input only. An identifier which selects 'audio effects' profiles
* that are applied on (post synthesized) text to speech. Effects are applied
* on top of each other in the order they are given. See
* [audio
* profiles](https://cloud.google.com/text-to-speech/docs/audio-profiles) for
* current supported profile ids.
* </pre>
*
* <code>
* repeated string effects_profile_id = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
* </code>
*
* @param index The index of the element to return.
* @return The effectsProfileId at the given index.
*/
java.lang.String getEffectsProfileId(int index);
/**
*
*
* <pre>
* Optional. Input only. An identifier which selects 'audio effects' profiles
* that are applied on (post synthesized) text to speech. Effects are applied
* on top of each other in the order they are given. See
* [audio
* profiles](https://cloud.google.com/text-to-speech/docs/audio-profiles) for
* current supported profile ids.
* </pre>
*
* <code>
* repeated string effects_profile_id = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];
* </code>
*
* @param index The index of the value to return.
* @return The bytes of the effectsProfileId at the given index.
*/
com.google.protobuf.ByteString getEffectsProfileIdBytes(int index);
}