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 SpeechInputListener_h
32#define SpeechInputListener_h
33
34#if ENABLE(INPUT_SPEECH)
35
36#include "SpeechInputResult.h"
37#include <wtf/Forward.h>
38
39namespace WebCore {
40
41// Interface to be implemented by the element which invokes SpeechInput.
42class SpeechInputListener {
43public:
44    // Informs that audio recording has completed and recognition is underway.
45    virtual void didCompleteRecording(int requestId) = 0;
46
47    // Informs that speech recognition has completed. This gets invoked irrespective of whether
48    // recognition was succesful or not, whether setRecognitionResult() was invoked or not. The
49    // handler typically frees up any temporary resources allocated and waits for the next speech
50    // recognition request.
51    virtual void didCompleteRecognition(int requestId) = 0;
52
53    // Gives results from speech recognition, either partial or the final results.
54    // This method can potentially get called multiple times if there are partial results
55    // available as the user keeps speaking. If the speech could not be recognized properly
56    // or if there was any other errors in the process, this method may never be called.
57    virtual void setRecognitionResult(int requestId, const SpeechInputResultArray&) = 0;
58
59protected:
60    virtual ~SpeechInputListener() { }
61};
62
63} // namespace WebCore
64
65#endif // ENABLE(INPUT_SPEECH)
66
67#endif // SpeechInputListener_h
68