com.google.cloud.texttospeech.v1

Class AudioConfig.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<AudioConfig.Builder>

com.google.cloud.texttospeech.v1.AudioConfig.Builder

All Implemented Interfaces:

AudioConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

AudioConfig

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

 Description of audio data to be synthesized.
 

Protobuf type google.cloud.texttospeech.v1.AudioConfig

Method Summary

Modifier and Type	Method and Description
AudioConfig.Builder	addAllEffectsProfileId(Iterable<String> values) An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech.
AudioConfig.Builder	addEffectsProfileId(String value) An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech.
AudioConfig.Builder	addEffectsProfileIdBytes(com.google.protobuf.ByteString value) An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech.
AudioConfig.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
AudioConfig	build()
AudioConfig	buildPartial()
AudioConfig.Builder	clear()
AudioConfig.Builder	clearAudioEncoding() Required.
AudioConfig.Builder	clearEffectsProfileId() An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech.
AudioConfig.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
AudioConfig.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
AudioConfig.Builder	clearPitch() Optional speaking pitch, in the range [-20.0, 20.0].
AudioConfig.Builder	clearSampleRateHertz() The synthesis sample rate (in hertz) for this audio.
AudioConfig.Builder	clearSpeakingRate() Optional speaking rate/speed, in the range [0.25, 4.0].
AudioConfig.Builder	clearVolumeGainDb() Optional volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0].
AudioConfig.Builder	clone()
AudioEncoding	getAudioEncoding() Required.
int	getAudioEncodingValue() Required.
AudioConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
String	getEffectsProfileId(int index) An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech.
com.google.protobuf.ByteString	getEffectsProfileIdBytes(int index) An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech.
int	getEffectsProfileIdCount() An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech.
com.google.protobuf.ProtocolStringList	getEffectsProfileIdList() An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech.
double	getPitch() Optional speaking pitch, in the range [-20.0, 20.0].
int	getSampleRateHertz() The synthesis sample rate (in hertz) for this audio.
double	getSpeakingRate() Optional speaking rate/speed, in the range [0.25, 4.0].
double	getVolumeGainDb() Optional volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0].
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
AudioConfig.Builder	mergeFrom(AudioConfig other)
AudioConfig.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
AudioConfig.Builder	mergeFrom(com.google.protobuf.Message other)
AudioConfig.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
AudioConfig.Builder	setAudioEncoding(AudioEncoding value) Required.
AudioConfig.Builder	setAudioEncodingValue(int value) Required.
AudioConfig.Builder	setEffectsProfileId(int index, String value) An identifier which selects 'audio effects' profiles that are applied on (post synthesized) text to speech.
AudioConfig.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
AudioConfig.Builder	setPitch(double value) Optional speaking pitch, in the range [-20.0, 20.0].
AudioConfig.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
AudioConfig.Builder	setSampleRateHertz(int value) The synthesis sample rate (in hertz) for this audio.
AudioConfig.Builder	setSpeakingRate(double value) Optional speaking rate/speed, in the range [0.25, 4.0].
AudioConfig.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
AudioConfig.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].

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<AudioConfig.Builder>

clear

public AudioConfig.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<AudioConfig.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<AudioConfig.Builder>

getDefaultInstanceForType

public AudioConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public AudioConfig build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public AudioConfig buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public AudioConfig.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<AudioConfig.Builder>

setField

public AudioConfig.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                    Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<AudioConfig.Builder>

clearField

public AudioConfig.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<AudioConfig.Builder>

clearOneof

public AudioConfig.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<AudioConfig.Builder>

setRepeatedField

public AudioConfig.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            int index,
                                            Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AudioConfig.Builder>

addRepeatedField

public AudioConfig.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                            Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<AudioConfig.Builder>

mergeFrom

public AudioConfig.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AudioConfig.Builder>

mergeFrom

public AudioConfig.Builder mergeFrom(AudioConfig other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<AudioConfig.Builder>

mergeFrom

public AudioConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                     com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                              throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<AudioConfig.Builder>

Throws:

IOException

getAudioEncodingValue

public int getAudioEncodingValue()

 Required. The format of the requested audio byte stream.
 

.google.cloud.texttospeech.v1.AudioEncoding audio_encoding = 1;

Specified by:

getAudioEncodingValue in interface AudioConfigOrBuilder

setAudioEncodingValue

public AudioConfig.Builder setAudioEncodingValue(int value)

 Required. The format of the requested audio byte stream.
 

.google.cloud.texttospeech.v1.AudioEncoding audio_encoding = 1;

getAudioEncoding

public AudioEncoding getAudioEncoding()

 Required. The format of the requested audio byte stream.
 

.google.cloud.texttospeech.v1.AudioEncoding audio_encoding = 1;

Specified by:

getAudioEncoding in interface AudioConfigOrBuilder

setAudioEncoding

public AudioConfig.Builder setAudioEncoding(AudioEncoding value)

 Required. The format of the requested audio byte stream.
 

.google.cloud.texttospeech.v1.AudioEncoding audio_encoding = 1;

clearAudioEncoding

public AudioConfig.Builder clearAudioEncoding()

 Required. The format of the requested audio byte stream.
 

.google.cloud.texttospeech.v1.AudioEncoding audio_encoding = 1;

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

Specified by:

getSpeakingRate in interface AudioConfigOrBuilder

setSpeakingRate

public AudioConfig.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 = 2;

clearSpeakingRate

public AudioConfig.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 = 2;

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

Specified by:

getPitch in interface AudioConfigOrBuilder

setPitch

public AudioConfig.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 = 3;

clearPitch

public AudioConfig.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 = 3;

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

Specified by:

getVolumeGainDb in interface AudioConfigOrBuilder

setVolumeGainDb

public AudioConfig.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. 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;

clearVolumeGainDb

public AudioConfig.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. 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;

getSampleRateHertz

public int getSampleRateHertz()

 The synthesis sample rate (in hertz) for this audio. Optional.  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;

Specified by:

getSampleRateHertz in interface AudioConfigOrBuilder

setSampleRateHertz

public AudioConfig.Builder setSampleRateHertz(int value)

 The synthesis sample rate (in hertz) for this audio. Optional.  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;

clearSampleRateHertz

public AudioConfig.Builder clearSampleRateHertz()

 The synthesis sample rate (in hertz) for this audio. Optional.  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;

getEffectsProfileIdList

public com.google.protobuf.ProtocolStringList getEffectsProfileIdList()

 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](https:
 //cloud.google.com/text-to-speech/docs/audio-profiles)
 for current supported profile ids.
 

repeated string effects_profile_id = 6;

Specified by:

getEffectsProfileIdList in interface AudioConfigOrBuilder

getEffectsProfileIdCount

public int getEffectsProfileIdCount()

 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](https:
 //cloud.google.com/text-to-speech/docs/audio-profiles)
 for current supported profile ids.
 

repeated string effects_profile_id = 6;

Specified by:

getEffectsProfileIdCount in interface AudioConfigOrBuilder

getEffectsProfileId

public String getEffectsProfileId(int index)

 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](https:
 //cloud.google.com/text-to-speech/docs/audio-profiles)
 for current supported profile ids.
 

repeated string effects_profile_id = 6;

Specified by:

getEffectsProfileId in interface AudioConfigOrBuilder

getEffectsProfileIdBytes

public com.google.protobuf.ByteString getEffectsProfileIdBytes(int index)

 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](https:
 //cloud.google.com/text-to-speech/docs/audio-profiles)
 for current supported profile ids.
 

repeated string effects_profile_id = 6;

Specified by:

getEffectsProfileIdBytes in interface AudioConfigOrBuilder

setEffectsProfileId

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

 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](https:
 //cloud.google.com/text-to-speech/docs/audio-profiles)
 for current supported profile ids.
 

repeated string effects_profile_id = 6;

addEffectsProfileId

public AudioConfig.Builder addEffectsProfileId(String value)

 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](https:
 //cloud.google.com/text-to-speech/docs/audio-profiles)
 for current supported profile ids.
 

repeated string effects_profile_id = 6;

addAllEffectsProfileId

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

 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](https:
 //cloud.google.com/text-to-speech/docs/audio-profiles)
 for current supported profile ids.
 

repeated string effects_profile_id = 6;

clearEffectsProfileId

public AudioConfig.Builder clearEffectsProfileId()

 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](https:
 //cloud.google.com/text-to-speech/docs/audio-profiles)
 for current supported profile ids.
 

repeated string effects_profile_id = 6;

addEffectsProfileIdBytes

public AudioConfig.Builder addEffectsProfileIdBytes(com.google.protobuf.ByteString value)

 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](https:
 //cloud.google.com/text-to-speech/docs/audio-profiles)
 for current supported profile ids.
 

repeated string effects_profile_id = 6;

setUnknownFields

public final AudioConfig.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AudioConfig.Builder>

mergeUnknownFields

public final AudioConfig.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<AudioConfig.Builder>