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 WebSpeechInputController_h 32 #define WebSpeechInputController_h 33 34 #include "WebCommon.h" 35 36 namespace WebKit { 37 38 struct WebRect; 39 class WebSecurityOrigin; 40 class WebString; 41 42 // Provides an embedder API called by WebKit. 43 class WebSpeechInputController { 44 public: 45 // Starts speech recognition. Speech will get recorded until the endpointer detects silence, 46 // runs to the limit or stopRecording is called. Progress indications and the recognized 47 // text are returned via the listener interface. startRecognition(int requestId,const WebRect & elementRect,const WebString & language,const WebString & grammar,const WebSecurityOrigin & origin)48 virtual bool startRecognition(int requestId, const WebRect& elementRect, const WebString& language, const WebString& grammar, const WebSecurityOrigin& origin) 49 { 50 WEBKIT_ASSERT_NOT_REACHED(); 51 return false; 52 } 53 54 // Cancels an ongoing recognition and discards any audio recorded so far. No partial 55 // recognition results are returned to the listener. cancelRecognition(int)56 virtual void cancelRecognition(int) { WEBKIT_ASSERT_NOT_REACHED(); } 57 58 // Stops audio recording and performs recognition with the audio recorded until now 59 // (does not discard audio). This is an optional call and is typically invoked if the user 60 // wants to stop recording audio as soon as they finished speaking. Otherwise, the speech 61 // recording 'endpointer' should detect silence in the input and stop recording automatically. 62 // Call startRecognition() to record audio and recognize speech again. stopRecording(int)63 virtual void stopRecording(int) { WEBKIT_ASSERT_NOT_REACHED(); } 64 65 protected: ~WebSpeechInputController()66 virtual ~WebSpeechInputController() { } 67 }; 68 69 } // namespace WebKit 70 71 #endif // WebSpeechInputController_h 72