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 |
17 |
18 #ifndef __RINGTONEPLAYER_H |
18 #ifndef RINGTONEPLAYER_H |
19 #define __RINGTONEPLAYER_H |
19 #define RINGTONEPLAYER_H |
20 |
20 |
21 // FORWARD DECLARATIONS |
21 // FORWARD DECLARATIONS |
22 class RFile; |
22 class RFile; |
23 class CRingTonePlayer; |
23 class CRingTonePlayer; |
24 class CRingTonePlayerImpl; |
24 class CRingTonePlayerImpl; |
25 |
25 |
26 /** |
26 /** |
27 * MRingToneObserver class |
27 * MRingToneObserver class |
28 * |
|
29 * ?more_complete_description |
|
30 * |
28 * |
31 * @lib VoIPAudioIntfc.dll |
29 * @lib VoIPAudioIntfc.dll |
32 * |
30 * |
33 */ |
31 */ |
34 class MRingToneObserver |
32 class MRingToneObserver |
37 static const TUint KOpenComplete = 1; |
35 static const TUint KOpenComplete = 1; |
38 static const TUint KPlaybackComplete = 2; |
36 static const TUint KPlaybackComplete = 2; |
39 |
37 |
40 public: |
38 public: |
41 /** |
39 /** |
42 * ?description |
40 * Event |
43 * |
|
44 * @since S60 v5.0 |
|
45 * @param CRingTonePlayer& - Ring tone player reference |
41 * @param CRingTonePlayer& - Ring tone player reference |
46 * @param TInt - Event type |
42 * @param TInt - Event type |
47 * @param TInt - Status |
43 * @param TInt - Status |
48 * @return void |
44 * @return void |
49 */ |
45 */ |
63 { |
59 { |
64 public: |
60 public: |
65 |
61 |
66 /** |
62 /** |
67 * Destructor |
63 * Destructor |
68 * |
|
69 * @since S60 v5.0 |
|
70 * @param none |
64 * @param none |
71 * @return none |
65 * @return none |
72 */ |
66 */ |
73 IMPORT_C virtual ~CRingTonePlayer(); |
67 IMPORT_C virtual ~CRingTonePlayer(); |
74 |
68 |
75 /** |
69 /** |
76 * ?description |
70 * Open from default profile |
77 * |
|
78 * @since S60 v5.0 |
|
79 * @param MRingToneObserver& |
71 * @param MRingToneObserver& |
80 * @return TInt |
72 * @return TInt |
81 */ |
73 */ |
82 IMPORT_C TInt Open(MRingToneObserver& aObserver); |
74 IMPORT_C TInt Open(MRingToneObserver& aObserver); |
83 |
75 |
84 /** |
76 /** |
85 * ?description |
77 * Open file |
86 * |
|
87 * @since S60 v5.0 |
|
88 * @param MRingToneObserver& |
78 * @param MRingToneObserver& |
89 * @param TPtr |
79 * @param TPtr |
90 * @return TInt |
80 * @return TInt |
91 */ |
81 */ |
92 IMPORT_C TInt Open(MRingToneObserver& aObserver, TPtr aFileName); |
82 IMPORT_C TInt Open(MRingToneObserver& aObserver, TPtr aFileName); |
93 |
83 |
94 /** |
84 /** |
95 * ?description |
85 * Open from file handle |
96 * |
|
97 * @since S60 v5.0 |
|
98 * @param MRingToneObserver& |
86 * @param MRingToneObserver& |
99 * @param RFile& |
87 * @param RFile& |
100 * @return TInt |
88 * @return TInt |
101 */ |
89 */ |
102 IMPORT_C TInt Open(MRingToneObserver& aObserver, RFile& aFileHandle); |
90 IMPORT_C TInt Open(MRingToneObserver& aObserver, RFile& aFileHandle); |
103 |
91 |
104 /** |
92 /** |
105 * ?description |
93 * Open from descriptor |
106 * |
|
107 * @since S60 v5.0 |
|
108 * @param MRingToneObserver& |
94 * @param MRingToneObserver& |
109 * @param TPtr8 |
95 * @param TPtr8 |
110 * @param TPtr8 |
96 * @param TPtr8 |
111 * @return TInt |
97 * @return TInt |
112 */ |
98 */ |
113 IMPORT_C TInt Open(MRingToneObserver& aObserver, TPtr8 aDesTone, |
99 IMPORT_C TInt Open(MRingToneObserver& aObserver, TPtr8 aDesTone, |
114 TPtr8 aMimeType); |
100 TPtr8 aMimeType); |
115 |
101 |
116 /** |
102 /** |
117 * ?description |
103 * Play |
118 * |
|
119 * @since S60 v5.0 |
|
120 * @param none |
104 * @param none |
121 * @return TInt |
105 * @return TInt |
122 */ |
106 */ |
123 IMPORT_C TInt Play(); |
107 IMPORT_C TInt Play(); |
124 |
108 |
125 /** |
109 /** |
126 * ?description |
110 * Pause |
127 * |
|
128 * @since S60 v5.0 |
|
129 * @param none |
111 * @param none |
130 * @return TInt |
112 * @return TInt |
131 */ |
113 */ |
132 IMPORT_C TInt Pause(); |
114 IMPORT_C TInt Pause(); |
133 |
115 |
134 /** |
116 /** |
135 * ?description |
117 * Resume |
136 * |
|
137 * @since S60 v5.0 |
|
138 * @param none |
118 * @param none |
139 * @return TInt |
119 * @return TInt |
140 */ |
120 */ |
141 IMPORT_C TInt Resume(); |
121 IMPORT_C TInt Resume(); |
142 |
122 |
143 /** |
123 /** |
144 * ?description |
124 * Stop |
145 * |
|
146 * @since S60 v5.0 |
|
147 * @param none |
125 * @param none |
148 * @return TInt |
126 * @return TInt |
149 */ |
127 */ |
150 IMPORT_C TInt Stop(); |
128 IMPORT_C TInt Stop(); |
151 |
129 |
152 /** |
130 /** |
153 * ?description |
131 * Close |
154 * |
|
155 * @since S60 v5.0 |
|
156 * @param none |
132 * @param none |
157 * @return TInt |
133 * @return TInt |
158 */ |
134 */ |
159 IMPORT_C void Close(); |
135 IMPORT_C void Close(); |
160 |
136 |
161 protected: |
137 protected: |
162 |
138 |
163 /** |
139 /** |
164 * Constructor |
140 * Constructor |
165 * |
|
166 * @since S60 v5.0 |
|
167 * @param none |
141 * @param none |
168 * @return none |
142 * @return none |
169 */ |
143 */ |
170 CRingTonePlayer(); |
144 CRingTonePlayer(); |
171 |
145 |
172 /** |
146 /** |
173 * Symbian constructor |
147 * Symbian constructor |
174 * |
|
175 * @since S60 v5.0 |
|
176 * @param none |
148 * @param none |
177 * @return void |
149 * @return void |
178 */ |
150 */ |
179 void ConstructL(CRingTonePlayerImpl* aRingTonePlayerImpl); |
151 void ConstructL(CRingTonePlayerImpl* aRingTonePlayerImpl); |
180 |
152 |
181 private: |
153 private: |
182 |
154 |
183 CRingTonePlayerImpl* iRingTonePlayerImpl; |
155 CRingTonePlayerImpl* iRingTonePlayerImpl; |
184 |
|
185 }; |
156 }; |
186 |
157 |
187 #endif //__RINGTONEPLAYER_H |
158 #endif //RINGTONEPLAYER_H |
188 |
159 |
189 // End of file |
160 // End of file |