Class: Google::Cloud::TextToSpeech::V1::TextToSpeechClient

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

Overview

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

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"texttospeech.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
GRPC_INTERCEPTORS =

The default set of gRPC interceptors.

[]
DEFAULT_TIMEOUT = 
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform"
].freeze

Instance Method Summary collapse

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ TextToSpeechClient

Returns a new instance of TextToSpeechClient

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) —

    Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash) —

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric) —

    The default timeout, in seconds, for calls made through this client.

  • metadata (Hash) —

    Default metadata to be sent with each request. This can be overridden on a per call basis.

  • exception_transformer (Proc) —

    An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/google/cloud/text_to_speech/v1/text_to_speech_client.rb', line 89

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: nil,
    exception_transformer: nil,
    lib_name: nil,
    lib_version: ""
  # 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 "google/gax/grpc"
  require "google/cloud/texttospeech/v1/cloud_tts_services_pb"

  credentials ||= Google::Cloud::TextToSpeech::V1::Credentials.default

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::TextToSpeech::V1::Credentials.new(credentials).updater_proc
  end
  if credentials.is_a?(GRPC::Core::Channel)
    channel = credentials
  end
  if credentials.is_a?(GRPC::Core::ChannelCredentials)
    chan_creds = credentials
  end
  if credentials.is_a?(Proc)
    updater_proc = credentials
  end
  if credentials.is_a?(Google::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  package_version = Gem.loaded_specs['google-cloud-text_to_speech'].version.version

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  headers.merge!(metadata) unless metadata.nil?
  client_config_file = Pathname.new(__dir__).join(
    "text_to_speech_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.cloud.texttospeech.v1.TextToSpeech",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      errors: Google::Gax::Grpc::API_ERRORS,
      metadata: headers
    )
  end

  # Allow overriding the service path/port in subclasses.
  service_path = self.class::SERVICE_ADDRESS
  port = self.class::DEFAULT_SERVICE_PORT
  interceptors = self.class::GRPC_INTERCEPTORS
  @text_to_speech_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    interceptors: interceptors,
    &Google::Cloud::Texttospeech::V1::TextToSpeech::Stub.method(:new)
  )

  @list_voices = Google::Gax.create_api_call(
    @text_to_speech_stub.method(:list_voices),
    defaults["list_voices"],
    exception_transformer: exception_transformer
  )
  @synthesize_speech = Google::Gax.create_api_call(
    @text_to_speech_stub.method(:synthesize_speech),
    defaults["synthesize_speech"],
    exception_transformer: exception_transformer
  )
end

Instance Method Details

#list_voices(language_code: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Texttospeech::V1::ListVoicesResponse

Returns a list of Voice supported for synthesis.

Examples:

require "google/cloud/text_to_speech"

text_to_speech_client = Google::Cloud::TextToSpeech.new(version: :v1)
response = text_to_speech_client.list_voices

Parameters:

  • language_code (String) —

    Optional (but 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.

  • options (Google::Gax::CallOptions) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



202
203
204
205
206
207
208
209
210
211
 
# File 'lib/google/cloud/text_to_speech/v1/text_to_speech_client.rb', line 202

def list_voices \
    language_code: nil,
    options: nil,
    &block
  req = {
    language_code: language_code
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Texttospeech::V1::ListVoicesRequest)
  @list_voices.call(req, options, &block)
end

#synthesize_speech(input, voice, audio_config, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Texttospeech::V1::SynthesizeSpeechResponse

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

Examples:

require "google/cloud/text_to_speech"

text_to_speech_client = Google::Cloud::TextToSpeech.new(version: :v1)

# TODO: Initialize +input+:
input = {}

# TODO: Initialize +voice+:
voice = {}

# TODO: Initialize +audio_config+:
audio_config = {}
response = text_to_speech_client.synthesize_speech(input, voice, audio_config)

Parameters:

  • input (Google::Cloud::Texttospeech::V1::SynthesisInput | Hash) —

    Required. The Synthesizer requires either plain text or SSML as input. A hash of the same form as Google::Cloud::Texttospeech::V1::SynthesisInput can also be provided.

  • voice (Google::Cloud::Texttospeech::V1::VoiceSelectionParams | Hash) —

    Required. The desired voice of the synthesized audio. A hash of the same form as Google::Cloud::Texttospeech::V1::VoiceSelectionParams can also be provided.

  • audio_config (Google::Cloud::Texttospeech::V1::AudioConfig | Hash) —

    Required. The configuration of the synthesized audio. A hash of the same form as Google::Cloud::Texttospeech::V1::AudioConfig can also be provided.

  • options (Google::Gax::CallOptions) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/google/cloud/text_to_speech/v1/text_to_speech_client.rb', line 251

def synthesize_speech \
    input,
    voice,
    audio_config,
    options: nil,
    &block
  req = {
    input: input,
    voice: voice,
    audio_config: audio_config
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Texttospeech::V1::SynthesizeSpeechRequest)
  @synthesize_speech.call(req, options, &block)
end