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

Inherits:
Object
  • Object
show all
Includes:
Paths
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

Methods included from Paths

#model_path

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:



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/google/cloud/text_to_speech/v1/text_to_speech/client.rb', line 129

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.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_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,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool
  )
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:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/google/cloud/text_to_speech/v1/text_to_speech/client.rb', line 62

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.timeout = 300.0
    default_config.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:



99
100
101
102
 
# File 'lib/google/cloud/text_to_speech/v1/text_to_speech/client.rb', line 99

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.

Examples:

Basic example

require "google/cloud/text_to_speech/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::TextToSpeech::V1::TextToSpeech::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::TextToSpeech::V1::ListVoicesRequest.new

# Call the list_voices method.
result = client.list_voices request

# The returned object is of type Google::Cloud::TextToSpeech::V1::ListVoicesResponse.
p result

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 not specified, the API will return all supported voices. If specified, the ListVoices call will only return voices that can be used to synthesize this language_code. For example, if you specify "en-NZ", all "en-NZ" voices will be returned. If you specify "no", both "no-\*" (Norwegian) and "nb-\*" (Norwegian Bokmal) voices will be returned.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/google/cloud/text_to_speech/v1/text_to_speech/client.rb', line 222

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
  metadata = @config.rpcs.list_voices.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         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

#streaming_synthesize(request, options = nil) {|response, operation| ... } ⇒ ::Enumerable<::Google::Cloud::TextToSpeech::V1::StreamingSynthesizeResponse>

Performs bidirectional streaming speech synthesis: receive audio while sending text.

Examples:

Basic example

require "google/cloud/text_to_speech/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::TextToSpeech::V1::TextToSpeech::Client.new

# Create an input stream.
input = Gapic::StreamInput.new

# Call the streaming_synthesize method to start streaming.
output = client.streaming_synthesize input

# Send requests on the stream. For each request object, set fields by
# passing keyword arguments. Be sure to close the stream when done.
input << Google::Cloud::TextToSpeech::V1::StreamingSynthesizeRequest.new
input << Google::Cloud::TextToSpeech::V1::StreamingSynthesizeRequest.new
input.close

# The returned object is a streamed enumerable yielding elements of type
# ::Google::Cloud::TextToSpeech::V1::StreamingSynthesizeResponse
output.each do |current_response|
  p current_response
end

Parameters:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/google/cloud/text_to_speech/v1/text_to_speech/client.rb', line 382

def streaming_synthesize request, options = nil
  unless request.is_a? ::Enumerable
    raise ::ArgumentError, "request must be an Enumerable" unless request.respond_to? :to_enum
    request = request.to_enum
  end

  request = request.lazy.map do |req|
    ::Gapic::Protobuf.coerce req, to: ::Google::Cloud::TextToSpeech::V1::StreamingSynthesizeRequest
  end

  # 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
  metadata = @config.rpcs.streaming_synthesize.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

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

  @text_to_speech_stub.call_rpc :streaming_synthesize, 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, advanced_voice_options: nil) ⇒ ::Google::Cloud::TextToSpeech::V1::SynthesizeSpeechResponse

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

Examples:

Basic example

require "google/cloud/text_to_speech/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::TextToSpeech::V1::TextToSpeech::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::TextToSpeech::V1::SynthesizeSpeechRequest.new

# Call the synthesize_speech method.
result = client.synthesize_speech request

# The returned object is of type Google::Cloud::TextToSpeech::V1::SynthesizeSpeechResponse.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/google/cloud/text_to_speech/v1/text_to_speech/client.rb', line 307

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
  metadata = @config.rpcs.synthesize_speech.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"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
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

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

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         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

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


109
110
111
 
# File 'lib/google/cloud/text_to_speech/v1/text_to_speech/client.rb', line 109

def universe_domain
  @text_to_speech_stub.universe_domain
end