blob: ea3f74a75cea2922fae01846fe9788f55e2345cd [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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_v1.html">Cloud Text-to-Speech API</a> . <a href="texttospeech_v1.voices.html">voices</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#list">list(languageCode=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Returns a list of Voice supported for synthesis.</p>
80<h3>Method Details</h3>
81<div class="method">
82 <code class="details" id="list">list(languageCode=None, x__xgafv=None)</code>
83 <pre>Returns a list of Voice supported for synthesis.
84
85Args:
Dan O'Mearadd494642020-05-01 07:42:23 -070086 languageCode: string, Optional. Recommended.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070087[BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag. If
88specified, the ListVoices call will only return voices that can be used to
Bu Sun Kim65020912020-05-20 12:08:20 -070089synthesize this language_code. E.g. when specifying &quot;en-NZ&quot;, you will get
90supported &quot;en-*&quot; voices; when specifying &quot;no&quot;, you will get supported
91&quot;no-*&quot; (Norwegian) and &quot;nb-*&quot; (Norwegian Bokmal) voices; specifying &quot;zh&quot;
92will also get supported &quot;cmn-*&quot; voices; specifying &quot;zh-hk&quot; will also get
93supported &quot;yue-*&quot; voices.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070094 x__xgafv: string, V1 error format.
95 Allowed values
96 1 - v1 error format
97 2 - v2 error format
98
99Returns:
100 An object of the form:
101
102 { # The message returned to the client by the `ListVoices` method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700103 &quot;voices&quot;: [ # The list of voices.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700104 { # Description of a voice supported by the TTS service.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700105 &quot;name&quot;: &quot;A String&quot;, # The name of this voice. Each distinct voice has a unique name.
106 &quot;ssmlGender&quot;: &quot;A String&quot;, # The gender of this voice.
Bu Sun Kim65020912020-05-20 12:08:20 -0700107 &quot;languageCodes&quot;: [ # The languages that this voice supports, expressed as
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700108 # [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags (e.g.
Bu Sun Kim65020912020-05-20 12:08:20 -0700109 # &quot;en-US&quot;, &quot;es-419&quot;, &quot;cmn-tw&quot;).
110 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700111 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700112 &quot;naturalSampleRateHertz&quot;: 42, # The natural sample rate (in hertz) for this voice.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700113 },
114 ],
115 }</pre>
116</div>
117
118</body></html>