Class SynthesizeSpeechConfig (0.48.0)

public final class SynthesizeSpeechConfig extends GeneratedMessageV3 implements SynthesizeSpeechConfigOrBuilder

Configuration of how speech should be synthesized.

Protobuf type google.cloud.dialogflow.cx.v3beta1.SynthesizeSpeechConfig

Static Fields

EFFECTS_PROFILE_ID_FIELD_NUMBER

public static final int EFFECTS_PROFILE_ID_FIELD_NUMBER
Field Value
TypeDescription
int

PITCH_FIELD_NUMBER

public static final int PITCH_FIELD_NUMBER
Field Value
TypeDescription
int

SPEAKING_RATE_FIELD_NUMBER

public static final int SPEAKING_RATE_FIELD_NUMBER
Field Value
TypeDescription
int

VOICE_FIELD_NUMBER

public static final int VOICE_FIELD_NUMBER
Field Value
TypeDescription
int

VOLUME_GAIN_DB_FIELD_NUMBER

public static final int VOLUME_GAIN_DB_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SynthesizeSpeechConfig getDefaultInstance()
Returns
TypeDescription
SynthesizeSpeechConfig

getDescriptor()

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

newBuilder()

public static SynthesizeSpeechConfig.Builder newBuilder()
Returns
TypeDescription
SynthesizeSpeechConfig.Builder

newBuilder(SynthesizeSpeechConfig prototype)

public static SynthesizeSpeechConfig.Builder newBuilder(SynthesizeSpeechConfig prototype)
Parameter
NameDescription
prototypeSynthesizeSpeechConfig
Returns
TypeDescription
SynthesizeSpeechConfig.Builder

parseDelimitedFrom(InputStream input)

public static SynthesizeSpeechConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SynthesizeSpeechConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SynthesizeSpeechConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SynthesizeSpeechConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SynthesizeSpeechConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SynthesizeSpeechConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SynthesizeSpeechConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SynthesizeSpeechConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SynthesizeSpeechConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SynthesizeSpeechConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SynthesizeSpeechConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SynthesizeSpeechConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SynthesizeSpeechConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SynthesizeSpeechConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SynthesizeSpeechConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SynthesizeSpeechConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SynthesizeSpeechConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SynthesizeSpeechConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SynthesizeSpeechConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SynthesizeSpeechConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SynthesizeSpeechConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SynthesizeSpeechConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SynthesizeSpeechConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SynthesizeSpeechConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SynthesizeSpeechConfig> parser()
Returns
TypeDescription
Parser<SynthesizeSpeechConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public SynthesizeSpeechConfig getDefaultInstanceForType()
Returns
TypeDescription
SynthesizeSpeechConfig

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.

getParserForType()

public Parser<SynthesizeSpeechConfig> getParserForType()
Returns
TypeDescription
Parser<SynthesizeSpeechConfig>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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

Returns
TypeDescription
VoiceSelectionParams

The voice.

getVoiceOrBuilder()

public VoiceSelectionParamsOrBuilder getVoiceOrBuilder()

Optional. The desired voice of the synthesized audio.

.google.cloud.dialogflow.cx.v3beta1.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.cx.v3beta1.VoiceSelectionParams voice = 4;

Returns
TypeDescription
boolean

Whether the voice field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SynthesizeSpeechConfig.Builder newBuilderForType()
Returns
TypeDescription
SynthesizeSpeechConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SynthesizeSpeechConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SynthesizeSpeechConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SynthesizeSpeechConfig.Builder toBuilder()
Returns
TypeDescription
SynthesizeSpeechConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException