Module: Google::Cloud::TextToSpeech

Defined in:
lib/google/cloud/text_to_speech.rb,
lib/google/cloud/text_to_speech/version.rb

Constant Summary collapse

VERSION = 
"2.0.3"

Class Method Summary collapse

Class Method Details

.configure {|::Google::Cloud.configure.text_to_speech| ... } ⇒ ::Google::Cloud::Config

Configure the google-cloud-text_to_speech library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.

Yields:



216
217
218
219
220
 
# File 'lib/google/cloud/text_to_speech.rb', line 216

def self.configure
  yield ::Google::Cloud.configure.text_to_speech if block_given?

  ::Google::Cloud.configure.text_to_speech
end

.text_to_speech(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for TextToSpeech.

By default, this returns an instance of Google::Cloud::TextToSpeech::V1::TextToSpeech::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the TextToSpeech service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the TextToSpeech service. You can determine whether the method will succeed by calling text_to_speech_available?.

About TextToSpeech

Service that implements Google Cloud Text-to-Speech API.



75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/google/cloud/text_to_speech.rb', line 75

def self.text_to_speech version: :v1, transport: :grpc, &block
  require "google/cloud/text_to_speech/#{version.to_s.downcase}"

  package_name = Google::Cloud::TextToSpeech
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::TextToSpeech.const_get(package_name).const_get(:TextToSpeech)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.text_to_speech_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the TextToSpeech service is supported by the current client. If true, you can retrieve a client object by calling text_to_speech. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the TextToSpeech service, or if the versioned client gem needs an update to support the TextToSpeech service.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/google/cloud/text_to_speech.rb', line 99

def self.text_to_speech_available? version: :v1, transport: :grpc
  require "google/cloud/text_to_speech/#{version.to_s.downcase}"
  package_name = Google::Cloud::TextToSpeech
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::TextToSpeech.const_get package_name
  return false unless service_module.const_defined? :TextToSpeech
  service_module = service_module.const_get :TextToSpeech
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.text_to_speech_long_audio_synthesize(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for TextToSpeechLongAudioSynthesize.

By default, this returns an instance of Google::Cloud::TextToSpeech::V1::TextToSpeechLongAudioSynthesize::Client for a gRPC client for version V1 of the API. However, you can specify a different API version by passing it in the version parameter. If the TextToSpeechLongAudioSynthesize service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned. You can also specify a different transport by passing :rest or :grpc in the transport parameter.

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the TextToSpeechLongAudioSynthesize service. You can determine whether the method will succeed by calling text_to_speech_long_audio_synthesize_available?.

About TextToSpeechLongAudioSynthesize

Service that implements Google Cloud Text-to-Speech API.



145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/google/cloud/text_to_speech.rb', line 145

def self.text_to_speech_long_audio_synthesize version: :v1, transport: :grpc, &block
  require "google/cloud/text_to_speech/#{version.to_s.downcase}"

  package_name = Google::Cloud::TextToSpeech
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::TextToSpeech.const_get(package_name).const_get(:TextToSpeechLongAudioSynthesize)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.text_to_speech_long_audio_synthesize_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the TextToSpeechLongAudioSynthesize service is supported by the current client. If true, you can retrieve a client object by calling text_to_speech_long_audio_synthesize. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the TextToSpeechLongAudioSynthesize service, or if the versioned client gem needs an update to support the TextToSpeechLongAudioSynthesize service.



169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/google/cloud/text_to_speech.rb', line 169

def self.text_to_speech_long_audio_synthesize_available? version: :v1, transport: :grpc
  require "google/cloud/text_to_speech/#{version.to_s.downcase}"
  package_name = Google::Cloud::TextToSpeech
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::TextToSpeech.const_get package_name
  return false unless service_module.const_defined? :TextToSpeechLongAudioSynthesize
  service_module = service_module.const_get :TextToSpeechLongAudioSynthesize
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end