com.google.cloud.texttospeech.v1

Class AudioConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.texttospeech.v1.AudioConfig

All Implemented Interfaces:

AudioConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class AudioConfig
extends com.google.protobuf.GeneratedMessageV3
implements AudioConfigOrBuilder

 Description of audio data to be synthesized.
 

Protobuf type google.cloud.texttospeech.v1.AudioConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AudioConfig.Builder Description of audio data to be synthesized.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUDIO_ENCODING_FIELD_NUMBER
static int	EFFECTS_PROFILE_ID_FIELD_NUMBER
static int	PITCH_FIELD_NUMBER
static int	SAMPLE_RATE_HERTZ_FIELD_NUMBER
static int	SPEAKING_RATE_FIELD_NUMBER
static int	VOLUME_GAIN_DB_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
AudioEncoding	getAudioEncoding() Required.
int	getAudioEncodingValue() Required.
static AudioConfig	getDefaultInstance()
AudioConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getEffectsProfileId(int index) Optional.
com.google.protobuf.ByteString	getEffectsProfileIdBytes(int index) Optional.
int	getEffectsProfileIdCount() Optional.
com.google.protobuf.ProtocolStringList	getEffectsProfileIdList() Optional.
com.google.protobuf.Parser<AudioConfig>	getParserForType()
double	getPitch() Optional.
int	getSampleRateHertz() Optional.
int	getSerializedSize()
double	getSpeakingRate() Optional.
com.google.protobuf.UnknownFieldSet	getUnknownFields()
double	getVolumeGainDb() Optional.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static AudioConfig.Builder	newBuilder()
static AudioConfig.Builder	newBuilder(AudioConfig prototype)
AudioConfig.Builder	newBuilderForType()
protected AudioConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static AudioConfig	parseDelimitedFrom(InputStream input)
static AudioConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AudioConfig	parseFrom(byte[] data)
static AudioConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AudioConfig	parseFrom(ByteBuffer data)
static AudioConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AudioConfig	parseFrom(com.google.protobuf.ByteString data)
static AudioConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AudioConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static AudioConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static AudioConfig	parseFrom(InputStream input)
static AudioConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<AudioConfig>	parser()
AudioConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

AUDIO_ENCODING_FIELD_NUMBER

public static final int AUDIO_ENCODING_FIELD_NUMBER

See Also:

Constant Field Values

SPEAKING_RATE_FIELD_NUMBER

public static final int SPEAKING_RATE_FIELD_NUMBER

See Also:

Constant Field Values

PITCH_FIELD_NUMBER

public static final int PITCH_FIELD_NUMBER

See Also:

Constant Field Values

VOLUME_GAIN_DB_FIELD_NUMBER

public static final int VOLUME_GAIN_DB_FIELD_NUMBER

See Also:

Constant Field Values

SAMPLE_RATE_HERTZ_FIELD_NUMBER

public static final int SAMPLE_RATE_HERTZ_FIELD_NUMBER

See Also:

Constant Field Values

EFFECTS_PROFILE_ID_FIELD_NUMBER

public static final int EFFECTS_PROFILE_ID_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

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

getAudioEncodingValue

public int getAudioEncodingValue()

 Required. The format of the audio byte stream.
 

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

Specified by:

getAudioEncodingValue in interface AudioConfigOrBuilder

Returns:

The enum numeric value on the wire for audioEncoding.

getAudioEncoding

public AudioEncoding getAudioEncoding()

 Required. The format of the audio byte stream.
 

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

Specified by:

getAudioEncoding in interface AudioConfigOrBuilder

Returns:

The audioEncoding.

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

Specified by:

getSpeakingRate in interface AudioConfigOrBuilder

Returns:

The speakingRate.

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

Specified by:

getPitch in interface AudioConfigOrBuilder

Returns:

The pitch.

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

Specified by:

getVolumeGainDb in interface AudioConfigOrBuilder

Returns:

The volumeGainDb.

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

Specified by:

getSampleRateHertz in interface AudioConfigOrBuilder

Returns:

The sampleRateHertz.

getEffectsProfileIdList

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

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

Specified by:

getEffectsProfileIdList in interface AudioConfigOrBuilder

Returns:

A list containing the effectsProfileId.

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

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

Specified by:

getEffectsProfileIdCount in interface AudioConfigOrBuilder

Returns:

The count of effectsProfileId.

getEffectsProfileId

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

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

Specified by:

getEffectsProfileId in interface AudioConfigOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The effectsProfileId at the given index.

getEffectsProfileIdBytes

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

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

Specified by:

getEffectsProfileIdBytes in interface AudioConfigOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the effectsProfileId at the given index.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static AudioConfig parseFrom(ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AudioConfig parseFrom(ByteBuffer data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AudioConfig parseFrom(com.google.protobuf.ByteString data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AudioConfig parseFrom(com.google.protobuf.ByteString data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AudioConfig parseFrom(byte[] data)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AudioConfig parseFrom(byte[] data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static AudioConfig parseFrom(InputStream input)
                             throws IOException

Throws:

IOException

parseFrom

public static AudioConfig parseFrom(InputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static AudioConfig parseDelimitedFrom(InputStream input)
                                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static AudioConfig parseDelimitedFrom(InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException

Throws:

IOException

parseFrom

public static AudioConfig parseFrom(com.google.protobuf.CodedInputStream input)
                             throws IOException

Throws:

IOException

parseFrom

public static AudioConfig parseFrom(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException

Throws:

IOException

newBuilderForType

public AudioConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static AudioConfig.Builder newBuilder()

newBuilder

public static AudioConfig.Builder newBuilder(AudioConfig prototype)

toBuilder

public AudioConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected AudioConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static AudioConfig getDefaultInstance()

parser

public static com.google.protobuf.Parser<AudioConfig> parser()

getParserForType

public com.google.protobuf.Parser<AudioConfig> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public AudioConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder