1 /* 2 * Copyright (C) 2010 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 are 6 * met: 7 * 8 * * Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * * Redistributions in binary form must reproduce the above 11 * copyright notice, this list of conditions and the following disclaimer 12 * in the documentation and/or other materials provided with the 13 * distribution. 14 * * Neither the name of Google Inc. nor the names of its 15 * contributors may be used to endorse or promote products derived from 16 * this software without specific prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31 #ifndef WebSpeechInputListener_h 32 #define WebSpeechInputListener_h 33 34 #include "WebSpeechInputResult.h" 35 36 namespace WebKit { 37 38 class WebString; 39 40 // Provides a WebKit API called by the embedder. 41 // A typical sequence of calls to the listener would be 42 // 1 call to didCompleteRecording 43 // 0 or more calls to setRecognitionResult 44 // 1 call to didCompleteRecognition 45 class WebSpeechInputListener { 46 public: 47 // Informs that audio recording has completed and recognition is underway. This gets invoked 48 // irrespective of whether recording was stopped automatically by the 'endpointer' or if 49 // WebSpeechInputController::stopRecording() was called. 50 // Typically after this call the listener would update the UI to reflect that recognition is 51 // in progress. 52 virtual void didCompleteRecording(int) { WEBKIT_ASSERT_NOT_REACHED(); } 53 54 // Gives results from speech recognition, either partial or the final results. 55 // This method can potentially get called multiple times if there are partial results 56 // available as the user keeps speaking. If the speech could not be recognized properly 57 // or if there was any other errors in the process, this method may never be called. 58 virtual void setRecognitionResult(int, const WebSpeechInputResultArray&) { WEBKIT_ASSERT_NOT_REACHED(); } 59 60 // Informs that speech recognition has completed. This gets invoked irrespective of whether 61 // recognition was succesful or not, whether setRecognitionResult() was invoked or not. The 62 // handler typically frees up any temporary resources allocated and waits for the next speech 63 // recognition request. 64 virtual void didCompleteRecognition(int) { WEBKIT_ASSERT_NOT_REACHED(); } 65 66 protected: 67 ~WebSpeechInputListener() { } 68 }; 69 70 } // namespace WebKit 71 72 #endif // WebSpeechInputListener_h 73