Class: Google::Cloud::TextToSpeech::V1::AudioConfig

Inherits:

Object

• Object
• Google::Cloud::TextToSpeech::V1::AudioConfig

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/texttospeech/v1/cloud_tts.rb

Overview

Description of audio data to be synthesized.

Instance Attribute Summary

• #audio_encoding ⇒ ::Google::Cloud::TextToSpeech::V1::AudioEncoding

  Required.

• #effects_profile_id ⇒ ::Array<::String>

  Optional.

• #pitch ⇒ ::Float

  Optional.

• #sample_rate_hertz ⇒ ::Integer

  Optional.

• #speaking_rate ⇒ ::Float

  Optional.

• #volume_gain_db ⇒ ::Float

  Optional.

Instance Attribute Details

#audio_encoding ⇒ ::Google::Cloud::TextToSpeech::V1::AudioEncoding

Returns Required. The format of the audio byte stream.

Returns:

• (::Google::Cloud::TextToSpeech::V1::AudioEncoding) —

  Required. The format of the audio byte stream.

# File 'proto_docs/google/cloud/texttospeech/v1/cloud_tts.rb', line 280

class AudioConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#effects_profile_id ⇒ ::Array<::String>

Returns 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.

Returns:

• (::Array<::String>) —

  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.

# File 'proto_docs/google/cloud/texttospeech/v1/cloud_tts.rb', line 280

class AudioConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#pitch ⇒ ::Float

Returns 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.

Returns:

• (::Float) —

  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.

# File 'proto_docs/google/cloud/texttospeech/v1/cloud_tts.rb', line 280

class AudioConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#sample_rate_hertz ⇒ ::Integer

Returns 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][google.rpc.Code.INVALID_ARGUMENT].

Returns:

• (::Integer) —

  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][google.rpc.Code.INVALID_ARGUMENT].

# File 'proto_docs/google/cloud/texttospeech/v1/cloud_tts.rb', line 280

class AudioConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#speaking_rate ⇒ ::Float

Returns 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.

Returns:

• (::Float) —

  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.

# File 'proto_docs/google/cloud/texttospeech/v1/cloud_tts.rb', line 280

class AudioConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#volume_gain_db ⇒ ::Float

Returns 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.

Returns:

• (::Float) —

  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.

# File 'proto_docs/google/cloud/texttospeech/v1/cloud_tts.rb', line 280

class AudioConfig
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end