Reference documentation and code samples for the Cloud Text-to-Speech V1 Client class VoiceSelectionParams.
Description of which voice to use for a synthesis request.
Generated from protobuf message google.cloud.texttospeech.v1.VoiceSelectionParams
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ language_code |
string
Required. The language (and potentially also the region) of the voice expressed as a BCP-47 language tag, e.g. "en-US". This should not include a script tag (e.g. use "cmn-cn" rather than "cmn-Hant-cn"), 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't a Canadian voice available), or even a different language, e.g. using "nb" (Norwegian Bokmal) instead of "no" (Norwegian)". |
↳ name |
string
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. |
↳ ssml_gender |
int
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. |
↳ custom_voice |
Google\Cloud\TextToSpeech\V1\CustomVoiceParams
The configuration for a custom voice. If [CustomVoiceParams.model] is set, the service will choose the custom voice matching the specified configuration. |
getLanguageCode
Required. The language (and potentially also the region) of the voice expressed as a BCP-47 language tag, e.g.
"en-US". This should not include a script tag (e.g. use "cmn-cn" rather than "cmn-Hant-cn"), 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't a Canadian voice available), or even a different language, e.g. using "nb" (Norwegian Bokmal) instead of "no" (Norwegian)".
Generated from protobuf field string language_code = 1 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setLanguageCode
Required. The language (and potentially also the region) of the voice expressed as a BCP-47 language tag, e.g.
"en-US". This should not include a script tag (e.g. use "cmn-cn" rather than "cmn-Hant-cn"), 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't a Canadian voice available), or even a different language, e.g. using "nb" (Norwegian Bokmal) instead of "no" (Norwegian)".
Generated from protobuf field string language_code = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getName
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.
Generated from protobuf field string name = 2;
| Returns | |
|---|---|
| Type | Description |
string | |
setName
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.
Generated from protobuf field string name = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSsmlGender
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.
Generated from protobuf field .google.cloud.texttospeech.v1.SsmlVoiceGender ssml_gender = 3;
| Returns | |
|---|---|
| Type | Description |
int | |
setSsmlGender
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.
Generated from protobuf field .google.cloud.texttospeech.v1.SsmlVoiceGender ssml_gender = 3;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getCustomVoice
The configuration for a custom voice. If [CustomVoiceParams.model] is set, the service will choose the custom voice matching the specified configuration.
Generated from protobuf field .google.cloud.texttospeech.v1.CustomVoiceParams custom_voice = 4;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\TextToSpeech\V1\CustomVoiceParams|null | |
hasCustomVoice
clearCustomVoice
setCustomVoice
The configuration for a custom voice. If [CustomVoiceParams.model] is set, the service will choose the custom voice matching the specified configuration.
Generated from protobuf field .google.cloud.texttospeech.v1.CustomVoiceParams custom_voice = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\TextToSpeech\V1\CustomVoiceParams
|
| Returns | |
|---|---|
| Type | Description |
$this | |