1 /* |
1 /* |
2 * Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies). |
2 * Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies). |
3 * All rights reserved. |
3 * All rights reserved. |
4 * This component and the accompanying materials are made available |
4 * This component and the accompanying materials are made available |
5 * under the terms of "Eclipse Public License v1.0" |
5 * under the terms of "Eclipse Public License v1.0" |
6 * which accompanies this distribution, and is available |
6 * which accompanies this distribution, and is available |
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
8 * |
8 * |
9 * Initial Contributors: |
9 * Initial Contributors: |
10 * Nokia Corporation - initial contribution. |
10 * Nokia Corporation - initial contribution. |
11 * |
11 * |
12 * Contributors: |
12 * Contributors: |
13 * |
13 * |
14 * Description: Defines APIs for VoIP ring tone player. |
14 * Description: Defines APIs for VoIP ring tone player. |
15 * |
15 * |
16 */ |
16 */ |
17 |
|
18 |
17 |
19 #ifndef __RINGTONEPLAYER_H |
18 #ifndef __RINGTONEPLAYER_H |
20 #define __RINGTONEPLAYER_H |
19 #define __RINGTONEPLAYER_H |
21 |
|
22 |
20 |
23 // FORWARD DECLARATIONS |
21 // FORWARD DECLARATIONS |
24 class RFile; |
22 class RFile; |
25 class CRingTonePlayer; |
23 class CRingTonePlayer; |
26 class CRingTonePlayerImpl; |
24 class CRingTonePlayerImpl; |
27 |
|
28 |
25 |
29 /** |
26 /** |
30 * MRingToneObserver class |
27 * MRingToneObserver class |
31 * |
28 * |
32 * ?more_complete_description |
29 * ?more_complete_description |
33 * |
30 * |
34 * @lib VoIPAudioIntfc.dll |
31 * @lib VoIPAudioIntfc.dll |
35 * @since S60 v5.0 |
32 * |
36 */ |
33 */ |
37 class MRingToneObserver |
34 class MRingToneObserver |
38 { |
35 { |
39 public: |
36 public: |
40 static const TUint KOpenComplete = 1; |
37 static const TUint KOpenComplete = 1; |
41 static const TUint KPlaybackComplete = 2; |
38 static const TUint KPlaybackComplete = 2; |
42 |
39 |
43 public: |
40 public: |
44 /** |
41 /** |
45 * ?description |
42 * ?description |
48 * @param CRingTonePlayer& - Ring tone player reference |
45 * @param CRingTonePlayer& - Ring tone player reference |
49 * @param TInt - Event type |
46 * @param TInt - Event type |
50 * @param TInt - Status |
47 * @param TInt - Status |
51 * @return void |
48 * @return void |
52 */ |
49 */ |
53 virtual void Event(const CRingTonePlayer& aSrc, |
50 virtual void Event(const CRingTonePlayer& aSrc, TInt aEventType, |
54 TInt aEventType, |
51 TInt aError) = 0; |
55 TInt aError) = 0; |
|
56 }; |
52 }; |
57 |
|
58 |
53 |
59 /** |
54 /** |
60 * CRingTonePlayer class |
55 * CRingTonePlayer class |
61 * |
56 * |
62 * Ring Tone Player class |
57 * Ring Tone Player class |
63 * |
58 * |
64 * @lib VoIPAudioIntfc.dll |
59 * @lib VoIPAudioIntfc.dll |
65 * @since S60 v5.0 |
60 * |
66 */ |
61 */ |
67 class CRingTonePlayer |
62 class CRingTonePlayer |
68 { |
63 { |
69 public: |
64 public: |
70 |
65 |
92 * @since S60 v5.0 |
87 * @since S60 v5.0 |
93 * @param MRingToneObserver& |
88 * @param MRingToneObserver& |
94 * @param TPtr |
89 * @param TPtr |
95 * @return TInt |
90 * @return TInt |
96 */ |
91 */ |
97 IMPORT_C TInt Open(MRingToneObserver& aObserver, |
92 IMPORT_C TInt Open(MRingToneObserver& aObserver, TPtr aFileName); |
98 TPtr aFileName); |
|
99 |
93 |
100 /** |
94 /** |
101 * ?description |
95 * ?description |
102 * |
96 * |
103 * @since S60 v5.0 |
97 * @since S60 v5.0 |
104 * @param MRingToneObserver& |
98 * @param MRingToneObserver& |
105 * @param RFile& |
99 * @param RFile& |
106 * @return TInt |
100 * @return TInt |
107 */ |
101 */ |
108 IMPORT_C TInt Open(MRingToneObserver& aObserver, |
102 IMPORT_C TInt Open(MRingToneObserver& aObserver, RFile& aFileHandle); |
109 RFile& aFileHandle); |
|
110 |
103 |
111 /** |
104 /** |
112 * ?description |
105 * ?description |
113 * |
106 * |
114 * @since S60 v5.0 |
107 * @since S60 v5.0 |
115 * @param MRingToneObserver& |
108 * @param MRingToneObserver& |
116 * @param TPtr8 |
109 * @param TPtr8 |
117 * @param TPtr8 |
110 * @param TPtr8 |
118 * @return TInt |
111 * @return TInt |
119 */ |
112 */ |
120 IMPORT_C TInt Open(MRingToneObserver& aObserver, |
113 IMPORT_C TInt Open(MRingToneObserver& aObserver, TPtr8 aDesTone, |
121 TPtr8 aDesTone, |
114 TPtr8 aMimeType); |
122 TPtr8 aMimeType); |
|
123 |
115 |
124 /** |
116 /** |
125 * ?description |
117 * ?description |
126 * |
118 * |
127 * @since S60 v5.0 |
119 * @since S60 v5.0 |