Class: Google::Cloud::Speech::Stream

Inherits:
Object
  • Object
show all
Includes:
MonitorMixin
Defined in:
lib/google/cloud/speech/stream.rb

Overview

Stream

A resource that represents the streaming requests and responses.

Examples:

require "google/cloud/speech"

speech = Google::Cloud::Speech.new

stream = speech.stream encoding: :raw, sample_rate: 16000

# register callback for when a result is returned
stream.on_result do |results|
  result = results.first
  puts result.transcript # "how old is the Brooklyn Bridge"
  puts result.confidence # 0.9826789498329163
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

Instance Method Summary collapse

Instance Method Details

#on_complete {|callback| ... } ⇒ Object

Register to be notified when the end of the audio stream has been reached.

Examples:

require "google/cloud/speech"

speech = Google::Cloud::Speech.new

stream = speech.stream encoding: :raw, sample_rate: 16000

# register callback for when audio has ended.
stream.on_complete do
  puts "Audio 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

Yields:

  • (callback) —

    The block to be called when the end of the audio stream has been reached.



381
382
383
384
385
 
# File 'lib/google/cloud/speech/stream.rb', line 381

def on_complete &block
  synchronize do
    @callbacks[:complete] << block
  end
end

#on_error {|callback| ... } ⇒ Object

Register to be notified of an error received during the stream.

Examples:

require "google/cloud/speech"

speech = Google::Cloud::Speech.new

stream = speech.stream encoding: :raw, sample_rate: 16000

# 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

Yields:

  • (callback) —

    The block for accessing final results.

Yield Parameters:

  • error (Exception) —

    The error raised.



470
471
472
473
474
 
# File 'lib/google/cloud/speech/stream.rb', line 470

def on_error &block
  synchronize do
    @callbacks[:error] << block
  end
end

#on_interim {|callback| ... } ⇒ Object

Register to be notified on the reception of an interim result.

Examples:

require "google/cloud/speech"

speech = Google::Cloud::Speech.new

stream = speech.stream encoding: :raw, sample_rate: 16000

# register callback for when an interim result is returned
stream.on_interim do |final_results, interim_results|
  interim_result = interim_results.first
  puts interim_result.transcript # "how old is the Brooklyn Bridge"
  puts interim_result.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

Yields:

  • (callback) —

    The block for accessing final and interim results.

Yield Parameters:

  • final_results (Array<Result>) —

    The final results.

  • interim_results (Array<Result>) —

    The interim results.



208
209
210
211
212
 
# File 'lib/google/cloud/speech/stream.rb', line 208

def on_interim &block
  synchronize do
    @callbacks[:interim] << block
  end
end

#on_result {|callback| ... } ⇒ Object

Register to be notified on the reception of a final result.

Examples:

require "google/cloud/speech"

speech = Google::Cloud::Speech.new

stream = speech.stream encoding: :raw, sample_rate: 16000

# register callback for when an interim result is returned
stream.on_result do |results|
  result = results.first
  puts result.transcript # "how old is the Brooklyn Bridge"
  puts result.confidence # 0.9826789498329163
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

Yields:

  • (callback) —

    The block for accessing final results.

Yield Parameters:

  • results (Array<Result>) —

    The final results.



250
251
252
253
254
 
# File 'lib/google/cloud/speech/stream.rb', line 250

def on_result &block
  synchronize do
    @callbacks[:result] << block
  end
end

#on_speech_end {|callback| ... } ⇒ Object

Register to be notified when speech has ceased to be detected in the audio stream.

Examples:

require "google/cloud/speech"

speech = Google::Cloud::Speech.new

stream = speech.stream encoding: :raw, sample_rate: 16000

# register callback for when speech has ended.
stream.on_speech_end do
  puts "Speech 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

Yields:

  • (callback) —

    The block to be called when speech has ceased to be detected in the audio stream.



340
341
342
343
344
 
# File 'lib/google/cloud/speech/stream.rb', line 340

def on_speech_end &block
  synchronize do
    @callbacks[:speech_end] << block
  end
end

#on_speech_start {|callback| ... } ⇒ Object

Register to be notified when speech has been detected in the audio stream.

Examples:

require "google/cloud/speech"

speech = Google::Cloud::Speech.new

stream = speech.stream encoding: :raw, sample_rate: 16000

# register callback for when speech has started.
stream.on_speech_start do
  puts "Speech has started."
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

Yields:

  • (callback) —

    The block to be called when speech has been detected in the audio stream.



299
300
301
302
303
 
# File 'lib/google/cloud/speech/stream.rb', line 299

def on_speech_start &block
  synchronize do
    @callbacks[:speech_start] << block
  end
end

#on_utterance {|callback| ... } ⇒ Object

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.

Examples:

require "google/cloud/speech"

speech = Google::Cloud::Speech.new

stream = speech.stream encoding: :raw,
                       sample_rate: 16000,
                       utterance: true

# 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?

Yields:

  • (callback) —

    The block to be called when the end of the audio stream has been reached.



429
430
431
432
433
 
# File 'lib/google/cloud/speech/stream.rb', line 429

def on_utterance &block
  synchronize do
    @callbacks[:utterance] << block
  end
end

#results ⇒ Array<Result>

The speech recognition results for the audio.

Examples:

require "google/cloud/speech"

speech = Google::Cloud::Speech.new

stream = speech.stream encoding: :raw, sample_rate: 16000

# 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|
  puts result.transcript
  puts result.confidence
end

Returns:

  • (Array<Result>) —

    The transcribed text of audio recognized.



172
173
174
175
176
 
# File 'lib/google/cloud/speech/stream.rb', line 172

def results
  synchronize do
    @results
  end
end

#send(bytes) ⇒ Object

Sends audio content to the server.

Examples:

require "google/cloud/speech"

speech = Google::Cloud::Speech.new

audio = speech.audio "path/to/audio.raw"

stream = speech.stream encoding: :raw, sample_rate: 16000

# register callback for when a result is returned
stream.on_result do |results|
  result = results.first
  puts result.transcript # "how old is the Brooklyn Bridge"
  puts result.confidence # 0.9826789498329163
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

Parameters:

  • bytes (String) —

    A string of binary audio data to be recognized. The data should be encoded as ASCII-8BIT.



115
116
117
118
119
120
121
122
123
 
# File 'lib/google/cloud/speech/stream.rb', line 115

def send bytes
  start # lazily call start if the stream wasn't started yet
  # TODO: do not send if stopped?
  synchronize do
    req = V1beta1::StreamingRecognizeRequest.new(
      audio_content: bytes.encode("ASCII-8BIT"))
    @request_queue.push req
  end
end

#start ⇒ Object

Starts the stream. The stream will be started in the first #send call.



67
68
69
70
71
72
73
 
# File 'lib/google/cloud/speech/stream.rb', line 67

def start
  return if @request_queue
  @request_queue = EnumeratorQueue.new(self)
  @request_queue.push @streaming_recognize_request

  Thread.new { background_run }
end

#started? ⇒ boolean

Checks if the stream has been started.

Returns:

  • (boolean) —

    true when started, false otherwise.



79
80
81
82
83
 
# File 'lib/google/cloud/speech/stream.rb', line 79

def started?
  synchronize do
    !(!@request_queue)
  end
end

#stop ⇒ Object

Stops the stream. Signals to the server that no more data will be sent.



128
129
130
131
132
133
134
 
# File 'lib/google/cloud/speech/stream.rb', line 128

def stop
  synchronize do
    return if @request_queue.nil?
    @request_queue.push self
    @stopped = true
  end
end

#stopped? ⇒ boolean

Checks if the stream has been stopped.

Returns:

  • (boolean) —

    true when stopped, false otherwise.



140
141
142
143
144
 
# File 'lib/google/cloud/speech/stream.rb', line 140

def stopped?
  synchronize do
    @stopped
  end
end