# Interface SynthesizeSpeechConfigOrBuilder (4.99.0)

4.99.0 (latest) 4.97.0 4.94.0 4.93.0 4.91.0 4.89.0 4.88.0 4.87.0 4.86.0 4.84.0 4.82.0 4.81.0 4.80.0 4.79.0 4.78.0 4.76.0 4.74.0 4.73.0 4.70.0 4.69.0 4.68.0 4.66.0 4.65.0 4.64.0 4.63.0 4.62.0 4.61.0 4.60.0 4.59.0 4.58.0 4.57.0 4.55.0 4.54.0 4.53.0 4.52.0 4.51.0 4.50.0 4.49.0 4.48.0 4.47.0 4.46.0 4.45.0 4.43.0 4.42.0 4.41.0 4.40.0 4.39.0 4.38.0 4.37.0 4.36.0 4.35.0 4.34.0 4.33.0 4.30.0 4.29.0 4.28.0 4.27.0 4.26.0 4.25.0 4.24.0 4.23.0 4.22.0 4.21.0 4.20.0 4.19.0 4.18.0 4.17.0 4.15.0 4.14.0 4.13.0 4.12.0 4.11.0 4.10.0 4.9.1 4.8.6 4.7.5 4.6.0 4.5.11 4.4.0 4.3.1

    public interface SynthesizeSpeechConfigOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## Methods

### getEffectsProfileId(int index)

    public abstract String getEffectsProfileId(int index)

Optional. An identifier which selects 'audio effects' profiles that are
applied on (post synthesized) text to speech. Effects are applied on top of
each other in the order they are given.

`repeated string effects_profile_id = 5 [(.google.api.field_behavior) = OPTIONAL];`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `index` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` The index of the element to return. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The effectsProfileId at the given index. |

### getEffectsProfileIdBytes(int index)

    public abstract ByteString getEffectsProfileIdBytes(int index)

Optional. An identifier which selects 'audio effects' profiles that are
applied on (post synthesized) text to speech. Effects are applied on top of
each other in the order they are given.

`repeated string effects_profile_id = 5 [(.google.api.field_behavior) = OPTIONAL];`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `index` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` The index of the value to return. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes of the effectsProfileId at the given index. |

### getEffectsProfileIdCount()

    public abstract int getEffectsProfileIdCount()

Optional. An identifier which selects 'audio effects' profiles that are
applied on (post synthesized) text to speech. Effects are applied on top of
each other in the order they are given.

`repeated string effects_profile_id = 5 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The count of effectsProfileId. |

### getEffectsProfileIdList()

    public abstract List<String> getEffectsProfileIdList()

Optional. An identifier which selects 'audio effects' profiles that are
applied on (post synthesized) text to speech. Effects are applied on top of
each other in the order they are given.

`repeated string effects_profile_id = 5 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>` | A list containing the effectsProfileId. |

### getPitch()

    public abstract double getPitch()

Optional. 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.

`double pitch = 2 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The pitch. |

### getPronunciations(int index)

    public abstract CustomPronunciationParams getPronunciations(int index)

Optional. The custom pronunciations for the synthesized audio.

`repeated .google.cloud.dialogflow.v2beta1.CustomPronunciationParams pronunciations = 6;
`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `index` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-dialogflow/latest/com.google.cloud.dialogflow.v2beta1.CustomPronunciationParams` |   |

### getPronunciationsCount()

    public abstract int getPronunciationsCount()

Optional. The custom pronunciations for the synthesized audio.

`repeated .google.cloud.dialogflow.v2beta1.CustomPronunciationParams pronunciations = 6;
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### getPronunciationsList()

    public abstract List<CustomPronunciationParams> getPronunciationsList()

Optional. The custom pronunciations for the synthesized audio.

`repeated .google.cloud.dialogflow.v2beta1.CustomPronunciationParams pronunciations = 6;
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-dialogflow/latest/com.google.cloud.dialogflow.v2beta1.CustomPronunciationParams>` |   |

### getPronunciationsOrBuilder(int index)

    public abstract CustomPronunciationParamsOrBuilder getPronunciationsOrBuilder(int index)

Optional. The custom pronunciations for the synthesized audio.

`repeated .google.cloud.dialogflow.v2beta1.CustomPronunciationParams pronunciations = 6;
`

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `index` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-dialogflow/latest/com.google.cloud.dialogflow.v2beta1.CustomPronunciationParamsOrBuilder` |   |

### getPronunciationsOrBuilderList()

    public abstract List<? extends CustomPronunciationParamsOrBuilder> getPronunciationsOrBuilderList()

Optional. The custom pronunciations for the synthesized audio.

`repeated .google.cloud.dialogflow.v2beta1.CustomPronunciationParams pronunciations = 6;
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<? extends com.google.cloud.dialogflow.v2beta1.CustomPronunciationParamsOrBuilder>` |   |

### getSpeakingRate()

    public abstract double getSpeakingRate()

Optional. 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 \< 0.25 or \> 4.0 will return an error.

`double speaking_rate = 1 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The speakingRate. |

### getVoice()

    public abstract VoiceSelectionParams getVoice()

Optional. The desired voice of the synthesized audio.

`
.google.cloud.dialogflow.v2beta1.VoiceSelectionParams voice = 4 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-dialogflow/latest/com.google.cloud.dialogflow.v2beta1.VoiceSelectionParams` | The voice. |

### getVoiceOrBuilder()

    public abstract VoiceSelectionParamsOrBuilder getVoiceOrBuilder()

Optional. The desired voice of the synthesized audio.

`
.google.cloud.dialogflow.v2beta1.VoiceSelectionParams voice = 4 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-dialogflow/latest/com.google.cloud.dialogflow.v2beta1.VoiceSelectionParamsOrBuilder` |   |

### getVolumeGainDb()

    public abstract double getVolumeGainDb()

Optional. 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. We strongly recommend not
to exceed +10 (dB) as there's usually no effective increase in loudness for
any value greater than that.

`double volume_gain_db = 3 [(.google.api.field_behavior) = OPTIONAL];`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | The volumeGainDb. |

### hasVoice()

    public abstract boolean hasVoice()

Optional. The desired voice of the synthesized audio.

`
.google.cloud.dialogflow.v2beta1.VoiceSelectionParams voice = 4 [(.google.api.field_behavior) = OPTIONAL];
`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` | Whether the voice field is set. |