com.google.cloud.texttospeech.v1beta1

Interface AudioConfigOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

AudioConfig, AudioConfig.Builder

public interface AudioConfigOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
AudioEncoding	getAudioEncoding() Required.
int	getAudioEncodingValue() Required.
String	getEffectsProfileId(int index) Optional.
ByteString	getEffectsProfileIdBytes(int index) Optional.
int	getEffectsProfileIdCount() Optional.
List<String>	getEffectsProfileIdList() Optional.
double	getPitch() Optional.
int	getSampleRateHertz() Optional.
double	getSpeakingRate() Optional.
double	getVolumeGainDb() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getAudioEncodingValue

int getAudioEncodingValue()

 Required. The format of the audio byte stream.
 

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

Returns:

The enum numeric value on the wire for audioEncoding.

getAudioEncoding

AudioEncoding getAudioEncoding()

 Required. The format of the audio byte stream.
 

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

Returns:

The audioEncoding.

getSpeakingRate

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:

The speakingRate.

getPitch

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:

The pitch.

getVolumeGainDb

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:

The volumeGainDb.

getSampleRateHertz

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:

The sampleRateHertz.

getEffectsProfileIdList

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

Returns:

A list containing the effectsProfileId.

getEffectsProfileIdCount

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

Returns:

The count of effectsProfileId.

getEffectsProfileId

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

Parameters:

index - The index of the element to return.

Returns:

The effectsProfileId at the given index.

getEffectsProfileIdBytes

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

Parameters:

index - The index of the value to return.

Returns:

The bytes of the effectsProfileId at the given index.