Class: Google::Cloud::TextToSpeech::V1::TextToSpeech::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/text_to_speech/v1/text_to_speech/client.rb

Overview

Client for the TextToSpeech service.

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

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new TextToSpeech client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::TextToSpeech::V1::TextToSpeech::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::TextToSpeech::V1::TextToSpeech::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config)

    Configure the TextToSpeech client.

Yield Parameters:



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
# File 'lib/google/cloud/text_to_speech/v1/text_to_speech/client.rb', line 117

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/texttospeech/v1/cloud_tts_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @text_to_speech_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::TextToSpeech::V1::TextToSpeech::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the TextToSpeech Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all TextToSpeech clients
::Google::Cloud::TextToSpeech::V1::TextToSpeech::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config)

    Configure the Client client.

Yield Parameters:

Returns:



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
# File 'lib/google/cloud/text_to_speech/v1/text_to_speech/client.rb', line 54

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "TextToSpeech", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs.list_voices.timeout = 600.0
    default_config.rpcs.list_voices.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.synthesize_speech.timeout = 600.0
    default_config.rpcs.synthesize_speech.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

Configure the TextToSpeech Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config)

    Configure the Client client.

Yield Parameters:

Returns:



96
97
98
99
# File 'lib/google/cloud/text_to_speech/v1/text_to_speech/client.rb', line 96

def configure
  yield @config if block_given?
  @config
end

#list_voices(request, options = nil) ⇒ ::Google::Cloud::TextToSpeech::V1::ListVoicesResponse #list_voices(language_code: nil) ⇒ ::Google::Cloud::TextToSpeech::V1::ListVoicesResponse

Returns a list of Voice supported for synthesis.

Overloads:

  • #list_voices(request, options = nil) ⇒ ::Google::Cloud::TextToSpeech::V1::ListVoicesResponse

    Pass arguments to list_voices via a request object, either of type ListVoicesRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::TextToSpeech::V1::ListVoicesRequest, ::Hash)

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil)

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #list_voices(language_code: nil) ⇒ ::Google::Cloud::TextToSpeech::V1::ListVoicesResponse

    Pass arguments to list_voices via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • language_code (::String) (defaults to: nil)

      Optional. Recommended. BCP-47 language tag. If specified, the ListVoices call will only return voices that can be used to synthesize this language_code. E.g. when specifying "en-NZ", you will get supported "en-*" voices; when specifying "no", you will get supported "no-*" (Norwegian) and "nb-*" (Norwegian Bokmal) voices; specifying "zh" will also get supported "cmn-*" voices; specifying "zh-hk" will also get supported "yue-*" voices.

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error)

    if the RPC is aborted.



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
# File 'lib/google/cloud/text_to_speech/v1/text_to_speech/client.rb', line 191

def list_voices request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TextToSpeech::V1::ListVoicesRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.list_voices..to_h

  # Set x-goog-api-client and x-goog-user-project headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TextToSpeech::V1::VERSION
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.list_voices.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.list_voices.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         retry_policy: @config.retry_policy

  @text_to_speech_stub.call_rpc :list_voices, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#synthesize_speech(request, options = nil) ⇒ ::Google::Cloud::TextToSpeech::V1::SynthesizeSpeechResponse #synthesize_speech(input: nil, voice: nil, audio_config: nil) ⇒ ::Google::Cloud::TextToSpeech::V1::SynthesizeSpeechResponse

Synthesizes speech synchronously: receive results after all text input has been processed.

Overloads:

Yields:

  • (response, operation)

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error)

    if the RPC is aborted.



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
# File 'lib/google/cloud/text_to_speech/v1/text_to_speech/client.rb', line 258

def synthesize_speech request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TextToSpeech::V1::SynthesizeSpeechRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
   = @config.rpcs.synthesize_speech..to_h

  # Set x-goog-api-client and x-goog-user-project headers
  [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::TextToSpeech::V1::VERSION
  [:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.synthesize_speech.timeout,
                         metadata:     ,
                         retry_policy: @config.rpcs.synthesize_speech.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.,
                         retry_policy: @config.retry_policy

  @text_to_speech_stub.call_rpc :synthesize_speech, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end