google-cloud-text_to_speech 0.7.0 → 1.0.0

data/lib/google/cloud/text_to_speech/v1beta1/credentials.rb

@@ -1,41 +0,0 @@
-# Copyright 2020 Google LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-require "googleauth"
-
-module Google
-  module Cloud
-    module TextToSpeech
-      module V1beta1
-        class Credentials < Google::Auth::Credentials
-          SCOPE = [
-            "https://www.googleapis.com/auth/cloud-platform"
-          ].freeze
-          PATH_ENV_VARS = %w(TEXTTOSPEECH_CREDENTIALS
-                             TEXTTOSPEECH_KEYFILE
-                             GOOGLE_CLOUD_CREDENTIALS
-                             GOOGLE_CLOUD_KEYFILE
-                             GCLOUD_KEYFILE)
-          JSON_ENV_VARS = %w(TEXTTOSPEECH_CREDENTIALS_JSON
-                             TEXTTOSPEECH_KEYFILE_JSON
-                             GOOGLE_CLOUD_CREDENTIALS_JSON
-                             GOOGLE_CLOUD_KEYFILE_JSON
-                             GCLOUD_KEYFILE_JSON)
-          DEFAULT_PATHS = ["~/.config/gcloud/application_default_credentials.json"]
-        end
-      end
-    end
-  end
-end

data/lib/google/cloud/text_to_speech/v1beta1/doc/google/cloud/texttospeech/v1beta1/cloud_tts.rb

@@ -1,206 +0,0 @@
-# Copyright 2020 Google LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-
-module Google
-  module Cloud
-    module TextToSpeech
-      module V1beta1
-        # The top-level message sent by the client for the `ListVoices` method.
-        # @!attribute [rw] language_code
-        #   @return [String]
-        #     Optional. Recommended.
-        #     [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) 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.
-        class ListVoicesRequest; end
-
-        # The message returned to the client by the `ListVoices` method.
-        # @!attribute [rw] voices
-        #   @return [Array<Google::Cloud::TextToSpeech::V1beta1::Voice>]
-        #     The list of voices.
-        class ListVoicesResponse; end
-
-        # Description of a voice supported by the TTS service.
-        # @!attribute [rw] language_codes
-        #   @return [Array<String>]
-        #     The languages that this voice supports, expressed as
-        #     [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tags (e.g.
-        #     "en-US", "es-419", "cmn-tw").
-        # @!attribute [rw] name
-        #   @return [String]
-        #     The name of this voice.  Each distinct voice has a unique name.
-        # @!attribute [rw] ssml_gender
-        #   @return [Google::Cloud::TextToSpeech::V1beta1::SsmlVoiceGender]
-        #     The gender of this voice.
-        # @!attribute [rw] natural_sample_rate_hertz
-        #   @return [Integer]
-        #     The natural sample rate (in hertz) for this voice.
-        class Voice; end
-
-        # The top-level message sent by the client for the `SynthesizeSpeech` method.
-        # @!attribute [rw] input
-        #   @return [Google::Cloud::TextToSpeech::V1beta1::SynthesisInput]
-        #     Required. The Synthesizer requires either plain text or SSML as input.
-        # @!attribute [rw] voice
-        #   @return [Google::Cloud::TextToSpeech::V1beta1::VoiceSelectionParams]
-        #     Required. The desired voice of the synthesized audio.
-        # @!attribute [rw] audio_config
-        #   @return [Google::Cloud::TextToSpeech::V1beta1::AudioConfig]
-        #     Required. The configuration of the synthesized audio.
-        class SynthesizeSpeechRequest; end
-
-        # Contains text input to be synthesized. Either `text` or `ssml` must be
-        # supplied. Supplying both or neither returns
-        # {Google::Rpc::Code::INVALID_ARGUMENT}. The input size is limited to 5000
-        # characters.
-        # @!attribute [rw] text
-        #   @return [String]
-        #     The raw text to be synthesized.
-        # @!attribute [rw] ssml
-        #   @return [String]
-        #     The SSML document to be synthesized. The SSML document must be valid
-        #     and well-formed. Otherwise the RPC will fail and return
-        #     {Google::Rpc::Code::INVALID_ARGUMENT}. For more information, see
-        #     [SSML](https://cloud.google.com/speech/text-to-speech/docs/ssml).
-        class SynthesisInput; end
-
-        # Description of which voice to use for a synthesis request.
-        # @!attribute [rw] language_code
-        #   @return [String]
-        #     Required. The language (and potentially also the region) of the voice expressed as a
-        #     [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) language tag, e.g.
-        #     "en-US". This should not include a script tag (e.g. use
-        #     "cmn-cn" rather than "cmn-Hant-cn"), because the script will be inferred
-        #     from the input provided in the SynthesisInput.  The TTS service
-        #     will use this parameter to help choose an appropriate voice.  Note that
-        #     the TTS service may choose a voice with a slightly different language code
-        #     than the one selected; it may substitute a different region
-        #     (e.g. using en-US rather than en-CA if there isn't a Canadian voice
-        #     available), or even a different language, e.g. using "nb" (Norwegian
-        #     Bokmal) instead of "no" (Norwegian)".
-        # @!attribute [rw] name
-        #   @return [String]
-        #     The name of the voice. If not set, the service will choose a
-        #     voice based on the other parameters such as language_code and gender.
-        # @!attribute [rw] ssml_gender
-        #   @return [Google::Cloud::TextToSpeech::V1beta1::SsmlVoiceGender]
-        #     The preferred gender of the voice. If not set, the service will
-        #     choose a voice based on the other parameters such as language_code and
-        #     name. Note that this is only a preference, not requirement; if a
-        #     voice of the appropriate gender is not available, the synthesizer should
-        #     substitute a voice with a different gender rather than failing the request.
-        class VoiceSelectionParams; end
-
-        # Description of audio data to be synthesized.
-        # @!attribute [rw] audio_encoding
-        #   @return [Google::Cloud::TextToSpeech::V1beta1::AudioEncoding]
-        #     Required. The format of the audio byte stream.
-        # @!attribute [rw] speaking_rate
-        #   @return [Float]
-        #     Optional. Input only. Speaking rate/speed, in the range [0.25, 4.0]. 1.0 is
-        #     the normal native speed supported by the specific voice. 2.0 is twice as
-        #     fast, and 0.5 is half as fast. If unset(0.0), defaults to the native 1.0
-        #     speed. Any other values < 0.25 or > 4.0 will return an error.
-        # @!attribute [rw] pitch
-        #   @return [Float]
-        #     Optional. Input only. Speaking pitch, in the range [-20.0, 20.0]. 20 means
-        #     increase 20 semitones from the original pitch. -20 means decrease 20
-        #     semitones from the original pitch.
-        # @!attribute [rw] volume_gain_db
-        #   @return [Float]
-        #     Optional. Input only. Volume gain (in dB) of the normal native volume
-        #     supported by the specific voice, in the range [-96.0, 16.0]. If unset, or
-        #     set to a value of 0.0 (dB), will play at normal native signal amplitude. A
-        #     value of -6.0 (dB) will play at approximately half the amplitude of the
-        #     normal native signal amplitude. A value of +6.0 (dB) will play at
-        #     approximately twice the amplitude of the normal native signal amplitude.
-        #     Strongly recommend not to exceed +10 (dB) as there's usually no effective
-        #     increase in loudness for any value greater than that.
-        # @!attribute [rw] sample_rate_hertz
-        #   @return [Integer]
-        #     Optional. The synthesis sample rate (in hertz) for this audio. When this is
-        #     specified in SynthesizeSpeechRequest, if this is different from the voice's
-        #     natural sample rate, then the synthesizer will honor this request by
-        #     converting to the desired sample rate (which might result in worse audio
-        #     quality), unless the specified sample rate is not supported for the
-        #     encoding chosen, in which case it will fail the request and return
-        #     {Google::Rpc::Code::INVALID_ARGUMENT}.
-        # @!attribute [rw] effects_profile_id
-        #   @return [Array<String>]
-        #     Optional. Input only. An identifier which selects 'audio effects' profiles
-        #     that are applied on (post synthesized) text to speech. Effects are applied
-        #     on top of each other in the order they are given. See
-        #     [audio
-        #     profiles](https://cloud.google.com/text-to-speech/docs/audio-profiles) for
-        #     current supported profile ids.
-        class AudioConfig; end
-
-        # The message returned to the client by the `SynthesizeSpeech` method.
-        # @!attribute [rw] audio_content
-        #   @return [String]
-        #     The audio data bytes encoded as specified in the request, including the
-        #     header for encodings that are wrapped in containers (e.g. MP3, OGG_OPUS).
-        #     For LINEAR16 audio, we include the WAV header. Note: as
-        #     with all bytes fields, protobuffers use a pure binary representation,
-        #     whereas JSON representations use base64.
-        class SynthesizeSpeechResponse; end
-
-        # Configuration to set up audio encoder. The encoding determines the output
-        # audio format that we'd like.
-        module AudioEncoding
-          # Not specified. Will return result {Google::Rpc::Code::INVALID_ARGUMENT}.
-          AUDIO_ENCODING_UNSPECIFIED = 0
-
-          # Uncompressed 16-bit signed little-endian samples (Linear PCM).
-          # Audio content returned as LINEAR16 also contains a WAV header.
-          LINEAR16 = 1
-
-          # MP3 audio at 32kbps.
-          MP3 = 2
-
-          # Opus encoded audio wrapped in an ogg container. The result will be a
-          # file which can be played natively on Android, and in browsers (at least
-          # Chrome and Firefox). The quality of the encoding is considerably higher
-          # than MP3 while using approximately the same bitrate.
-          OGG_OPUS = 3
-        end
-
-        # Gender of the voice as described in
-        # [SSML voice element](https://www.w3.org/TR/speech-synthesis11/#edef_voice).
-        module SsmlVoiceGender
-          # An unspecified gender.
-          # In VoiceSelectionParams, this means that the client doesn't care which
-          # gender the selected voice will have. In the Voice field of
-          # ListVoicesResponse, this may mean that the voice doesn't fit any of the
-          # other categories in this enum, or that the gender of the voice isn't known.
-          SSML_VOICE_GENDER_UNSPECIFIED = 0
-
-          # A male voice.
-          MALE = 1
-
-          # A female voice.
-          FEMALE = 2
-
-          # A gender-neutral voice.
-          NEUTRAL = 3
-        end
-      end
-    end
-  end
-end

data/lib/google/cloud/text_to_speech/v1beta1/text_to_speech_client.rb

@@ -1,279 +0,0 @@
-# Copyright 2020 Google LLC
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     https://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#
-# EDITING INSTRUCTIONS
-# This file was generated from the file
-# https://github.com/googleapis/googleapis/blob/master/google/cloud/texttospeech/v1beta1/cloud_tts.proto,
-# and updates to that file get reflected here through a refresh process.
-# For the short term, the refresh process will only be runnable by Google
-# engineers.
-
-
-require "json"
-require "pathname"
-
-require "google/gax"
-
-require "google/cloud/texttospeech/v1beta1/cloud_tts_pb"
-require "google/cloud/text_to_speech/v1beta1/credentials"
-require "google/cloud/text_to_speech/version"
-
-module Google
-  module Cloud
-    module TextToSpeech
-      module V1beta1
-        # Service that implements Google Cloud Text-to-Speech API.
-        #
-        # @!attribute [r] text_to_speech_stub
-        #   @return [Google::Cloud::TextToSpeech::V1beta1::TextToSpeech::Stub]
-        class TextToSpeechClient
-          # @private
-          attr_reader :text_to_speech_stub
-
-          # The default address of the service.
-          SERVICE_ADDRESS = "texttospeech.googleapis.com".freeze
-
-          # The default port of the service.
-          DEFAULT_SERVICE_PORT = 443
-
-          # The default set of gRPC interceptors.
-          GRPC_INTERCEPTORS = []
-
-          DEFAULT_TIMEOUT = 30
-
-          # The scopes needed to make gRPC calls to all of the methods defined in
-          # this service.
-          ALL_SCOPES = [
-            "https://www.googleapis.com/auth/cloud-platform"
-          ].freeze
-
-
-          # @param 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.
-          # @param scopes [Array<String>]
-          #   The OAuth scopes for this service. This parameter is ignored if
-          #   an updater_proc is supplied.
-          # @param 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.
-          # @param timeout [Numeric]
-          #   The default timeout, in seconds, for calls made through this client.
-          # @param metadata [Hash]
-          #   Default metadata to be sent with each request. This can be overridden on a per call basis.
-          # @param service_address [String]
-          #   Override for the service hostname, or `nil` to leave as the default.
-          # @param service_port [Integer]
-          #   Override for the service port, or `nil` to leave as the default.
-          # @param exception_transformer [Proc]
-          #   An optional proc that intercepts any exceptions raised during an API call to inject
-          #   custom error handling.
-          def initialize \
-              credentials: nil,
-              scopes: ALL_SCOPES,
-              client_config: {},
-              timeout: DEFAULT_TIMEOUT,
-              metadata: nil,
-              service_address: nil,
-              service_port: 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/v1beta1/cloud_tts_services_pb"
-
-            credentials ||= Google::Cloud::TextToSpeech::V1beta1::Credentials.default
-
-            if credentials.is_a?(String) || credentials.is_a?(Hash)
-              updater_proc = Google::Cloud::TextToSpeech::V1beta1::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 = Google::Cloud::TextToSpeech::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 }
-            if credentials.respond_to?(:quota_project_id) && credentials.quota_project_id
-              headers[:"x-goog-user-project"] = credentials.quota_project_id
-            end
-            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.v1beta1.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 = service_address || self.class::SERVICE_ADDRESS
-            port = service_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::V1beta1::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
-
-          # Service calls
-
-          # Returns a list of Voice supported for synthesis.
-          #
-          # @param language_code [String]
-          #   Optional. Recommended.
-          #   [BCP-47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt) 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.
-          # @param options [Google::Gax::CallOptions]
-          #   Overrides the default settings for this call, e.g, timeout,
-          #   retries, etc.
-          # @yield [result, operation] Access the result along with the RPC operation
-          # @yieldparam result [Google::Cloud::TextToSpeech::V1beta1::ListVoicesResponse]
-          # @yieldparam operation [GRPC::ActiveCall::Operation]
-          # @return [Google::Cloud::TextToSpeech::V1beta1::ListVoicesResponse]
-          # @raise [Google::Gax::GaxError] if the RPC is aborted.
-          # @example
-          #   require "google/cloud/text_to_speech"
-          #
-          #   text_to_speech_client = Google::Cloud::TextToSpeech.new(version: :v1beta1)
-          #   response = text_to_speech_client.list_voices
-
-          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::V1beta1::ListVoicesRequest)
-            @list_voices.call(req, options, &block)
-          end
-
-          # Synthesizes speech synchronously: receive results after all text input
-          # has been processed.
-          #
-          # @param input [Google::Cloud::TextToSpeech::V1beta1::SynthesisInput | Hash]
-          #   Required. The Synthesizer requires either plain text or SSML as input.
-          #   A hash of the same form as `Google::Cloud::TextToSpeech::V1beta1::SynthesisInput`
-          #   can also be provided.
-          # @param voice [Google::Cloud::TextToSpeech::V1beta1::VoiceSelectionParams | Hash]
-          #   Required. The desired voice of the synthesized audio.
-          #   A hash of the same form as `Google::Cloud::TextToSpeech::V1beta1::VoiceSelectionParams`
-          #   can also be provided.
-          # @param audio_config [Google::Cloud::TextToSpeech::V1beta1::AudioConfig | Hash]
-          #   Required. The configuration of the synthesized audio.
-          #   A hash of the same form as `Google::Cloud::TextToSpeech::V1beta1::AudioConfig`
-          #   can also be provided.
-          # @param options [Google::Gax::CallOptions]
-          #   Overrides the default settings for this call, e.g, timeout,
-          #   retries, etc.
-          # @yield [result, operation] Access the result along with the RPC operation
-          # @yieldparam result [Google::Cloud::TextToSpeech::V1beta1::SynthesizeSpeechResponse]
-          # @yieldparam operation [GRPC::ActiveCall::Operation]
-          # @return [Google::Cloud::TextToSpeech::V1beta1::SynthesizeSpeechResponse]
-          # @raise [Google::Gax::GaxError] if the RPC is aborted.
-          # @example
-          #   require "google/cloud/text_to_speech"
-          #
-          #   text_to_speech_client = Google::Cloud::TextToSpeech.new(version: :v1beta1)
-          #
-          #   # 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)
-
-          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::V1beta1::SynthesizeSpeechRequest)
-            @synthesize_speech.call(req, options, &block)
-          end
-        end
-      end
-    end
-  end
-end