29 * Used to receive errors, notifications, statuses etc |
29 * Used to receive errors, notifications, statuses etc |
30 * |
30 * |
31 * @since S60 3.2 |
31 * @since S60 3.2 |
32 */ |
32 */ |
33 class MCCPDTMFProvider |
33 class MCCPDTMFProvider |
34 { |
34 { |
35 protected: |
35 protected: |
36 /** |
36 /** |
37 * Protected destructor. Object cannot be deleted from plug-in client (CCE). |
37 * Protected destructor. Object cannot be deleted from plug-in client (CCE). |
38 * @since S60 3.2 |
38 * @since S60 3.2 |
39 */ |
39 */ |
40 virtual inline ~MCCPDTMFProvider() {}; |
40 virtual inline ~MCCPDTMFProvider() {}; |
41 |
41 |
42 public: |
42 public: |
43 /** |
43 /** |
44 * Cancels asynchronous DTMF string sending. |
44 * Cancels asynchronous DTMF string sending. |
45 * @param none |
45 * @param none |
46 * @return KErrNone request was started successfully |
46 * @return KErrNone request was started successfully |
47 * @return KErrNotFound nothing found to cancel. |
47 * @return KErrNotFound nothing found to cancel. |
48 * @since Series 60 3.2 |
48 * @since Series 60 3.2 |
49 */ |
49 */ |
50 virtual TInt CancelDtmfStringSending() = 0; |
50 virtual TInt CancelDtmfStringSending() = 0; |
51 |
51 |
52 /** |
52 /** |
53 * Starts the transmission of a single DTMF tone across a connected and active call. |
53 * Starts the transmission of a single DTMF tone across a connected and active call. |
54 * @since S60 3.2 |
54 * @since S60 3.2 |
55 * @param aTone tone to be played. |
55 * @param aTone tone to be played. |
56 * @return KErrNone request was started successfully |
56 * @return KErrNone request was started successfully |
57 * @return KErrArgument if the specified tone contains illegal dtmf character |
57 * @return KErrArgument if the specified tone contains illegal dtmf character |
58 * @return in case of an error system wide error code |
58 * @return in case of an error system wide error code |
59 */ |
59 */ |
60 virtual TInt StartDtmfTone( const TChar aTone ) = 0; |
60 virtual TInt StartDtmfTone( const TChar aTone ) = 0; |
61 |
61 |
62 /** |
62 /** |
63 * Stops playing current DTMF tone. |
63 * Stops playing current DTMF tone. |
64 * @since S60 3.2 |
64 * @since S60 3.2 |
65 * @param none |
65 * @param none |
66 * @return KErrNone request was started successfully |
66 * @return KErrNone request was started successfully |
67 * @return KErrNotReady not ready to perform the requested action. |
67 * @return KErrNotReady not ready to perform the requested action. |
68 */ |
68 */ |
69 virtual TInt StopDtmfTone() = 0; |
69 virtual TInt StopDtmfTone() = 0; |
70 |
70 |
71 /** |
71 /** |
72 * Plays DTMF string. |
72 * Plays DTMF string. |
73 * @since S60 3.2 |
73 * @since S60 3.2 |
74 * @param aString String to be played. |
74 * @param aString String to be played. |
75 * @return KErrNone request was started successfully |
75 * @return KErrNone request was started successfully |
76 * @return KErrArgument if the specified string contains illegal dtmf characters |
76 * @return KErrArgument if the specified string contains illegal dtmf characters |
77 */ |
77 */ |
78 virtual TInt SendDtmfToneString( const TDesC& aString ) = 0; |
78 virtual TInt SendDtmfToneString( const TDesC& aString ) = 0; |
79 |
79 |
80 /** |
80 /** |
81 * Continue or cancel sending DTMF string which was stopped with 'w'-character |
81 * Continue or cancel sending DTMF string which was stopped with 'w'-character |
82 * in string. |
82 * in string. |
83 * @since S60 3.2 |
83 * @since S60 3.2 |
84 * @param aContinue ETrue if sending of the DTMF string should continue, |
84 * @param aContinue ETrue if sending of the DTMF string should continue, |
85 * EFalse if the rest of the DTMF string is to be discarded. |
85 * EFalse if the rest of the DTMF string is to be discarded. |
86 * @return KErrNone request was started successfully |
86 * @return KErrNone request was started successfully |
87 * @return KErrNotFound no send existed which to continue |
87 * @return KErrNotFound no send existed which to continue |
88 */ |
88 */ |
89 virtual TInt ContinueDtmfStringSending( const TBool aContinue ) = 0; |
89 virtual TInt ContinueDtmfStringSending( const TBool aContinue ) = 0; |
90 |
90 |
91 /** |
91 /** |
92 * Add an observer for DTMF related events. |
92 * Add an observer for DTMF related events. |
93 * Currently CCE will set only one observer. |
93 * Currently CCE will set only one observer. |
94 * @since S60 v3.2 |
94 * @since S60 v3.2 |
95 * @param aObserver Observer to add. |
95 * @param aObserver Observer to add. |