Class SynthesizeSpeechConfig.Builder (0.33.0)

Version 0.33.0

• 0.64.0 (latest)
• 0.63.0
• 0.62.0
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.7
• 0.13.1
• 0.12.1
• 0.11.5

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.cx.v3.SynthesizeSpeechConfig

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > SynthesizeSpeechConfig.Builder

Implements

SynthesizeSpeechConfigOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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;

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;

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;

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public SynthesizeSpeechConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
SynthesizeSpeechConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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

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.cx.v3.VoiceSelectionParams voice = 4;

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;

Returns
Type	Description
SynthesizeSpeechConfig.Builder	This builder for chaining.

clone()

public SynthesizeSpeechConfig.Builder clone()

Returns
Type	Description
SynthesizeSpeechConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public SynthesizeSpeechConfig getDefaultInstanceForType()

Returns
Type	Description
SynthesizeSpeechConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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

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;

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;

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;

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;

Returns
Type	Description
double	The speakingRate.

getVoice()

public VoiceSelectionParams getVoice()

Optional. The desired voice of the synthesized audio.

.google.cloud.dialogflow.cx.v3.VoiceSelectionParams voice = 4;

Returns
Type	Description
VoiceSelectionParams	The voice.

getVoiceBuilder()

public VoiceSelectionParams.Builder getVoiceBuilder()

Optional. The desired voice of the synthesized audio.

.google.cloud.dialogflow.cx.v3.VoiceSelectionParams voice = 4;

Returns
Type	Description
VoiceSelectionParams.Builder

getVoiceOrBuilder()

public VoiceSelectionParamsOrBuilder getVoiceOrBuilder()

Optional. The desired voice of the synthesized audio.

.google.cloud.dialogflow.cx.v3.VoiceSelectionParams voice = 4;

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;

Returns
Type	Description
double	The volumeGainDb.

hasVoice()

public boolean hasVoice()

Optional. The desired voice of the synthesized audio.

.google.cloud.dialogflow.cx.v3.VoiceSelectionParams voice = 4;

Returns
Type	Description
boolean	Whether the voice field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public SynthesizeSpeechConfig.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
SynthesizeSpeechConfig.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final SynthesizeSpeechConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
SynthesizeSpeechConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeVoice(VoiceSelectionParams value)

public SynthesizeSpeechConfig.Builder mergeVoice(VoiceSelectionParams value)

Optional. The desired voice of the synthesized audio.

.google.cloud.dialogflow.cx.v3.VoiceSelectionParams voice = 4;

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;

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setVoice(VoiceSelectionParams value)

public SynthesizeSpeechConfig.Builder setVoice(VoiceSelectionParams value)

Optional. The desired voice of the synthesized audio.

.google.cloud.dialogflow.cx.v3.VoiceSelectionParams voice = 4;

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.cx.v3.VoiceSelectionParams voice = 4;

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;

Parameter
Name	Description
value	double The volumeGainDb to set.

Returns
Type	Description
SynthesizeSpeechConfig.Builder	This builder for chaining.