Class SynthesizeSpeechConfig.Builder (4.3.1)

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

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;

Parameter
NameDescription
valuesIterable<String>

The effectsProfileId to add.

Returns
TypeDescription
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;

Parameter
NameDescription
valueString

The effectsProfileId to add.

Returns
TypeDescription
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;

Parameter
NameDescription
valueByteString

The bytes of the effectsProfileId to add.

Returns
TypeDescription
SynthesizeSpeechConfig.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public SynthesizeSpeechConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
SynthesizeSpeechConfig.Builder
Overrides

build()

public SynthesizeSpeechConfig build()
Returns
TypeDescription
SynthesizeSpeechConfig

buildPartial()

public SynthesizeSpeechConfig buildPartial()
Returns
TypeDescription
SynthesizeSpeechConfig

clear()

public SynthesizeSpeechConfig.Builder clear()
Returns
TypeDescription
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;

Returns
TypeDescription
SynthesizeSpeechConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public SynthesizeSpeechConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
SynthesizeSpeechConfig.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public SynthesizeSpeechConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
SynthesizeSpeechConfig.Builder

This builder for chaining.

clone()

public SynthesizeSpeechConfig.Builder clone()
Returns
TypeDescription
SynthesizeSpeechConfig.Builder
Overrides

getDefaultInstanceForType()

public SynthesizeSpeechConfig getDefaultInstanceForType()
Returns
TypeDescription
SynthesizeSpeechConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
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;

Returns
TypeDescription
double

The speakingRate.

getVoice()

public VoiceSelectionParams getVoice()

Optional. The desired voice of the synthesized audio.

.google.cloud.dialogflow.v2.VoiceSelectionParams voice = 4;

Returns
TypeDescription
VoiceSelectionParams

The voice.

getVoiceBuilder()

public VoiceSelectionParams.Builder getVoiceBuilder()

Optional. The desired voice of the synthesized audio.

.google.cloud.dialogflow.v2.VoiceSelectionParams voice = 4;

Returns
TypeDescription
VoiceSelectionParams.Builder

getVoiceOrBuilder()

public VoiceSelectionParamsOrBuilder getVoiceOrBuilder()

Optional. The desired voice of the synthesized audio.

.google.cloud.dialogflow.v2.VoiceSelectionParams voice = 4;

Returns
TypeDescription
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;

Returns
TypeDescription
double

The volumeGainDb.

hasVoice()

public boolean hasVoice()

Optional. The desired voice of the synthesized audio.

.google.cloud.dialogflow.v2.VoiceSelectionParams voice = 4;

Returns
TypeDescription
boolean

Whether the voice field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(SynthesizeSpeechConfig other)

public SynthesizeSpeechConfig.Builder mergeFrom(SynthesizeSpeechConfig other)
Parameter
NameDescription
otherSynthesizeSpeechConfig
Returns
TypeDescription
SynthesizeSpeechConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SynthesizeSpeechConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SynthesizeSpeechConfig.Builder
Overrides Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public SynthesizeSpeechConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
SynthesizeSpeechConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SynthesizeSpeechConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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;

Parameter
NameDescription
valueVoiceSelectionParams
Returns
TypeDescription
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;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The effectsProfileId to set.

Returns
TypeDescription
SynthesizeSpeechConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public SynthesizeSpeechConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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;

Parameter
NameDescription
valuedouble

The pitch to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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;

Parameter
NameDescription
valuedouble

The speakingRate to set.

Returns
TypeDescription
SynthesizeSpeechConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final SynthesizeSpeechConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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;

Parameter
NameDescription
valueVoiceSelectionParams
Returns
TypeDescription
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;

Parameter
NameDescription
builderForValueVoiceSelectionParams.Builder
Returns
TypeDescription
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;

Parameter
NameDescription
valuedouble

The volumeGainDb to set.

Returns
TypeDescription
SynthesizeSpeechConfig.Builder

This builder for chaining.