class Google::Cloud::TextToSpeech::V1beta1::TextToSpeech::Client

Client for the TextToSpeech service.

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

Attributes

text_to_speech_stub[R]

@private

Public Class Methods

configure() { |configure| ... } click to toggle source

Configure the TextToSpeech Client class.

See {::Google::Cloud::TextToSpeech::V1beta1::TextToSpeech::Client::Configuration} for a description of the configuration fields.

@example

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

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/text_to_speech/v1beta1/text_to_speech/client.rb, line 54
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
new() { |config| ... } click to toggle source

Create a new TextToSpeech client object.

@example

# 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

@yield [config] Configure the TextToSpeech client. @yieldparam config [Client::Configuration]

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

Public Instance Methods

configure() { |config| ... } click to toggle source

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 {Client.configure}.

See {::Google::Cloud::TextToSpeech::V1beta1::TextToSpeech::Client::Configuration} for a description of the configuration fields.

@yield [config] Configure the Client client. @yieldparam config [Client::Configuration]

@return [Client::Configuration]

# File lib/google/cloud/text_to_speech/v1beta1/text_to_speech/client.rb, line 91
def configure
  yield @config if block_given?
  @config
end
list_voices(request, options = nil) { |response, operation| ... } click to toggle source

Returns a list of Voice supported for synthesis.

@overload list_voices(request, options = nil)

Pass arguments to `list_voices` via a request object, either of type
{::Google::Cloud::TextToSpeech::V1beta1::ListVoicesRequest} or an equivalent Hash.

@param 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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload list_voices(language_code: nil)

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).

@param language_code [::String]
  Optional. Recommended.
  [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) 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. E.g. when specifying "en-NZ", you will
  get supported "en-NZ" 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-hk" voices.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::TextToSpeech::V1beta1::ListVoicesResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::TextToSpeech::V1beta1::ListVoicesResponse]

@raise [::Google::Cloud::Error] if the RPC is aborted.

# File lib/google/cloud/text_to_speech/v1beta1/text_to_speech/client.rb, line 187
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) { |response, operation| ... } click to toggle source

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

@overload synthesize_speech(request, options = nil)

Pass arguments to `synthesize_speech` via a request object, either of type
{::Google::Cloud::TextToSpeech::V1beta1::SynthesizeSpeechRequest} or an equivalent Hash.

@param request [::Google::Cloud::TextToSpeech::V1beta1::SynthesizeSpeechRequest, ::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.
@param options [::Gapic::CallOptions, ::Hash]
  Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

@overload synthesize_speech(input: nil, voice: nil, audio_config: nil, enable_time_pointing: nil)

Pass arguments to `synthesize_speech` 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).

@param input [::Google::Cloud::TextToSpeech::V1beta1::SynthesisInput, ::Hash]
  Required. The Synthesizer requires either plain text or SSML as input.
@param voice [::Google::Cloud::TextToSpeech::V1beta1::VoiceSelectionParams, ::Hash]
  Required. The desired voice of the synthesized audio.
@param audio_config [::Google::Cloud::TextToSpeech::V1beta1::AudioConfig, ::Hash]
  Required. The configuration of the synthesized audio.
@param enable_time_pointing [::Array<::Google::Cloud::TextToSpeech::V1beta1::SynthesizeSpeechRequest::TimepointType>]
  Whether and what timepoints are returned in the response.

@yield [response, operation] Access the result along with the RPC operation @yieldparam response [::Google::Cloud::TextToSpeech::V1beta1::SynthesizeSpeechResponse] @yieldparam operation [::GRPC::ActiveCall::Operation]

@return [::Google::Cloud::TextToSpeech::V1beta1::SynthesizeSpeechResponse]

@raise [::Google::Cloud::Error] if the RPC is aborted.

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