blob: 08d0b29d9659631498bf060cea2f49d0ef558325 [file] [edit]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="texttospeech_v1beta1.html">Cloud Text-to-Speech API</a> . <a href="texttospeech_v1beta1.voices.html">voices</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#generateVoiceCloningKey">generateVoiceCloningKey(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Generates voice clone key given a short voice prompt. This method validates the voice prompts with a series of checks against the voice talent statement to verify the voice clone is safe to generate.</p>
<p class="toc_element">
<code><a href="#list">list(languageCode=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns a list of Voice supported for synthesis.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="generateVoiceCloningKey">generateVoiceCloningKey(body=None, x__xgafv=None)</code>
<pre>Generates voice clone key given a short voice prompt. This method validates the voice prompts with a series of checks against the voice talent statement to verify the voice clone is safe to generate.
Args:
body: object, The request body.
The object takes the form of:
{ # Request message for the `GenerateVoiceCloningKey` method.
&quot;consentScript&quot;: &quot;A String&quot;, # Required. The script used for the voice talent statement. The script will be provided to the caller through other channels. It must be returned unchanged in this field.
&quot;languageCode&quot;: &quot;A String&quot;, # Required. The language of the supplied audio as a [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. Example: &quot;en-US&quot;. See [Language Support](https://cloud.google.com/speech-to-text/docs/languages) for a list of the currently supported language codes.
&quot;referenceAudio&quot;: { # Holds audio content and config. # Required. The training audio used to create voice clone. This is currently limited to LINEAR16 PCM WAV files mono audio with 24khz sample rate. This needs to be specified in [InputAudio.audio_config], other values will be explicitly rejected.
&quot;audioConfig&quot;: { # Description of inputted audio data. # Required. Provides information that specifies how to process content.
&quot;audioEncoding&quot;: &quot;A String&quot;, # Required. The format of the audio byte stream.
&quot;sampleRateHertz&quot;: 42, # Required. The sample rate (in hertz) for this audio.
},
&quot;content&quot;: &quot;A String&quot;, # Required. The audio data bytes encoded as specified in `InputAudioConfig`. Note: as with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64. Audio samples should be between 5-25 seconds in length.
},
&quot;voiceTalentConsent&quot;: { # Holds audio content and config. # Required. The voice talent audio used to verify consent to voice clone.
&quot;audioConfig&quot;: { # Description of inputted audio data. # Required. Provides information that specifies how to process content.
&quot;audioEncoding&quot;: &quot;A String&quot;, # Required. The format of the audio byte stream.
&quot;sampleRateHertz&quot;: 42, # Required. The sample rate (in hertz) for this audio.
},
&quot;content&quot;: &quot;A String&quot;, # Required. The audio data bytes encoded as specified in `InputAudioConfig`. Note: as with all bytes fields, proto buffers use a pure binary representation, whereas JSON representations use base64. Audio samples should be between 5-25 seconds in length.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for the `GenerateVoiceCloningKey` method.
&quot;voiceCloningKey&quot;: &quot;A String&quot;, # The voice clone key. Use it in the SynthesizeSpeechRequest by setting [voice.voice_clone.voice_cloning_key].
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(languageCode=None, x__xgafv=None)</code>
<pre>Returns a list of Voice supported for synthesis.
Args:
languageCode: string, Optional. Recommended. [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If not specified, the API will return all supported voices. If specified, the ListVoices call will only return voices that can be used to synthesize this language_code. For example, if you specify `&quot;en-NZ&quot;`, all `&quot;en-NZ&quot;` voices will be returned. If you specify `&quot;no&quot;`, both `&quot;no-\*&quot;` (Norwegian) and `&quot;nb-\*&quot;` (Norwegian Bokmal) voices will be returned.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The message returned to the client by the `ListVoices` method.
&quot;voices&quot;: [ # The list of voices.
{ # Description of a voice supported by the TTS service.
&quot;languageCodes&quot;: [ # The languages that this voice supports, expressed as [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags (e.g. &quot;en-US&quot;, &quot;es-419&quot;, &quot;cmn-tw&quot;).
&quot;A String&quot;,
],
&quot;name&quot;: &quot;A String&quot;, # The name of this voice. Each distinct voice has a unique name.
&quot;naturalSampleRateHertz&quot;: 42, # The natural sample rate (in hertz) for this voice.
&quot;ssmlGender&quot;: &quot;A String&quot;, # The gender of this voice.
},
],
}</pre>
</div>
</body></html>