Class: Google::Cloud::TextToSpeech::V1::SynthesisInput

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/texttospeech/v1/cloud_tts.rb

Overview

Contains text input to be synthesized. Either text or ssml must be supplied. Supplying both or neither returns [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. The input size is limited to 5000 bytes.

Instance Attribute Summary collapse

Instance Attribute Details

#custom_pronunciations ⇒ ::Google::Cloud::TextToSpeech::V1::CustomPronunciations

Returns Optional. The pronunciation customizations to be applied to the input. If this is set, the input will be synthesized using the given pronunciation customizations.

The initial support will be for EFIGS (English, French, Italian, German, Spanish) languages, as provided in VoiceSelectionParams. Journey and Instant Clone voices are not supported yet.

In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag (entirely or partially).

Returns:

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

    Optional. The pronunciation customizations to be applied to the input. If this is set, the input will be synthesized using the given pronunciation customizations.

    The initial support will be for EFIGS (English, French, Italian, German, Spanish) languages, as provided in VoiceSelectionParams. Journey and Instant Clone voices are not supported yet.

    In order to customize the pronunciation of a phrase, there must be an exact match of the phrase in the input types. If using SSML, the phrase must not be inside a phoneme tag (entirely or partially).



166
167
168
169
 
# File 'proto_docs/google/cloud/texttospeech/v1/cloud_tts.rb', line 166

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

#ssml ⇒ ::String

Returns The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. For more information, see SSML.

Returns:

  • (::String) —

    The SSML document to be synthesized. The SSML document must be valid and well-formed. Otherwise the RPC will fail and return [google.rpc.Code.INVALID_ARGUMENT][google.rpc.Code.INVALID_ARGUMENT]. For more information, see SSML.



166
167
168
169
 
# File 'proto_docs/google/cloud/texttospeech/v1/cloud_tts.rb', line 166

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

#text ⇒ ::String

Returns The raw text to be synthesized.

Returns:

  • (::String) —

    The raw text to be synthesized.



166
167
168
169
 
# File 'proto_docs/google/cloud/texttospeech/v1/cloud_tts.rb', line 166

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