Table of Contents

Class TextToSpeechSynthesisAudioConfiguration

Description of audio data to be synthesized.

public class TextToSpeechSynthesisAudioConfiguration
Inheritance
object
TextToSpeechSynthesisAudioConfiguration

Constructors

TextToSpeechSynthesisAudioConfiguration()

public TextToSpeechSynthesisAudioConfiguration()

TextToSpeechSynthesisAudioConfiguration(TextToSpeechSynthesisAudioEncoding)

public TextToSpeechSynthesisAudioConfiguration(TextToSpeechSynthesisAudioEncoding encoding)

Parameters

encoding TextToSpeechSynthesisAudioEncoding

See Encoding.

Fields

EffectsProfiles

'audio effects' profiles that are applied on (post synthesized) text to speech.

public TextToSpeechSynthesisProfile[] EffectsProfiles

Field Value

TextToSpeechSynthesisProfile[]

Remarks

Effects are applied on top of each other in the order they are given. See audio profiles for current supported profile ids.

Encoding

The format of the audio byte stream.

public TextToSpeechSynthesisAudioEncoding Encoding

Field Value

TextToSpeechSynthesisAudioEncoding

Pitch

Speaking pitch, in the range [-20.0, 20.0].

public float Pitch

Field Value

float

Remarks

20 means increase 20 semitones from the original pitch. -20 means decrease 20 semitones from the original pitch.

SampleRateHertz

The synthesis sample rate (in hertz) for this audio.

public int SampleRateHertz

Field Value

int

Remarks

When this is specified in TextToSpeechSynthesisRequest, 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.

SpeakingRate

Speaking rate/speed, in the range [0.25, 4.0].

public float SpeakingRate

Field Value

float

Remarks

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.

VolumeGainDb

Volume gain (in dB) of the normal native volume supported by the specific voice, in the range [-96.0, 16.0].

public float VolumeGainDb

Field Value

float

Remarks

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.