File: WebSpeechRecognizerClient.h

package info (click to toggle)
qtwebengine-opensource-src 5.11.3%2Bdfsg-2%2Bdeb10u1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 1,551,988 kB
  • sloc: cpp: 10,064,061; ansic: 3,832,841; asm: 590,489; python: 455,759; xml: 261,729; sh: 90,157; objc: 77,089; perl: 71,296; makefile: 27,041; cs: 23,492; yacc: 14,360; tcl: 12,756; php: 4,714; lex: 4,028; pascal: 3,741; ml: 3,543; ruby: 1,497; lisp: 1,490; awk: 183; csh: 117; sed: 54
file content (105 lines) | stat: -rw-r--r-- 4,350 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
/*
 * Copyright (C) 2012 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef WebSpeechRecognizerClient_h
#define WebSpeechRecognizerClient_h

#include "public/platform/WebVector.h"

namespace blink {

class WebSpeechRecognitionResult;
class WebSpeechRecognitionHandle;
class WebString;

// A client for reporting progress on speech recognition for a specific handle.
class WebSpeechRecognizerClient {
 public:
  enum ErrorCode {
    kOtherError = 0,
    kNoSpeechError = 1,
    kAbortedError = 2,
    kAudioCaptureError = 3,
    kNetworkError = 4,
    kNotAllowedError = 5,
    kServiceNotAllowedError = 6,
    kBadGrammarError = 7,
    kLanguageNotSupportedError = 8
  };

  // These methods correspond to the events described in the spec:
  // http://speech-javascript-api-spec.googlecode.com/git/speechapi.html#speechreco-events

  // To be called when the embedder has started to capture audio.
  virtual void DidStartAudio(const WebSpeechRecognitionHandle&) = 0;

  // To be called when some sound, possibly speech, has been detected.
  // This is expected to be called after didStartAudio.
  virtual void DidStartSound(const WebSpeechRecognitionHandle&) = 0;

  // To be called when sound is no longer detected.
  // This is expected to be called after didEndSpeech.
  virtual void DidEndSound(const WebSpeechRecognitionHandle&) = 0;

  // To be called when audio capture has stopped.
  // This is expected to be called after didEndSound.
  virtual void DidEndAudio(const WebSpeechRecognitionHandle&) = 0;

  // To be called when the speech recognizer provides new results.
  // - newFinalResults contains zero or more final results that are new since
  // the last time the function was called.
  // - currentInterimResults contains zero or more inteirm results that
  // replace the interim results that were reported the last time this
  // function was called.
  virtual void DidReceiveResults(
      const WebSpeechRecognitionHandle&,
      const WebVector<WebSpeechRecognitionResult>& new_final_results,
      const WebVector<WebSpeechRecognitionResult>& current_interim_results) = 0;

  // To be called when the speech recognizer returns a final result with no
  // recognizion hypothesis.
  virtual void DidReceiveNoMatch(const WebSpeechRecognitionHandle&,
                                 const WebSpeechRecognitionResult&) = 0;

  // To be called when a speech recognition error occurs.
  virtual void DidReceiveError(const WebSpeechRecognitionHandle&,
                               const WebString& message,
                               ErrorCode) = 0;

  // To be called when the recognizer has begun to listen to the audio with
  // the intention of recognizing.
  virtual void DidStart(const WebSpeechRecognitionHandle&) = 0;

  // To be called when the recognition session has ended. This must always be
  // called, no matter the reason for the end.
  virtual void DidEnd(const WebSpeechRecognitionHandle&) = 0;

 protected:
  virtual ~WebSpeechRecognizerClient() = default;
};

}  // namespace blink

#endif  // WebSpeechRecognizerClient_h