Class: Google::Cloud::TextToSpeech::V1beta1::TextToSpeech::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/text_to_speech/v1beta1/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::V1beta1::TextToSpeech::Client.new

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

Yields:

  • (config) —

    Configure the TextToSpeech client.

Yield Parameters:



114
115
116
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
 
# File 'lib/google/cloud/text_to_speech/v1beta1/text_to_speech/client.rb', line 114

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/v1beta1/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::V1beta1::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::V1beta1::TextToSpeech::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



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

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "TextToSpeech", "V1beta1"]
    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:



93
94
95
96
 
# File 'lib/google/cloud/text_to_speech/v1beta1/text_to_speech/client.rb', line 93

def configure
  yield @config if block_given?
  @config
end

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

Returns a list of Voice supported for synthesis.

Examples:

Basic example

require "google/cloud/text_to_speech/v1beta1"

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

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

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

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::TextToSpeech::V1beta1::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::V1beta1::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.



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/google/cloud/text_to_speech/v1beta1/text_to_speech/client.rb', line 203

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TextToSpeech::V1beta1::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 and x-goog-user-project 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::V1beta1::VERSION
  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

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

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

Examples:

Basic example

require "google/cloud/text_to_speech/v1beta1"

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

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

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

# The returned object is of type Google::Cloud::TextToSpeech::V1beta1::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.



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
 
# File 'lib/google/cloud/text_to_speech/v1beta1/text_to_speech/client.rb', line 287

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::TextToSpeech::V1beta1::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 and x-goog-user-project 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::V1beta1::VERSION
  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