public interface SynthesizeSpeechConfigOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getInstruction()
public abstract String getInstruction()Optional. The instruction used to synthesize speech when using a generative model.
string instruction = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The instruction. |
getInstructionBytes()
public abstract ByteString getInstructionBytes()Optional. The instruction used to synthesize speech when using a generative model.
string instruction = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for instruction. |
getModel()
public abstract String getModel()Optional. The model used to synthesize audio. Currently supported values:
- "gemini-3.1-flash-tts-preview" If empty, Chirp3-HD is used.
string model = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The model. |
getModelBytes()
public abstract ByteString getModelBytes()Optional. The model used to synthesize audio. Currently supported values:
- "gemini-3.1-flash-tts-preview" If empty, Chirp3-HD is used.
string model = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for model. |
getSpeakingRate()
public abstract double getSpeakingRate()Optional. The speaking rate/speed in the range [0.25, 2.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. Values outside of the range [0.25, 2.0] will return an error.
double speaking_rate = 2 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
double |
The speakingRate. |
getVoice()
public abstract String getVoice()Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code.
For the list of available voices, please refer to Supported voices and languages from Cloud Text-to-Speech.
string voice = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The voice. |
getVoiceBytes()
public abstract ByteString getVoiceBytes()Optional. The name of the voice. If not set, the service will choose a voice based on the other parameters such as language_code.
For the list of available voices, please refer to Supported voices and languages from Cloud Text-to-Speech.
string voice = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for voice. |
getVoiceSampleGcsUri()
public abstract String getVoiceSampleGcsUri()Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file.
Note: Please make sure the CES service agent
service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com has
storage.objects.get permission to the Cloud Storage object.
string voice_sample_gcs_uri = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The voiceSampleGcsUri. |
getVoiceSampleGcsUriBytes()
public abstract ByteString getVoiceSampleGcsUriBytes()Optional. The Cloud Storage URI to the audio sample for voice cloning. The audio sample should be a mono-channel, 24kHz WAV file.
Note: Please make sure the CES service agent
service-<PROJECT-NUMBER>@gcp-sa-ces.iam.gserviceaccount.com has
storage.objects.get permission to the Cloud Storage object.
string voice_sample_gcs_uri = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for voiceSampleGcsUri. |