e779c3a79d31abe01db000302307dfe358d15815
[WebKit-https.git] / WebKit / chromium / public / WebSpeechInputListener.h
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 namespace WebKit {
35
36 class WebString;
37
38 // Provides a WebKit API called by the embedder.
39 // A typical sequence of calls to the listener would be
40 //   1 call to didCompleteRecording
41 //   0 or more calls to setRecognitionResult
42 //   1 call to didCompleteRecognition
43 class WebSpeechInputListener {
44 public:
45     // Informs that audio recording has completed and recognition is underway. This gets invoked
46     // irrespective of whether recording was stopped automatically by the 'endpointer' or if
47     // WebSpeechInputController::stopRecording() was called.
48     // Typically after this call the listener would update the UI to reflect that recognition is
49     // in progress.
50     virtual void didCompleteRecording(int) = 0;
51     // FIXME: Remove this once chromium has picked up this change.
52     virtual void didCompleteRecording()
53     {
54         didCompleteRecording(1);
55     }
56
57     // Gives results from speech recognition, either partial or the final results.
58     // This method can potentially get called multiple times if there are partial results
59     // available as the user keeps speaking. If the speech could not be recognized properly
60     // or if there was any other errors in the process, this method may never be called.
61     virtual void setRecognitionResult(int, const WebString&) = 0;
62     // FIXME: Remove this once chromium has picked up this change.
63     virtual void setRecognitionResult(const WebString& result)
64     {
65         setRecognitionResult(1, result);
66     }
67
68     // Informs that speech recognition has completed. This gets invoked irrespective of whether
69     // recognition was succesful or not, whether setRecognitionResult() was invoked or not. The
70     // handler typically frees up any temporary resources allocated and waits for the next speech
71     // recognition request.
72     virtual void didCompleteRecognition(int) = 0;
73     // FIXME: Remove this once chromium has picked up this change.
74     virtual void didCompleteRecognition()
75     {
76         didCompleteRecognition(1);
77     }
78
79 protected:
80     ~WebSpeechInputListener() { }
81 };
82
83 } // namespace WebKit
84
85 #endif // WebSpeechInputListener_h