third_party/WebKit/public/web/WebSpeechRecognizer.h

   1 /*
   2  * Copyright (C) 2012 Google Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  *  * Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  *  * Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef WebSpeechRecognizer_h
  27 #define WebSpeechRecognizer_h
  28
  29 #include "../platform/WebCommon.h"
  30 #include "WebSpeechRecognitionHandle.h"
  31
  32 namespace blink {
  33
  34 class WebSpeechRecognitionParams;
  35 class WebSpeechRecognizerClient;
  36
  37 // Interface for speech recognition, to be implemented by the embedder.
  38 class WebSpeechRecognizer {
  39 public:
  40     // Start speech recognition for the specified handle using the specified parameters. Notifications on progress, results, and errors will be sent via the client.
  41     virtual void start(const WebSpeechRecognitionHandle&, const WebSpeechRecognitionParams&, WebSpeechRecognizerClient*) { BLINK_ASSERT_NOT_REACHED(); }
  42
  43     // Stop speech recognition for the specified handle, returning any results for the audio recorded so far. Notifications and errors are sent via the client.
  44     virtual void stop(const WebSpeechRecognitionHandle&, WebSpeechRecognizerClient*) { BLINK_ASSERT_NOT_REACHED(); }
  45
  46     // Abort speech recognition for the specified handle, discarding any recorded audio. Notifications and errors are sent via the client.
  47     virtual void abort(const WebSpeechRecognitionHandle&, WebSpeechRecognizerClient*) { BLINK_ASSERT_NOT_REACHED(); }
  48
  49 protected:
  50     virtual ~WebSpeechRecognizer() { }
  51 };
  52
  53 } // namespace blink
  54
  55 #endif // WebSpeechRecognizer_h