Class AudioConfig.Builder (2.56.0) 

public static final class AudioConfig.Builder extends GeneratedMessageV3.Builder<AudioConfig.Builder> implements AudioConfigOrBuilder

Description of audio data to be synthesized.

Protobuf type google.cloud.texttospeech.v1beta1.AudioConfig

Inheritance

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

Static Methods

getDescriptor()

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

Methods

addAllEffectsProfileId(Iterable<String> values)

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

Optional. Input only. 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. See audio profiles for current supported profile ids.

repeated string effects_profile_id = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
values Iterable<String>

The effectsProfileId to add.
Returns
Type Description
AudioConfig.Builder

This builder for chaining.

addEffectsProfileId(String value)

public AudioConfig.Builder addEffectsProfileId(String value)

Optional. Input only. 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. See audio profiles for current supported profile ids.

repeated string effects_profile_id = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The effectsProfileId to add.
Returns
Type Description
AudioConfig.Builder

This builder for chaining.

addEffectsProfileIdBytes(ByteString value)

public AudioConfig.Builder addEffectsProfileIdBytes(ByteString value)

Optional. Input only. 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. See audio profiles for current supported profile ids.

repeated string effects_profile_id = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes of the effectsProfileId to add.
Returns
Type Description
AudioConfig.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public AudioConfig build()
Returns
Type Description
AudioConfig

buildPartial()

public AudioConfig buildPartial()
Returns
Type Description
AudioConfig

clear()

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

clearAudioEncoding()

public AudioConfig.Builder clearAudioEncoding()

Required. The format of the audio byte stream.

.google.cloud.texttospeech.v1beta1.AudioEncoding audio_encoding = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AudioConfig.Builder

This builder for chaining.

clearEffectsProfileId()

public AudioConfig.Builder clearEffectsProfileId()

Optional. Input only. 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. See audio profiles for current supported profile ids.

repeated string effects_profile_id = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AudioConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearPitch()

public AudioConfig.Builder clearPitch()

Optional. Input only. 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 = 3 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AudioConfig.Builder

This builder for chaining.

clearSampleRateHertz()

public AudioConfig.Builder clearSampleRateHertz()

Optional. The synthesis sample rate (in hertz) for this audio. When this is specified in SynthesizeSpeechRequest, if this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality), unless the specified sample rate is not supported for the encoding chosen, in which case it will fail the request and return google.rpc.Code.INVALID_ARGUMENT.

int32 sample_rate_hertz = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AudioConfig.Builder

This builder for chaining.

clearSpeakingRate()

public AudioConfig.Builder clearSpeakingRate()

Optional. Input only. 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 = 2 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AudioConfig.Builder

This builder for chaining.

clearVolumeGainDb()

public AudioConfig.Builder clearVolumeGainDb()

Optional. Input only. 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. 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 = 4 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
AudioConfig.Builder

This builder for chaining.

clone()

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

getAudioEncoding()

public AudioEncoding getAudioEncoding()

Required. The format of the audio byte stream.

.google.cloud.texttospeech.v1beta1.AudioEncoding audio_encoding = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
AudioEncoding

The audioEncoding.

getAudioEncodingValue()

public int getAudioEncodingValue()

Required. The format of the audio byte stream.

.google.cloud.texttospeech.v1beta1.AudioEncoding audio_encoding = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for audioEncoding.

getDefaultInstanceForType()

public AudioConfig getDefaultInstanceForType()
Returns
Type Description
AudioConfig

getDescriptorForType()

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

getEffectsProfileId(int index)

public String getEffectsProfileId(int index)

Optional. Input only. 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. See audio profiles for current supported profile ids.

repeated string effects_profile_id = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.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. Input only. 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. See audio profiles for current supported profile ids.

repeated string effects_profile_id = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.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. Input only. 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. See audio profiles for current supported profile ids.

repeated string effects_profile_id = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of effectsProfileId.

getEffectsProfileIdList()

public ProtocolStringList getEffectsProfileIdList()

Optional. Input only. 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. See audio profiles for current supported profile ids.

repeated string effects_profile_id = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the effectsProfileId.

getPitch()

public double getPitch()

Optional. Input only. 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 = 3 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
double

The pitch.

getSampleRateHertz()

public int getSampleRateHertz()

Optional. The synthesis sample rate (in hertz) for this audio. When this is specified in SynthesizeSpeechRequest, if this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality), unless the specified sample rate is not supported for the encoding chosen, in which case it will fail the request and return google.rpc.Code.INVALID_ARGUMENT.

int32 sample_rate_hertz = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The sampleRateHertz.

getSpeakingRate()

public double getSpeakingRate()

Optional. Input only. 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 = 2 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
double

The speakingRate.

getVolumeGainDb()

public double getVolumeGainDb()

Optional. Input only. 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. 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 = 4 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
double

The volumeGainDb.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(AudioConfig other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setAudioEncoding(AudioEncoding value)

public AudioConfig.Builder setAudioEncoding(AudioEncoding value)

Required. The format of the audio byte stream.

.google.cloud.texttospeech.v1beta1.AudioEncoding audio_encoding = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value AudioEncoding

The audioEncoding to set.
Returns
Type Description
AudioConfig.Builder

This builder for chaining.

setAudioEncodingValue(int value)

public AudioConfig.Builder setAudioEncodingValue(int value)

Required. The format of the audio byte stream.

.google.cloud.texttospeech.v1beta1.AudioEncoding audio_encoding = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The enum numeric value on the wire for audioEncoding to set.
Returns
Type Description
AudioConfig.Builder

This builder for chaining.

setEffectsProfileId(int index, String value)

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

Optional. Input only. 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. See audio profiles for current supported profile ids.

repeated string effects_profile_id = 6 [(.google.api.field_behavior) = INPUT_ONLY, (.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
AudioConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setPitch(double value)

public AudioConfig.Builder setPitch(double value)

Optional. Input only. 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 = 3 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value double

The pitch to set.
Returns
Type Description
AudioConfig.Builder

This builder for chaining.

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

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

setSampleRateHertz(int value)

public AudioConfig.Builder setSampleRateHertz(int value)

Optional. The synthesis sample rate (in hertz) for this audio. When this is specified in SynthesizeSpeechRequest, if this is different from the voice's natural sample rate, then the synthesizer will honor this request by converting to the desired sample rate (which might result in worse audio quality), unless the specified sample rate is not supported for the encoding chosen, in which case it will fail the request and return google.rpc.Code.INVALID_ARGUMENT.

int32 sample_rate_hertz = 5 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The sampleRateHertz to set.
Returns
Type Description
AudioConfig.Builder

This builder for chaining.

setSpeakingRate(double value)

public AudioConfig.Builder setSpeakingRate(double value)

Optional. Input only. 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 = 2 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value double

The speakingRate to set.
Returns
Type Description
AudioConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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

setVolumeGainDb(double value)

public AudioConfig.Builder setVolumeGainDb(double value)

Optional. Input only. 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. 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 = 4 [(.google.api.field_behavior) = INPUT_ONLY, (.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value double

The volumeGainDb to set.
Returns
Type Description
AudioConfig.Builder

This builder for chaining.