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,
                       language: "en-US",
                       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
stream.wait_until_complete!

results = stream.results
result = results.first
result.transcript #=> "how old is the Brooklyn Bridge"
result.confidence #=> 0.9826789498329163

Instance Method Summary collapse

Instance Method Details

#complete? ⇒ Boolean

Whether all speech recognition results have been returned.

Examples:

require "google/cloud/speech"

speech = Google::Cloud::Speech.new

stream = speech.stream encoding: :raw,
                       language: "en-US",
                       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

stream.wait_until_complete!
stream.complete? #=> true

results = stream.results
results.each do |result|
  puts result.transcript
  puts result.confidence
end

Returns:

  • (Boolean) —

    All speech recognition results have been returned.



213
214
215
216
217
 
# File 'lib/google/cloud/speech/stream.rb', line 213

def complete?
  synchronize do
    @complete
  end
end

#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,
                       language: "en-US",
                       sample_rate: 16000

# 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

Yields:

  • (callback) —

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



377
378
379
380
381
 
# File 'lib/google/cloud/speech/stream.rb', line 377

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,
                       language: "en-US",
                       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,
                       language: "en-US",
                       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.



289
290
291
292
293
 
# File 'lib/google/cloud/speech/stream.rb', line 289

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,
                       language: "en-US",
                       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
stream.wait_until_complete!

results = stream.results
result = results.first
result.transcript #=> "how old is the Brooklyn Bridge"
result.confidence #=> 0.9826789498329163

Yields:

  • (callback) —

    The block for accessing final results.

Yield Parameters:

  • results (Array<Result>) —

    The final results.



333
334
335
336
337
 
# File 'lib/google/cloud/speech/stream.rb', line 333

def on_result &block
  synchronize do
    @callbacks[:result] << 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,
                       language: "en-US",
                       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.



426
427
428
429
430
 
# File 'lib/google/cloud/speech/stream.rb', line 426

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,
                       language: "en-US",
                       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.



176
177
178
179
180
 
# File 'lib/google/cloud/speech/stream.rb', line 176

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,
                       language: "en-US",
                       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
stream.wait_until_complete!

results = stream.results
result = results.first
result.transcript #=> "how old is the Brooklyn Bridge"
result.confidence #=> 0.9826789498329163

Parameters:

  • bytes (String) —

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



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

def send bytes
  start # lazily call start if the stream wasn't started yet
  # TODO: do not send if stopped?
  synchronize do
    req = V1::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.



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

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.



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

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

#stop ⇒ Object

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



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

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.



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

def stopped?
  synchronize do
    @stopped
  end
end

#wait_until_complete! ⇒ Object

Blocks until all speech recognition results have been returned.

Examples:

require "google/cloud/speech"

speech = Google::Cloud::Speech.new

stream = speech.stream encoding: :raw,
                       language: "en-US",
                       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

stream.wait_until_complete!
stream.complete? #=> true

results = stream.results
results.each do |result|
  puts result.transcript
  puts result.confidence
end


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

def wait_until_complete!
  complete_check = nil
  synchronize { complete_check = @complete }
  while complete_check.nil?
    sleep 1
    synchronize { complete_check = @complete }
  end
end