Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 33237a8250e3becfaa1e4b5f67ef0c887cfc44a9 / . / docs / dyn / texttospeech_v1beta1.text.html
blob: f9c67f832150e58b21a8b252f48127bff0d4ef67 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="texttospeech_v1beta1.html">Cloud Text-to-Speech API</a> . <a href="texttospeech_v1beta1.text.html">text</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#synthesize">synthesize(body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Synthesizes speech synchronously: receive results after all text input has been processed.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<h3>Method Details</h3>
84<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85 <code class="details" id="close">close()</code>
86 <pre>Close httplib2 connections.</pre>
87</div>
88
89<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]90 <code class="details" id="synthesize">synthesize(body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91 <pre>Synthesizes speech synchronously: receive results after all text input has been processed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92
93Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]94 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]95 The object takes the form of:
96
97{ # The top-level message sent by the client for the `SynthesizeSpeech` method.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]98 &quot;audioConfig&quot;: { # Description of audio data to be synthesized. # Required. The configuration of the synthesized audio.
99 &quot;audioEncoding&quot;: &quot;A String&quot;, # Required. The format of the audio byte stream.
100 &quot;effectsProfileId&quot;: [ # Optional. Input only. An identifier which selects &#x27;audio effects&#x27; 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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]101 &quot;A String&quot;,
102 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]103 &quot;pitch&quot;: 3.14, # 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.
104 &quot;sampleRateHertz&quot;: 42, # Optional. The synthesis sample rate (in hertz) for this audio. When this is specified in SynthesizeSpeechRequest, if this is different from the voice&#x27;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.
105 &quot;speakingRate&quot;: 3.14, # 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 &lt; 0.25 or &gt; 4.0 will return an error.
106 &quot;volumeGainDb&quot;: 3.14, # 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&#x27;s usually no effective increase in loudness for any value greater than that.
107 },
108 &quot;enableTimePointing&quot;: [ # Whether and what timepoints are returned in the response.
109 &quot;A String&quot;,
110 ],
111 &quot;input&quot;: { # Contains text input to be synthesized. Either `text` or `ssml` must be supplied. Supplying both or neither returns google.rpc.Code.INVALID_ARGUMENT. The input size is limited to 5000 characters. # Required. The Synthesizer requires either plain text or SSML as input.
112 &quot;ssml&quot;: &quot;A String&quot;, # The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return google.rpc.Code.INVALID_ARGUMENT. For more information, see [SSML](https://cloud.google.com/text-to-speech/docs/ssml).
113 &quot;text&quot;: &quot;A String&quot;, # The raw text to be synthesized.
114 },
115 &quot;voice&quot;: { # Description of which voice to use for a synthesis request. # Required. The desired voice of the synthesized audio.
116 &quot;languageCode&quot;: &quot;A String&quot;, # Required. The language (and potentially also the region) of the voice expressed as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g. &quot;en-US&quot;. This should not include a script tag (e.g. use &quot;cmn-cn&quot; rather than &quot;cmn-Hant-cn&quot;), because the script will be inferred from the input provided in the SynthesisInput. The TTS service will use this parameter to help choose an appropriate voice. Note that the TTS service may choose a voice with a slightly different language code than the one selected; it may substitute a different region (e.g. using en-US rather than en-CA if there isn&#x27;t a Canadian voice available), or even a different language, e.g. using &quot;nb&quot; (Norwegian Bokmal) instead of &quot;no&quot; (Norwegian)&quot;.
117 &quot;name&quot;: &quot;A String&quot;, # The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and gender.
118 &quot;ssmlGender&quot;: &quot;A String&quot;, # The preferred gender of the voice. If not set, the service will choose a voice based on the other parameters such as language_code and name. Note that this is only a preference, not requirement; if a voice of the appropriate gender is not available, the synthesizer should substitute a voice with a different gender rather than failing the request.
119 },
120}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]121
122 x__xgafv: string, V1 error format.
123 Allowed values
124 1 - v1 error format
125 2 - v2 error format
126
127Returns:
128 An object of the form:
129
130 { # The message returned to the client by the `SynthesizeSpeech` method.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]131 &quot;audioConfig&quot;: { # Description of audio data to be synthesized. # The audio metadata of `audio_content`.
132 &quot;audioEncoding&quot;: &quot;A String&quot;, # Required. The format of the audio byte stream.
133 &quot;effectsProfileId&quot;: [ # Optional. Input only. An identifier which selects &#x27;audio effects&#x27; 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.
134 &quot;A String&quot;,
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]135 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]136 &quot;pitch&quot;: 3.14, # 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.
137 &quot;sampleRateHertz&quot;: 42, # Optional. The synthesis sample rate (in hertz) for this audio. When this is specified in SynthesizeSpeechRequest, if this is different from the voice&#x27;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.
138 &quot;speakingRate&quot;: 3.14, # 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 &lt; 0.25 or &gt; 4.0 will return an error.
139 &quot;volumeGainDb&quot;: 3.14, # 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&#x27;s usually no effective increase in loudness for any value greater than that.
140 },
141 &quot;audioContent&quot;: &quot;A String&quot;, # The audio data bytes encoded as specified in the request, including the header for encodings that are wrapped in containers (e.g. MP3, OGG_OPUS). For LINEAR16 audio, we include the WAV header. Note: as with all bytes fields, protobuffers use a pure binary representation, whereas JSON representations use base64.
yoshi-code-bot87595382021-06-05 00:38:05 -0700[diff] [blame]142 &quot;timepoints&quot;: [ # A link between a position in the original request input and a corresponding time in the output audio. It&#x27;s only supported via `` of SSML input.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]143 { # This contains a mapping between a certain point in the input text and a corresponding time in the output audio.
yoshi-code-bot87595382021-06-05 00:38:05 -0700[diff] [blame]144 &quot;markName&quot;: &quot;A String&quot;, # Timepoint name as received from the client within `` tag.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]145 &quot;timeSeconds&quot;: 3.14, # Time offset in seconds from the start of the synthesized audio.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]146 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]147 ],
148}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]149</div>
150
151</body></html>