Class TextToSpeechSettings (4.36.0)

public final class TextToSpeechSettings extends GeneratedMessageV3 implements TextToSpeechSettingsOrBuilder

Instructs the speech synthesizer on how to generate the output audio content.

Protobuf type google.cloud.dialogflow.v2.TextToSpeechSettings

Static Fields

ENABLE_TEXT_TO_SPEECH_FIELD_NUMBER

public static final int ENABLE_TEXT_TO_SPEECH_FIELD_NUMBER
Field Value
Type Description
int

OUTPUT_AUDIO_ENCODING_FIELD_NUMBER

public static final int OUTPUT_AUDIO_ENCODING_FIELD_NUMBER
Field Value
Type Description
int

SAMPLE_RATE_HERTZ_FIELD_NUMBER

public static final int SAMPLE_RATE_HERTZ_FIELD_NUMBER
Field Value
Type Description
int

SYNTHESIZE_SPEECH_CONFIGS_FIELD_NUMBER

public static final int SYNTHESIZE_SPEECH_CONFIGS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TextToSpeechSettings getDefaultInstance()
Returns
Type Description
TextToSpeechSettings

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static TextToSpeechSettings.Builder newBuilder()
Returns
Type Description
TextToSpeechSettings.Builder

newBuilder(TextToSpeechSettings prototype)

public static TextToSpeechSettings.Builder newBuilder(TextToSpeechSettings prototype)
Parameter
Name Description
prototype TextToSpeechSettings
Returns
Type Description
TextToSpeechSettings.Builder

parseDelimitedFrom(InputStream input)

public static TextToSpeechSettings parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TextToSpeechSettings
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TextToSpeechSettings parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TextToSpeechSettings
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TextToSpeechSettings parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TextToSpeechSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TextToSpeechSettings parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TextToSpeechSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TextToSpeechSettings parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TextToSpeechSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TextToSpeechSettings parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TextToSpeechSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TextToSpeechSettings parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TextToSpeechSettings
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TextToSpeechSettings parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TextToSpeechSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TextToSpeechSettings parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TextToSpeechSettings
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TextToSpeechSettings parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TextToSpeechSettings
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TextToSpeechSettings parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TextToSpeechSettings
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TextToSpeechSettings parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TextToSpeechSettings
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TextToSpeechSettings> parser()
Returns
Type Description
Parser<TextToSpeechSettings>

Methods

containsSynthesizeSpeechConfigs(String key)

public boolean containsSynthesizeSpeechConfigs(String key)

Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.

map<string, .google.cloud.dialogflow.v2.SynthesizeSpeechConfig> synthesize_speech_configs = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public TextToSpeechSettings getDefaultInstanceForType()
Returns
Type Description
TextToSpeechSettings

getEnableTextToSpeech()

public boolean getEnableTextToSpeech()

Optional. Indicates whether text to speech is enabled. Even when this field is false, other settings in this proto are still retained.

bool enable_text_to_speech = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The enableTextToSpeech.

getOutputAudioEncoding()

public OutputAudioEncoding getOutputAudioEncoding()

Required. Audio encoding of the synthesized audio content.

.google.cloud.dialogflow.v2.OutputAudioEncoding output_audio_encoding = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
OutputAudioEncoding

The outputAudioEncoding.

getOutputAudioEncodingValue()

public int getOutputAudioEncodingValue()

Required. Audio encoding of the synthesized audio content.

.google.cloud.dialogflow.v2.OutputAudioEncoding output_audio_encoding = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The enum numeric value on the wire for outputAudioEncoding.

getParserForType()

public Parser<TextToSpeechSettings> getParserForType()
Returns
Type Description
Parser<TextToSpeechSettings>
Overrides

getSampleRateHertz()

public int getSampleRateHertz()

Optional. The synthesis sample rate (in hertz) for this audio. If not provided, then the synthesizer will use the default sample rate based on the audio encoding. 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).

int32 sample_rate_hertz = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The sampleRateHertz.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSynthesizeSpeechConfigs()

public Map<String,SynthesizeSpeechConfig> getSynthesizeSpeechConfigs()
Returns
Type Description
Map<String,SynthesizeSpeechConfig>

getSynthesizeSpeechConfigsCount()

public int getSynthesizeSpeechConfigsCount()

Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.

map<string, .google.cloud.dialogflow.v2.SynthesizeSpeechConfig> synthesize_speech_configs = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getSynthesizeSpeechConfigsMap()

public Map<String,SynthesizeSpeechConfig> getSynthesizeSpeechConfigsMap()

Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.

map<string, .google.cloud.dialogflow.v2.SynthesizeSpeechConfig> synthesize_speech_configs = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,SynthesizeSpeechConfig>

getSynthesizeSpeechConfigsOrDefault(String key, SynthesizeSpeechConfig defaultValue)

public SynthesizeSpeechConfig getSynthesizeSpeechConfigsOrDefault(String key, SynthesizeSpeechConfig defaultValue)

Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.

map<string, .google.cloud.dialogflow.v2.SynthesizeSpeechConfig> synthesize_speech_configs = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue SynthesizeSpeechConfig
Returns
Type Description
SynthesizeSpeechConfig

getSynthesizeSpeechConfigsOrThrow(String key)

public SynthesizeSpeechConfig getSynthesizeSpeechConfigsOrThrow(String key)

Optional. Configuration of how speech should be synthesized, mapping from language (https://cloud.google.com/dialogflow/docs/reference/language) to SynthesizeSpeechConfig.

map<string, .google.cloud.dialogflow.v2.SynthesizeSpeechConfig> synthesize_speech_configs = 4 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
SynthesizeSpeechConfig

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
Name Description
number int
Returns
Type Description
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public TextToSpeechSettings.Builder newBuilderForType()
Returns
Type Description
TextToSpeechSettings.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TextToSpeechSettings.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TextToSpeechSettings.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public TextToSpeechSettings.Builder toBuilder()
Returns
Type Description
TextToSpeechSettings.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException