1 /* |
|
2 * Copyright (c) 2003-2006 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: The MNssPlayEventHandler class provides the call back methods to handle |
|
15 * the events during Play operation. |
|
16 * |
|
17 */ |
|
18 |
|
19 |
|
20 |
|
21 #ifndef NSSVASMPLAYEVENTHANDLER_H |
|
22 #define NSSVASMPLAYEVENTHANDLER_H |
|
23 |
|
24 |
|
25 // INCLUDES |
|
26 #include <e32base.h> |
|
27 #include <nssvascoreconstant.h> |
|
28 |
|
29 |
|
30 /** |
|
31 * The MNssPlayEventHandler class provides the call back methods to handle |
|
32 * the events during Play operation. |
|
33 * |
|
34 * @lib NssVASApi.lib |
|
35 * @since 2.0 |
|
36 */ |
|
37 class MNssPlayEventHandler |
|
38 { |
|
39 |
|
40 public: |
|
41 |
|
42 /** |
|
43 * TPlayResult will have all the enums to represent the result values from |
|
44 * HandlePlayError method. |
|
45 * |
|
46 * NOTE: |
|
47 * The HandlePlayError() should handle the undefined error for TPlayResult. |
|
48 */ |
|
49 enum TNssPlayResult |
|
50 { |
|
51 EVasErrorNone, |
|
52 EVasPlayFailed, |
|
53 EVasPlayNoMemory, |
|
54 EVasPlayAccessDeny, |
|
55 EVasPlayUndefinedError10, // for place holder |
|
56 EVasPlayUndefinedError9, |
|
57 EVasPlayUndefinedError8, |
|
58 EVasPlayUndefinedError7, |
|
59 EVasPlayUndefinedError6, |
|
60 EVasPlayUndefinedError5, |
|
61 EVasPlayUndefinedError4, |
|
62 EVasPlayUndefinedError3, |
|
63 EVasPlayUndefinedError2, |
|
64 EVasPlayUndefinedError1 |
|
65 }; |
|
66 |
|
67 /** |
|
68 * The HandlePlayStarted method is a virtual method implemented by the |
|
69 * client and is called when play is started |
|
70 * @since 2.0 |
|
71 * @param aDuration - the duration of the utterance data |
|
72 * @return no return value |
|
73 */ |
|
74 virtual void HandlePlayStarted( TTimeIntervalMicroSeconds32 aDuration ) = 0; |
|
75 |
|
76 /** |
|
77 * The HandlePlayComplete method is a virtual method implemented by the |
|
78 * client and is called when play is completed |
|
79 * @since 2.0 |
|
80 * @param aErrorCode EVasErrorNone if playing was successfull |
|
81 * @return no return value |
|
82 */ |
|
83 virtual void HandlePlayComplete( TNssPlayResult aErrorCode ) = 0; |
|
84 }; |
|
85 |
|
86 |
|
87 |
|
88 #endif // NSSVASMPLAYEVENTHANDLER_H |
|
89 |
|
90 // End of file |
|