public final class AudioConfig extends GeneratedMessageV3 implements AudioConfigOrBuilder
Description of audio data to be synthesized.
Protobuf type google.cloud.texttospeech.v1.AudioConfig
Static Fields
AUDIO_ENCODING_FIELD_NUMBER
public static final int AUDIO_ENCODING_FIELD_NUMBER
Field Value
EFFECTS_PROFILE_ID_FIELD_NUMBER
public static final int EFFECTS_PROFILE_ID_FIELD_NUMBER
Field Value
PITCH_FIELD_NUMBER
public static final int PITCH_FIELD_NUMBER
Field Value
SAMPLE_RATE_HERTZ_FIELD_NUMBER
public static final int SAMPLE_RATE_HERTZ_FIELD_NUMBER
Field Value
SPEAKING_RATE_FIELD_NUMBER
public static final int SPEAKING_RATE_FIELD_NUMBER
Field Value
VOLUME_GAIN_DB_FIELD_NUMBER
public static final int VOLUME_GAIN_DB_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static AudioConfig getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static AudioConfig.Builder newBuilder()
Returns
newBuilder(AudioConfig prototype)
public static AudioConfig.Builder newBuilder(AudioConfig prototype)
Parameter
Returns
parseDelimitedFrom(InputStream input)
public static AudioConfig parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static AudioConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static AudioConfig parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AudioConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static AudioConfig parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AudioConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(CodedInputStream input)
public static AudioConfig parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AudioConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(InputStream input)
public static AudioConfig parseFrom(InputStream input)
Parameter
Returns
Exceptions
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static AudioConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static AudioConfig parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AudioConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<AudioConfig> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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];
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];
| Type | Description |
| int | The enum numeric value on the wire for audioEncoding.
|
getDefaultInstanceForType()
public AudioConfig getDefaultInstanceForType()
Returns
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];
| 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];
| 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];
| 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];
getParserForType()
public Parser<AudioConfig> getParserForType()
Returns
Overrides
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];
| 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];
| Type | Description |
| int | The sampleRateHertz.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
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];
| Type | Description |
| double | The speakingRate.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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];
| Type | Description |
| double | The volumeGainDb.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public AudioConfig.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AudioConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public AudioConfig.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
