Class SynthesizeSpeechConfig.Builder (4.46.0)

public static final class SynthesizeSpeechConfig.Builder extends GeneratedMessageV3.Builder<SynthesizeSpeechConfig.Builder> implements SynthesizeSpeechConfigOrBuilder

Configuration of how speech should be synthesized.

Protobuf type google.cloud.dialogflow.v2.SynthesizeSpeechConfig

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllEffectsProfileId(Iterable<String> values)

public SynthesizeSpeechConfig.Builder addAllEffectsProfileId(Iterable<String> values)

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
values Iterable<String>

The effectsProfileId to add.

Returns
Type Description
SynthesizeSpeechConfig.Builder

This builder for chaining.

addEffectsProfileId(String value)

public SynthesizeSpeechConfig.Builder addEffectsProfileId(String value)

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
value String

The effectsProfileId to add.

Returns
Type Description
SynthesizeSpeechConfig.Builder

This builder for chaining.

addEffectsProfileIdBytes(ByteString value)

public SynthesizeSpeechConfig.Builder addEffectsProfileIdBytes(ByteString value)

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
value ByteString

The bytes of the effectsProfileId to add.

Returns
Type Description
SynthesizeSpeechConfig.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SynthesizeSpeechConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SynthesizeSpeechConfig.Builder
Overrides

build()

public SynthesizeSpeechConfig build()
Returns
Type Description
SynthesizeSpeechConfig

buildPartial()

public SynthesizeSpeechConfig buildPartial()
Returns
Type Description
SynthesizeSpeechConfig

clear()

public SynthesizeSpeechConfig.Builder clear()
Returns
Type Description
SynthesizeSpeechConfig.Builder
Overrides

clearEffectsProfileId()

public SynthesizeSpeechConfig.Builder clearEffectsProfileId()

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
SynthesizeSpeechConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SynthesizeSpeechConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
SynthesizeSpeechConfig.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SynthesizeSpeechConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
SynthesizeSpeechConfig.Builder
Overrides

clearPitch()

public SynthesizeSpeechConfig.Builder clearPitch()

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
SynthesizeSpeechConfig.Builder

This builder for chaining.

clearSpeakingRate()

public SynthesizeSpeechConfig.Builder clearSpeakingRate()

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
SynthesizeSpeechConfig.Builder

This builder for chaining.

clearVoice()

public SynthesizeSpeechConfig.Builder clearVoice()

Optional. The desired voice of the synthesized audio.

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

Returns
Type Description
SynthesizeSpeechConfig.Builder

clearVolumeGainDb()

public SynthesizeSpeechConfig.Builder clearVolumeGainDb()

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
SynthesizeSpeechConfig.Builder

This builder for chaining.

clone()

public SynthesizeSpeechConfig.Builder clone()
Returns
Type Description
SynthesizeSpeechConfig.Builder
Overrides

getDefaultInstanceForType()

public SynthesizeSpeechConfig getDefaultInstanceForType()
Returns
Type Description
SynthesizeSpeechConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getEffectsProfileId(int index)

public 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 int

The index of the element to return.

Returns
Type Description
String

The effectsProfileId at the given index.

getEffectsProfileIdBytes(int index)

public 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 int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the effectsProfileId at the given index.

getEffectsProfileIdCount()

public 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
int

The count of effectsProfileId.

getEffectsProfileIdList()

public ProtocolStringList 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
ProtocolStringList

A list containing the effectsProfileId.

getPitch()

public 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
double

The pitch.

getSpeakingRate()

public 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
double

The speakingRate.

getVoice()

public VoiceSelectionParams getVoice()

Optional. The desired voice of the synthesized audio.

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

Returns
Type Description
VoiceSelectionParams

The voice.

getVoiceBuilder()

public VoiceSelectionParams.Builder getVoiceBuilder()

Optional. The desired voice of the synthesized audio.

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

Returns
Type Description
VoiceSelectionParams.Builder

getVoiceOrBuilder()

public VoiceSelectionParamsOrBuilder getVoiceOrBuilder()

Optional. The desired voice of the synthesized audio.

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

Returns
Type Description
VoiceSelectionParamsOrBuilder

getVolumeGainDb()

public 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
double

The volumeGainDb.

hasVoice()

public boolean hasVoice()

Optional. The desired voice of the synthesized audio.

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

Returns
Type Description
boolean

Whether the voice field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(SynthesizeSpeechConfig other)

public SynthesizeSpeechConfig.Builder mergeFrom(SynthesizeSpeechConfig other)
Parameter
Name Description
other SynthesizeSpeechConfig
Returns
Type Description
SynthesizeSpeechConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SynthesizeSpeechConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SynthesizeSpeechConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SynthesizeSpeechConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SynthesizeSpeechConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SynthesizeSpeechConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SynthesizeSpeechConfig.Builder
Overrides

mergeVoice(VoiceSelectionParams value)

public SynthesizeSpeechConfig.Builder mergeVoice(VoiceSelectionParams value)

Optional. The desired voice of the synthesized audio.

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

Parameter
Name Description
value VoiceSelectionParams
Returns
Type Description
SynthesizeSpeechConfig.Builder

setEffectsProfileId(int index, String value)

public SynthesizeSpeechConfig.Builder setEffectsProfileId(int index, String value)

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];

Parameters
Name Description
index int

The index to set the value at.

value String

The effectsProfileId to set.

Returns
Type Description
SynthesizeSpeechConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SynthesizeSpeechConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
SynthesizeSpeechConfig.Builder
Overrides

setPitch(double value)

public SynthesizeSpeechConfig.Builder setPitch(double value)

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];

Parameter
Name Description
value double

The pitch to set.

Returns
Type Description
SynthesizeSpeechConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public SynthesizeSpeechConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
SynthesizeSpeechConfig.Builder
Overrides

setSpeakingRate(double value)

public SynthesizeSpeechConfig.Builder setSpeakingRate(double value)

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];

Parameter
Name Description
value double

The speakingRate to set.

Returns
Type Description
SynthesizeSpeechConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SynthesizeSpeechConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
SynthesizeSpeechConfig.Builder
Overrides

setVoice(VoiceSelectionParams value)

public SynthesizeSpeechConfig.Builder setVoice(VoiceSelectionParams value)

Optional. The desired voice of the synthesized audio.

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

Parameter
Name Description
value VoiceSelectionParams
Returns
Type Description
SynthesizeSpeechConfig.Builder

setVoice(VoiceSelectionParams.Builder builderForValue)

public SynthesizeSpeechConfig.Builder setVoice(VoiceSelectionParams.Builder builderForValue)

Optional. The desired voice of the synthesized audio.

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

Parameter
Name Description
builderForValue VoiceSelectionParams.Builder
Returns
Type Description
SynthesizeSpeechConfig.Builder

setVolumeGainDb(double value)

public SynthesizeSpeechConfig.Builder setVolumeGainDb(double value)

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];

Parameter
Name Description
value double

The volumeGainDb to set.

Returns
Type Description
SynthesizeSpeechConfig.Builder

This builder for chaining.