google-cloud-speech 0.41.0 → 1.0.0

data/lib/google/cloud/speech/v1p1beta1/speech_client.rb

@@ -1,346 +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/speech/v1p1beta1/cloud_speech.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/gax/operation"
-require "google/longrunning/operations_client"
-
-require "google/cloud/speech/v1p1beta1/cloud_speech_pb"
-require "google/cloud/speech/v1p1beta1/credentials"
-require "google/cloud/speech/version"
-
-module Google
-  module Cloud
-    module Speech
-      module V1p1beta1
-        # Service that implements Google Cloud Speech API.
-        #
-        # @!attribute [r] speech_stub
-        #   @return [Google::Cloud::Speech::V1p1beta1::Speech::Stub]
-        class SpeechClient
-          # @private
-          attr_reader :speech_stub
-
-          # The default address of the service.
-          SERVICE_ADDRESS = "speech.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
-
-          # @private
-          class OperationsClient < Google::Longrunning::OperationsClient
-            self::SERVICE_ADDRESS = SpeechClient::SERVICE_ADDRESS
-            self::GRPC_INTERCEPTORS = SpeechClient::GRPC_INTERCEPTORS
-          end
-
-          # @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/speech/v1p1beta1/cloud_speech_services_pb"
-
-            credentials ||= Google::Cloud::Speech::V1p1beta1::Credentials.default
-
-            @operations_client = OperationsClient.new(
-              credentials: credentials,
-              scopes: scopes,
-              client_config: client_config,
-              timeout: timeout,
-              lib_name: lib_name,
-              service_address: service_address,
-              service_port: service_port,
-              lib_version: lib_version,
-              metadata: metadata,
-            )
-
-            if credentials.is_a?(String) || credentials.is_a?(Hash)
-              updater_proc = Google::Cloud::Speech::V1p1beta1::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::Speech::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(
-              "speech_client_config.json"
-            )
-            defaults = client_config_file.open do |f|
-              Google::Gax.construct_settings(
-                "google.cloud.speech.v1p1beta1.Speech",
-                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
-            @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::Speech::V1p1beta1::Speech::Stub.method(:new)
-            )
-
-            @recognize = Google::Gax.create_api_call(
-              @speech_stub.method(:recognize),
-              defaults["recognize"],
-              exception_transformer: exception_transformer
-            )
-            @long_running_recognize = Google::Gax.create_api_call(
-              @speech_stub.method(:long_running_recognize),
-              defaults["long_running_recognize"],
-              exception_transformer: exception_transformer
-            )
-            @streaming_recognize = Google::Gax.create_api_call(
-              @speech_stub.method(:streaming_recognize),
-              defaults["streaming_recognize"],
-              exception_transformer: exception_transformer
-            )
-          end
-
-          # Service calls
-
-          # Performs synchronous speech recognition: receive results after all audio
-          # has been sent and processed.
-          #
-          # @param config [Google::Cloud::Speech::V1p1beta1::RecognitionConfig | Hash]
-          #   Required. Provides information to the recognizer that specifies how to
-          #   process the request.
-          #   A hash of the same form as `Google::Cloud::Speech::V1p1beta1::RecognitionConfig`
-          #   can also be provided.
-          # @param audio [Google::Cloud::Speech::V1p1beta1::RecognitionAudio | Hash]
-          #   Required. The audio data to be recognized.
-          #   A hash of the same form as `Google::Cloud::Speech::V1p1beta1::RecognitionAudio`
-          #   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::Speech::V1p1beta1::RecognizeResponse]
-          # @yieldparam operation [GRPC::ActiveCall::Operation]
-          # @return [Google::Cloud::Speech::V1p1beta1::RecognizeResponse]
-          # @raise [Google::Gax::GaxError] if the RPC is aborted.
-          # @example
-          #   require "google/cloud/speech"
-          #
-          #   speech_client = Google::Cloud::Speech.new(version: :v1p1beta1)
-          #   encoding = :FLAC
-          #   sample_rate_hertz = 44100
-          #   language_code = "en-US"
-          #   config = {
-          #     encoding: encoding,
-          #     sample_rate_hertz: sample_rate_hertz,
-          #     language_code: language_code
-          #   }
-          #   uri = "gs://bucket_name/file_name.flac"
-          #   audio = { uri: uri }
-          #   response = speech_client.recognize(config, audio)
-
-          def recognize \
-              config,
-              audio,
-              options: nil,
-              &block
-            req = {
-              config: config,
-              audio: audio
-            }.delete_if { |_, v| v.nil? }
-            req = Google::Gax::to_proto(req, Google::Cloud::Speech::V1p1beta1::RecognizeRequest)
-            @recognize.call(req, options, &block)
-          end
-
-          # Performs asynchronous speech recognition: receive results via the
-          # google.longrunning.Operations interface. Returns either an
-          # `Operation.error` or an `Operation.response` which contains
-          # a `LongRunningRecognizeResponse` message.
-          # For more information on asynchronous speech recognition, see the
-          # [how-to](https://cloud.google.com/speech-to-text/docs/async-recognize).
-          #
-          # @param config [Google::Cloud::Speech::V1p1beta1::RecognitionConfig | Hash]
-          #   Required. Provides information to the recognizer that specifies how to
-          #   process the request.
-          #   A hash of the same form as `Google::Cloud::Speech::V1p1beta1::RecognitionConfig`
-          #   can also be provided.
-          # @param audio [Google::Cloud::Speech::V1p1beta1::RecognitionAudio | Hash]
-          #   Required. The audio data to be recognized.
-          #   A hash of the same form as `Google::Cloud::Speech::V1p1beta1::RecognitionAudio`
-          #   can also be provided.
-          # @param options [Google::Gax::CallOptions]
-          #   Overrides the default settings for this call, e.g, timeout,
-          #   retries, etc.
-          # @return [Google::Gax::Operation]
-          # @raise [Google::Gax::GaxError] if the RPC is aborted.
-          # @example
-          #   require "google/cloud/speech"
-          #
-          #   speech_client = Google::Cloud::Speech.new(version: :v1p1beta1)
-          #   encoding = :FLAC
-          #   sample_rate_hertz = 44100
-          #   language_code = "en-US"
-          #   config = {
-          #     encoding: encoding,
-          #     sample_rate_hertz: sample_rate_hertz,
-          #     language_code: language_code
-          #   }
-          #   uri = "gs://bucket_name/file_name.flac"
-          #   audio = { uri: uri }
-          #
-          #   # Register a callback during the method call.
-          #   operation = speech_client.long_running_recognize(config, audio) do |op|
-          #     raise op.results.message if op.error?
-          #     op_results = op.results
-          #     # Process the results.
-          #
-          #     metadata = op.metadata
-          #     # Process the metadata.
-          #   end
-          #
-          #   # Or use the return value to register a callback.
-          #   operation.on_done do |op|
-          #     raise op.results.message if op.error?
-          #     op_results = op.results
-          #     # Process the results.
-          #
-          #     metadata = op.metadata
-          #     # Process the metadata.
-          #   end
-          #
-          #   # Manually reload the operation.
-          #   operation.reload!
-          #
-          #   # Or block until the operation completes, triggering callbacks on
-          #   # completion.
-          #   operation.wait_until_done!
-
-          def long_running_recognize \
-              config,
-              audio,
-              options: nil
-            req = {
-              config: config,
-              audio: audio
-            }.delete_if { |_, v| v.nil? }
-            req = Google::Gax::to_proto(req, Google::Cloud::Speech::V1p1beta1::LongRunningRecognizeRequest)
-            operation = Google::Gax::Operation.new(
-              @long_running_recognize.call(req, options),
-              @operations_client,
-              Google::Cloud::Speech::V1p1beta1::LongRunningRecognizeResponse,
-              Google::Cloud::Speech::V1p1beta1::LongRunningRecognizeMetadata,
-              call_options: options
-            )
-            operation.on_done { |operation| yield(operation) } if block_given?
-            operation
-          end
-        end
-      end
-    end
-  end
-end

data/lib/google/cloud/speech/v1p1beta1/speech_client_config.json

@@ -1,41 +0,0 @@
-{
-  "interfaces": {
-    "google.cloud.speech.v1p1beta1.Speech": {
-      "retry_codes": {
-        "idempotent": [
-          "DEADLINE_EXCEEDED",
-          "UNAVAILABLE"
-        ],
-        "non_idempotent": []
-      },
-      "retry_params": {
-        "default": {
-          "initial_retry_delay_millis": 100,
-          "retry_delay_multiplier": 1.3,
-          "max_retry_delay_millis": 60000,
-          "initial_rpc_timeout_millis": 1000000,
-          "rpc_timeout_multiplier": 1.0,
-          "max_rpc_timeout_millis": 1000000,
-          "total_timeout_millis": 5000000
-        }
-      },
-      "methods": {
-        "Recognize": {
-          "timeout_millis": 60000,
-          "retry_codes_name": "non_idempotent",
-          "retry_params_name": "default"
-        },
-        "LongRunningRecognize": {
-          "timeout_millis": 60000,
-          "retry_codes_name": "non_idempotent",
-          "retry_params_name": "default"
-        },
-        "StreamingRecognize": {
-          "timeout_millis": 60000,
-          "retry_codes_name": "non_idempotent",
-          "retry_params_name": "default"
-        }
-      }
-    }
-  }
-}

data/lib/google/cloud/speech/v1p1beta1/stream.rb

@@ -1,615 +0,0 @@
-# Copyright 2018 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 "google/cloud/speech/v1p1beta1"
-require "monitor"
-require "forwardable"
-
-module Google
-  module Cloud
-    module Speech
-      module V1p1beta1
-        ##
-        # # Stream
-        #
-        # A resource that represents the streaming requests and responses.
-        #
-        # @example
-        #   require "google/cloud/speech"
-        #
-        #   speech_client = Google::Cloud::Speech.new version: :v1p1beta1
-        #   streaming_config = {
-        #     config: {
-        #       encoding: :linear16,
-        #       language_code: "en-US",
-        #       sample_rate_hertz: 16000
-        #     }
-        #   }
-        #   stream = speech_client.streaming_recognize(streaming_config)
-        #
-        #   # Stream 5 seconds of audio from the microphone
-        #   # Actual implementation of microphone input varies by platform
-        #   5.times do
-        #     stream.send MicrophoneInput.read(32000)
-        #   end
-        #
-        #   stream.stop
-        #   stream.wait_until_complete!
-        #
-        #   results = stream.results
-        #   result = results.first.alternatives.first
-        #   result.transcript #=> "how old is the Brooklyn Bridge"
-        #   result.confidence #=> 0.9826789498329163
-        #
-        class Stream
-          include MonitorMixin
-          ##
-          # @private Creates a new Speech Stream instance.
-          # This must always be private, since it may change as the implementation
-          # changes over time.
-          def initialize streaming_config, streaming_call
-            super() # to init MonitorMixin
-
-            @streaming_call = streaming_call
-            @streaming_recognize_request = {
-              streaming_config: streaming_config
-            }
-            @results = []
-            @callbacks = Hash.new { |h, k| h[k] = [] }
-          end
-
-          ##
-          # Starts the stream. The stream will be started in the first #send call.
-          def start
-            return if @request_queue
-            @request_queue = EnumeratorQueue.new(self)
-            @request_queue.push @streaming_recognize_request
-
-            Thread.new { background_run }
-          end
-
-          ##
-          # Checks if the stream has been started.
-          #
-          # @return [boolean] `true` when started, `false` otherwise.
-          def started?
-            synchronize do
-              !(!@request_queue)
-            end
-          end
-
-          ##
-          # Sends audio content to the server.
-          #
-          # @param [String] bytes A string of binary audio data to be recognized.
-          #   The data should be encoded as `ASCII-8BIT`.
-          #
-          # @example
-          #   require "google/cloud/speech"
-          #
-          #   speech_client = Google::Cloud::Speech.new version: :v1p1beta1
-          #   streaming_config = {
-          #     config: {
-          #       encoding: :linear16,
-          #       language_code: "en-US",
-          #       sample_rate_hertz: 16000
-          #     }
-          #   }
-          #   stream = speech_client.streaming_recognize(streaming_config)
-          #
-          #   # Stream 5 seconds of audio from the microphone
-          #   # Actual implementation of microphone input varies by platform
-          #   5.times do
-          #     stream.send MicrophoneInput.read(32000)
-          #   end
-          #
-          #   stream.stop
-          #   stream.wait_until_complete!
-          #
-          #   results = stream.results
-          #   result = results.first.alternatives.first
-          #   result.transcript #=> "how old is the Brooklyn Bridge"
-          #   result.confidence #=> 0.9826789498329163
-          #
-          def send bytes
-            start # lazily call start if the stream wasn't started yet
-            # TODO: do not send if stopped?
-            synchronize do
-              req = V1p1beta1::StreamingRecognizeRequest.new(
-                audio_content: bytes.encode(Encoding::ASCII_8BIT)
-              )
-              @request_queue.push req
-            end
-          end
-
-          ##
-          # Stops the stream. Signals to the server that no more data will be
-          # sent.
-          def stop
-            synchronize do
-              return if @request_queue.nil?
-              @request_queue.push self
-              @stopped = true
-            end
-          end
-
-          ##
-          # Checks if the stream has been stopped.
-          #
-          # @return [boolean] `true` when stopped, `false` otherwise.
-          def stopped?
-            synchronize do
-              @stopped
-            end
-          end
-
-          ##
-          # The speech recognition results for the audio.
-          #
-          # @return [Array<Result>] The transcribed text of audio recognized.
-          #
-          # @example
-          #   require "google/cloud/speech"
-          #
-          #   speech_client = Google::Cloud::Speech.new version: :v1p1beta1
-          #   streaming_config = {
-          #     config: {
-          #       encoding: :linear16,
-          #       language_code: "en-US",
-          #       sample_rate_hertz: 16000
-          #     }
-          #   }
-          #   stream = speech_client.streaming_recognize(streaming_config)
-          #
-          #   # Stream 5 seconds of audio from the microphone
-          #   # Actual implementation of microphone input varies by platform
-          #   5.times do
-          #     stream.send MicrophoneInput.read(32000)
-          #   end
-          #
-          #   stream.stop
-          #
-          #   results = stream.results
-          #   results.each do |result|
-          #     result.alternatives.each do |alternative|
-          #       puts alternative.transcript
-          #       puts alternative.confidence
-          #     end
-          #   end
-          #
-          def results
-            synchronize do
-              @results
-            end
-          end
-
-          ##
-          # Whether all speech recognition results have been returned.
-          #
-          # @return [Boolean] All speech recognition results have been returned.
-          #
-          # @example
-          #   require "google/cloud/speech"
-          #
-          #   speech_client = Google::Cloud::Speech.new version: :v1p1beta1
-          #   streaming_config = {
-          #     config: {
-          #       encoding: :linear16,
-          #       language_code: "en-US",
-          #       sample_rate_hertz: 16000
-          #     }
-          #   }
-          #   stream = speech_client.streaming_recognize(streaming_config)
-          #
-          #   # Stream 5 seconds of audio from the microphone
-          #   # Actual implementation of microphone input varies by platform
-          #   5.times do
-          #     stream.send MicrophoneInput.read(32000)
-          #   end
-          #
-          #   stream.stop
-          #
-          #   stream.wait_until_complete!
-          #   stream.complete? #=> true
-          #
-          #   results = stream.results
-          #   results.each do |result|
-          #     result.alternatives.each do |alternative|
-          #       puts alternative.transcript
-          #       puts alternative.confidence
-          #     end
-          #   end
-          #
-          def complete?
-            synchronize do
-              @complete
-            end
-          end
-
-          ##
-          # Blocks until all speech recognition results have been returned.
-          #
-          # @example
-          #   require "google/cloud/speech"
-          #
-          #   speech_client = Google::Cloud::Speech.new version: :v1p1beta1
-          #   streaming_config = {
-          #     config: {
-          #       encoding: :linear16,
-          #       language_code: "en-US",
-          #       sample_rate_hertz: 16000
-          #     }
-          #   }
-          #   stream = speech_client.streaming_recognize(streaming_config)
-          #
-          #   # Stream 5 seconds of audio from the microphone
-          #   # Actual implementation of microphone input varies by platform
-          #   5.times do
-          #     stream.send MicrophoneInput.read(32000)
-          #   end
-          #
-          #   stream.stop
-          #
-          #   stream.wait_until_complete!
-          #   stream.complete? #=> true
-          #
-          #   results = stream.results
-          #   results.each do |result|
-          #     result.alternatives.each do |alternative|
-          #       puts alternative.transcript
-          #       puts alternative.confidence
-          #     end
-          #   end
-          #
-          def wait_until_complete!
-            complete_check = nil
-            synchronize { complete_check = @complete }
-            while complete_check.nil?
-              sleep 1
-              synchronize { complete_check = @complete }
-            end
-          end
-
-          ##
-          # Register to be notified on the reception of an interim result.
-          #
-          # @yield [callback] The block for accessing final and interim results.
-          # @yieldparam [Array<Result>] final_results The final results.
-          # @yieldparam [Array<Result>] interim_results The interim results.
-          #
-          # @example
-          #   require "google/cloud/speech"
-          #
-          #   speech_client = Google::Cloud::Speech.new version: :v1p1beta1
-          #   streaming_config = {
-          #     config: {
-          #       encoding: :linear16,
-          #       language_code: "en-US",
-          #       sample_rate_hertz: 16000
-          #     },
-          #     interim_results: true
-          #   }
-          #   stream = speech_client.streaming_recognize(streaming_config)
-          #
-          #   # register callback for when an interim result is returned
-          #   stream.on_interim do |final_results, interim_results|
-          #     interim_result = interim_results.first
-          #     interim_alternative = interim_result.alternatives.first
-          #     puts interim_alternative.transcript # "how old is the Brooklyn Bridge"
-          #     puts interim_alternative.confidence # 0.9826789498329163
-          #     puts interim_result.stability # 0.8999
-          #   end
-          #
-          #   # Stream 5 seconds of audio from the microphone
-          #   # Actual implementation of microphone input varies by platform
-          #   5.times do
-          #     stream.send MicrophoneInput.read(32000)
-          #   end
-          #
-          #   stream.stop
-          #
-          def on_interim &block
-            synchronize do
-              @callbacks[:interim] << block
-            end
-          end
-
-          ##
-          # @private yields two arguments, all final results and the
-          # non-final/incomplete result
-          def pass_interim! interim_results
-            synchronize do
-              @callbacks[:interim].each { |c| c.call results, interim_results }
-            end
-          end
-
-          ##
-          # Register to be notified on the reception of a final result.
-          #
-          # @yield [callback] The block for accessing final results.
-          # @yieldparam [Array<Result>] results The final results.
-          #
-          # @example
-          #   require "google/cloud/speech"
-          #
-          #   speech_client = Google::Cloud::Speech.new version: :v1p1beta1
-          #   streaming_config = {
-          #     config: {
-          #       encoding: :linear16,
-          #       language_code: "en-US",
-          #       sample_rate_hertz: 16000
-          #     }
-          #   }
-          #   stream = speech_client.streaming_recognize(streaming_config)
-          #
-          #   # register callback for when a final result has been received
-          #   stream.on_result do |results|
-          #     results.each do |result|
-          #       puts result.alternatives.first.transcript
-          #     end
-          #   end
-          #
-          #   # Stream 5 seconds of audio from the microphone
-          #   # Actual implementation of microphone input varies by platform
-          #   5.times do
-          #     stream.send MicrophoneInput.read(32000)
-          #   end
-          #
-          #   stream.stop
-          #   stream.wait_until_complete!
-          #
-          #   results = stream.results
-          #   result = results.first.alternatives.first
-          #   result.transcript #=> "how old is the Brooklyn Bridge"
-          #   result.confidence #=> 0.9826789498329163
-          #
-          def on_result &block
-            synchronize do
-              @callbacks[:result] << block
-            end
-          end
-
-          ##
-          # @private add a result object, and call the callbacks
-          def pass_result! result_grpc
-            synchronize do
-              @results << result_grpc
-              @callbacks[:result].each { |c| c.call @results }
-            end
-          end
-
-          ##
-          # Register to be notified when the end of the audio stream has been
-          # reached.
-          #
-          # @yield [callback] The block to be called when the end of the audio
-          #   stream has been reached.
-          #
-          # @example
-          #   require "google/cloud/speech"
-          #
-          #   speech_client = Google::Cloud::Speech.new version: :v1p1beta1
-          #   streaming_config = {
-          #     config: {
-          #       encoding: :linear16,
-          #       language_code: "en-US",
-          #       sample_rate_hertz: 16000
-          #     }
-          #   }
-          #   stream = speech_client.streaming_recognize(streaming_config)
-          #
-          #   # register callback for when stream has ended.
-          #   stream.on_complete do
-          #     puts "Stream has ended."
-          #   end
-          #
-          #   # Stream 5 seconds of audio from the microphone
-          #   # Actual implementation of microphone input varies by platform
-          #   5.times do
-          #     stream.send MicrophoneInput.read(32000)
-          #   end
-          #
-          #   stream.stop
-          #
-          def on_complete &block
-            synchronize do
-              @callbacks[:complete] << block
-            end
-          end
-
-          ##
-          # @private yields when the end of the audio stream has been reached.
-          def pass_complete!
-            synchronize do
-              @complete = true
-              @callbacks[:complete].each(&:call)
-            end
-          end
-
-          ##
-          # Register to be notified when the server has detected the end of the
-          # user's speech utterance and expects no additional speech. Therefore,
-          # the server will not process additional audio. The client should stop
-          # sending additional audio data. This event only occurs when `utterance`
-          # is `true`.
-          #
-          # @yield [callback] The block to be called when the end of the audio
-          #   stream has been reached.
-          #
-          # @example
-          #   require "google/cloud/speech"
-          #
-          #   speech_client = Google::Cloud::Speech.new version: :v1p1beta1
-          #   streaming_config = {
-          #     config: {
-          #       encoding: :linear16,
-          #       language_code: "en-US",
-          #       sample_rate_hertz: 16000
-          #     },
-          #     single_utterance: true
-          #   }
-          #   stream = speech_client.streaming_recognize(streaming_config)
-          #
-          #   # register callback for when utterance has occurred.
-          #   stream.on_utterance do
-          #     puts "Utterance has occurred."
-          #     stream.stop
-          #   end
-          #
-          #   # Stream 5 seconds of audio from the microphone
-          #   # Actual implementation of microphone input varies by platform
-          #   5.times do
-          #     stream.send MicrophoneInput.read(32000)
-          #   end
-          #
-          #   stream.stop unless stream.stopped?
-          #
-          def on_utterance &block
-            synchronize do
-              @callbacks[:utterance] << block
-            end
-          end
-
-          ##
-          # @private returns single final result once :END_OF_SINGLE_UTTERANCE is
-          # received.
-          def pass_utterance!
-            synchronize do
-              @callbacks[:utterance].each(&:call)
-            end
-          end
-
-          ##
-          # Register to be notified of an error received during the stream.
-          #
-          # @yield [callback] The block for accessing final results.
-          # @yieldparam [Exception] error The error raised.
-          #
-          # @example
-          #   require "google/cloud/speech"
-          #
-          #   speech_client = Google::Cloud::Speech.new version: :v1p1beta1
-          #   streaming_config = {
-          #     config: {
-          #       encoding: :linear16,
-          #       language_code: "en-US",
-          #       sample_rate_hertz: 16000
-          #     }
-          #   }
-          #   stream = speech_client.streaming_recognize(streaming_config)
-          #
-          #   # register callback for when an error is returned
-          #   stream.on_error do |error|
-          #     puts "The following error occurred while streaming: #{error}"
-          #     stream.stop
-          #   end
-          #
-          #   # Stream 5 seconds of audio from the microphone
-          #   # Actual implementation of microphone input varies by platform
-          #   5.times do
-          #     stream.send MicrophoneInput.read(32000)
-          #   end
-          #
-          #   stream.stop
-          #
-          def on_error &block
-            synchronize do
-              @callbacks[:error] << block
-            end
-          end
-
-          # @private returns error object from the stream thread.
-          def error! err
-            synchronize do
-              @callbacks[:error].each { |c| c.call err }
-            end
-          end
-
-          protected
-
-          def background_run
-            response_enum = @streaming_call.call(@request_queue.each_item)
-            response_enum.each do |response|
-              begin
-                background_results response
-                background_event_type response.speech_event_type
-                background_error response.error
-              rescue StandardError => e
-                error! e
-              end
-            end
-          rescue StandardError => e
-            error! e
-          ensure
-            pass_complete!
-            Thread.pass
-          end
-
-          def background_results response
-            # Handle the results (StreamingRecognitionResult)
-            return unless response.results && response.results.any?
-
-            final_grpc = response.results.select { |res| res.is_final }
-            # Only one final result
-            final_grpc = if final_grpc.any? then final_grpc.first else nil end
-
-            interim_grpc = response.results.select { |res| !res.is_final }
-
-            # callback for interim results received
-            pass_interim! interim_grpc if interim_grpc.any?
-            # callback for final results received, if any
-            pass_result! final_grpc if final_grpc
-          end
-
-          def background_event_type event_type
-            # Handle the event_type by raising events
-            # TODO: do we automatically call stop here?
-            pass_utterance! if event_type == :END_OF_SINGLE_UTTERANCE
-          end
-
-          def background_error error
-            return if error.nil?
-
-            require "grpc/errors"
-            raise GRPC::BadStatus.new(error.code, error.message)
-          end
-
-          # @private
-          class EnumeratorQueue
-            extend Forwardable
-            def_delegators :@q, :push
-
-            # @private
-            def initialize sentinel
-              @q = Queue.new
-              @sentinel = sentinel
-            end
-
-            # @private
-            def each_item
-              return enum_for(:each_item) unless block_given?
-              loop do
-                r = @q.pop
-                break if r.equal? @sentinel
-                raise r if r.is_a? Exception
-                yield r
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end