2 * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
20 #ifndef __TIZEN_MEDIA_TONE_PLAYER_H__
21 #define __TIZEN_MEDIA_TONE_PLAYER_H__
24 #include <sound_manager.h>
31 #define TONE_PLAYER_ERROR_CLASS TIZEN_ERROR_MULTIMEDIA_CLASS | 0x60
35 * @brief This file contains the tone player API
39 * @addtogroup CAPI_MEDIA_TONE_PLAYER_MODULE
44 * @brief Enumeration of error codes for wav player.
45 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
49 TONE_PLAYER_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
50 TONE_PLAYER_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */
51 TONE_PLAYER_ERROR_INVALID_OPERATION = TIZEN_ERROR_INVALID_OPERATION, /**< Invalid operation */
52 TONE_PLAYER_ERROR_NOT_SUPPORTED_TYPE = TIZEN_ERROR_TONE_PLAYER | 0x01 /**< Not supported (Since 3.0) */
53 } tone_player_error_e;
56 * @brief Enumeration of tone.
57 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
61 TONE_TYPE_DEFAULT = 0, /**< The default tone */
62 TONE_TYPE_DTMF_0 = 0, /**< Predefined DTMF 0 */
63 TONE_TYPE_DTMF_1, /**< Predefined DTMF 1 */
64 TONE_TYPE_DTMF_2, /**< Predefined DTMF 2 */
65 TONE_TYPE_DTMF_3, /**< Predefined DTMF 3 */
66 TONE_TYPE_DTMF_4, /**< Predefined DTMF 4 */
67 TONE_TYPE_DTMF_5, /**< Predefined DTMF 5 */
68 TONE_TYPE_DTMF_6, /**< Predefined DTMF 6 */
69 TONE_TYPE_DTMF_7, /**< Predefined DTMF 7 */
70 TONE_TYPE_DTMF_8, /**< Predefined DTMF 8 */
71 TONE_TYPE_DTMF_9, /**< Predefined DTMF 9 */
72 TONE_TYPE_DTMF_S, /**< Predefined DTMF Star - Asterisk (*) */
73 TONE_TYPE_DTMF_P, /**< Predefined DTMF sharP (#) */
74 TONE_TYPE_DTMF_A, /**< Predefined DTMF A (A) */
75 TONE_TYPE_DTMF_B, /**< Predefined DTMF B (B) */
76 TONE_TYPE_DTMF_C, /**< Predefined DTMF C (C) */
77 TONE_TYPE_DTMF_D, /**< Predefined DTMF D (D) */
78 TONE_TYPE_SUP_DIAL, /**< Call supervisory tone, Dial tone: CEPT: 425Hz, continuous */
79 TONE_TYPE_ANSI_DIAL, /**< Call supervisory tone, Dial tone: ANSI (IS-95): 350Hz+440Hz, continuous */
80 TONE_TYPE_JAPAN_DIAL, /**< Call supervisory tone, Dial tone: JAPAN: 400Hz, continuous*/
81 TONE_TYPE_SUP_BUSY, /**< Call supervisory tone, Busy: CEPT: 425Hz, 500ms ON, 500ms OFF... */
82 TONE_TYPE_ANSI_BUSY, /**< Call supervisory tone, Busy: ANSI (IS-95): 480Hz+620Hz, 500ms ON, 500ms OFF... */
83 TONE_TYPE_JAPAN_BUSY, /**< Call supervisory tone, Busy: JAPAN: 400Hz, 500ms ON, 500ms OFF...*/
84 TONE_TYPE_SUP_CONGESTION, /**< Call supervisory tone, Congestion: CEPT, JAPAN: 425Hz, 200ms ON, 200ms OFF */
85 TONE_TYPE_ANSI_CONGESTION, /**< Call supervisory tone, Congestion: ANSI (IS-95): 480Hz+620Hz, 250ms ON, 250ms OFF... */
86 TONE_TYPE_SUP_RADIO_ACK, /**< Call supervisory tone, Radio path acknowledgment : CEPT, ANSI: 425Hz, 200ms ON */
87 TONE_TYPE_JAPAN_RADIO_ACK, /**< Call supervisory tone, Radio path acknowledgment : JAPAN: 400Hz, 1s ON, 2s OFF...*/
88 TONE_TYPE_SUP_RADIO_NOTAVAIL, /**< Call supervisory tone, Radio path not available: 425Hz, 200ms ON, 200 OFF 3 bursts */
89 TONE_TYPE_SUP_ERROR, /**< Call supervisory tone, Error/Special info: 950Hz+1400Hz+1800Hz, 330ms ON, 1s OFF... */
90 TONE_TYPE_SUP_CALL_WAITING, /**< Call supervisory tone, Call Waiting: CEPT, JAPAN: 425Hz, 200ms ON, 600ms OFF, 200ms ON, 3s OFF... */
91 TONE_TYPE_ANSI_CALL_WAITING, /**< Call supervisory tone, Call Waiting: ANSI (IS-95): 440 Hz, 300 ms ON, 9.7 s OFF, (100 ms ON, 100 ms OFF, 100 ms ON, 9.7s OFF ...) */
92 TONE_TYPE_SUP_RINGTONE, /**< Call supervisory tone, Ring Tone: CEPT, JAPAN: 425Hz, 1s ON, 4s OFF... */
93 TONE_TYPE_ANSI_RINGTONE, /**< Call supervisory tone, Ring Tone: ANSI (IS-95): 440Hz + 480Hz, 2s ON, 4s OFF... */
94 TONE_TYPE_PROP_BEEP, /**< General beep: 400Hz+1200Hz, 35ms ON */
95 TONE_TYPE_PROP_ACK, /**< Proprietary tone, positive acknowledgment: 1200Hz, 100ms ON, 100ms OFF 2 bursts */
96 TONE_TYPE_PROP_NACK, /**< Proprietary tone, negative acknowledgment: 300Hz+400Hz+500Hz, 400ms ON */
97 TONE_TYPE_PROP_PROMPT, /**< Proprietary tone, prompt tone: 400Hz+1200Hz, 200ms ON */
98 TONE_TYPE_PROP_BEEP2, /**< Proprietary tone, general double beep: twice 400Hz+1200Hz, 35ms ON, 200ms OFF, 35ms ON */
99 TONE_TYPE_SUP_INTERCEPT, /**< Call supervisory tone (IS-95), intercept tone: alternating 440 Hz and 620 Hz tones, each on for 250 ms */
100 TONE_TYPE_SUP_INTERCEPT_ABBREV, /**< Call supervisory tone (IS-95), abbreviated intercept: intercept tone limited to 4 seconds */
101 TONE_TYPE_SUP_CONGESTION_ABBREV, /**< Call supervisory tone (IS-95), abbreviated congestion: congestion tone limited to 4 seconds */
102 TONE_TYPE_SUP_CONFIRM, /**< Call supervisory tone (IS-95), confirm tone: a 350 Hz tone added to a 440 Hz tone repeated 3 times in a 100 ms on, 100 ms off cycle */
103 TONE_TYPE_SUP_PIP, /**< Call supervisory tone (IS-95), pip tone: four bursts of 480 Hz tone (0.1 s on, 0.1 s off). */
104 TONE_TYPE_CDMA_DIAL_TONE_LITE, /**< 425Hz continuous */
105 TONE_TYPE_CDMA_NETWORK_USA_RINGBACK, /**< CDMA USA Ringback: 440Hz+480Hz 2s ON, 4000 OFF ...*/
106 TONE_TYPE_CDMA_INTERCEPT, /**< CDMA Intercept tone: 440Hz 250ms ON, 620Hz 250ms ON ...*/
107 TONE_TYPE_CDMA_ABBR_INTERCEPT, /**< CDMA Abbr Intercept tone: 440Hz 250ms ON, 620Hz 250ms ON */
108 TONE_TYPE_CDMA_REORDER, /**< CDMA Reorder tone: 480Hz+620Hz 250ms ON, 250ms OFF... */
109 TONE_TYPE_CDMA_ABBR_REORDER, /**< CDMA Abbr Reorder tone: 480Hz+620Hz 250ms ON, 250ms OFF repeated for 8 times */
110 TONE_TYPE_CDMA_NETWORK_BUSY, /**< CDMA Network Busy tone: 480Hz+620Hz 500ms ON, 500ms OFF continuous */
111 TONE_TYPE_CDMA_CONFIRM, /**< CDMA Confirm tone: 350Hz+440Hz 100ms ON, 100ms OFF repeated for 3 times */
112 TONE_TYPE_CDMA_ANSWER, /**< CDMA answer tone: silent tone - definition Frequency 0, 0ms ON, 0ms OFF */
113 TONE_TYPE_CDMA_NETWORK_CALLWAITING, /**< CDMA Network Callwaiting tone: 440Hz 300ms ON */
114 TONE_TYPE_CDMA_PIP, /**< CDMA PIP tone: 480Hz 100ms ON, 100ms OFF repeated for 4 times */
115 TONE_TYPE_CDMA_CALL_SIGNAL_ISDN_NORMAL, /**< ISDN Call Signal Normal tone: {2091Hz 32ms ON, 2556 64ms ON} 20 times, 2091 32ms ON, 2556 48ms ON, 4s OFF */
116 TONE_TYPE_CDMA_CALL_SIGNAL_ISDN_INTERGROUP, /**< ISDN Call Signal Intergroup tone: {2091Hz 32ms ON, 2556 64ms ON} 8 times, 2091Hz 32ms ON, 400ms OFF, {2091Hz 32ms ON, 2556Hz 64ms ON} 8times, 2091Hz 32ms ON, 4s OFF.*/
117 TONE_TYPE_CDMA_CALL_SIGNAL_ISDN_SP_PRI, /**< ISDN Call Signal SP PRI tone:{2091Hz 32ms ON, 2556 64ms ON} 4 times 2091Hz 16ms ON, 200ms OFF, {2091Hz 32ms ON, 2556Hz 64ms ON} 4 times, 2091Hz 16ms ON, 200ms OFF */
118 TONE_TYPE_CDMA_CALL_SIGNAL_ISDN_PAT3, /**< SDN Call sign PAT3 tone: silent tone */
119 TONE_TYPE_CDMA_CALL_SIGNAL_ISDN_PING_RING, /**< ISDN Ping Ring tone: {2091Hz 32ms ON, 2556Hz 64ms ON} 5 times 2091Hz 20ms ON */
120 TONE_TYPE_CDMA_CALL_SIGNAL_ISDN_PAT5, /**< ISDN Pat5 tone: silent tone */
121 TONE_TYPE_CDMA_CALL_SIGNAL_ISDN_PAT6, /**< ISDN Pat6 tone: silent tone */
122 TONE_TYPE_CDMA_CALL_SIGNAL_ISDN_PAT7, /**< ISDN Pat7 tone: silent tone */
123 TONE_TYPE_CDMA_HIGH_L, /**< TONE_CDMA_HIGH_L tone: {3700Hz 25ms, 4000Hz 25ms} 40 times 4000ms OFF, Repeat .... */
124 TONE_TYPE_CDMA_MED_L, /**< TONE_CDMA_MED_L tone: {2600Hz 25ms, 2900Hz 25ms} 40 times 4000ms OFF, Repeat .... */
125 TONE_TYPE_CDMA_LOW_L, /**< TONE_CDMA_LOW_L tone: {1300Hz 25ms, 1450Hz 25ms} 40 times, 4000ms OFF, Repeat .... */
126 TONE_TYPE_CDMA_HIGH_SS, /**< CDMA HIGH SS tone: {3700Hz 25ms, 4000Hz 25ms} repeat 16 times, 400ms OFF, repeat .... */
127 TONE_TYPE_CDMA_MED_SS, /**< CDMA MED SS tone: {2600Hz 25ms, 2900Hz 25ms} repeat 16 times, 400ms OFF, repeat .... */
128 TONE_TYPE_CDMA_LOW_SS, /**< CDMA LOW SS tone: {1300z 25ms, 1450Hz 25ms} repeat 16 times, 400ms OFF, repeat .... */
129 TONE_TYPE_CDMA_HIGH_SSL, /**< CDMA HIGH SSL tone: {3700Hz 25ms, 4000Hz 25ms} 8 times, 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} repeat 8 times, 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} repeat 16 times, 4000ms OFF, repeat ... */
130 TONE_TYPE_CDMA_MED_SSL, /**< CDMA MED SSL tone: {2600Hz 25ms, 2900Hz 25ms} 8 times, 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} repeat 8 times, 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} repeat 16 times, 4000ms OFF, repeat ... */
131 TONE_TYPE_CDMA_LOW_SSL, /**< CDMA LOW SSL tone: {1300Hz 25ms, 1450Hz 25ms} 8 times, 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} repeat 8 times, 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} repeat 16 times, 4000ms OFF, repeat ... */
132 TONE_TYPE_CDMA_HIGH_SS_2, /**< CDMA HIGH SS2 tone: {3700Hz 25ms, 4000Hz 25ms} 20 times, 1000ms OFF, {3700Hz 25ms, 4000Hz 25ms} 20 times, 3000ms OFF, repeat .... */
133 TONE_TYPE_CDMA_MED_SS_2, /**< CDMA MED SS2 tone: {2600Hz 25ms, 2900Hz 25ms} 20 times, 1000ms OFF, {2600Hz 25ms, 2900Hz 25ms} 20 times, 3000ms OFF, repeat .... */
134 TONE_TYPE_CDMA_LOW_SS_2, /**< CDMA LOW SS2 tone: {1300Hz 25ms, 1450Hz 25ms} 20 times, 1000ms OFF, {1300Hz 25ms, 1450Hz 25ms} 20 times, 3000ms OFF, repeat .... */
135 TONE_TYPE_CDMA_HIGH_SLS, /**< CDMA HIGH SLS tone: {3700Hz 25ms, 4000Hz 25ms} 10 times, 500ms OFF, {3700Hz 25ms, 4000Hz 25ms} 20 times, 500ms OFF, {3700Hz 25ms, 4000Hz 25ms} 10 times, 3000ms OFF, REPEAT */
136 TONE_TYPE_CDMA_MED_SLS, /**< CDMA MED SLS tone: {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 20 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 3000ms OFF, REPEAT */
137 TONE_TYPE_CDMA_LOW_SLS, /**< CDMA LOW SLS tone: {1300Hz 25ms, 1450Hz 25ms} 10 times, 500ms OFF, {1300Hz 25ms, 1450Hz 25ms} 20 times, 500ms OFF, {1300Hz 25ms, 1450Hz 25ms} 10 times, 3000ms OFF, REPEAT */
138 TONE_TYPE_CDMA_HIGH_S_X4, /**< CDMA HIGH S X4 tone: {3700Hz 25ms, 4000Hz 25ms} 10 times, 500ms OFF, {3700Hz 25ms, 4000Hz 25ms} 10 times, 500ms OFF, {3700Hz 25ms, 4000Hz 25ms} 10 times, 500ms OFF, {3700Hz 25ms, 4000Hz 25ms} 10 times, 2500ms OFF, REPEAT.... */
139 TONE_TYPE_CDMA_MED_S_X4, /**< CDMA MED S X4 tone: {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 2500ms OFF, REPEAT.... */
140 TONE_TYPE_CDMA_LOW_S_X4, /**< CDMA LOW S X4 tone: {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 500ms OFF, {2600Hz 25ms, 2900Hz 25ms} 10 times, 2500ms OFF, REPEAT....*/
141 TONE_TYPE_CDMA_HIGH_PBX_L, /**< CDMA HIGH PBX L: {3700Hz 25ms, 4000Hz 25ms}20 times, 2000ms OFF, REPEAT.... */
142 TONE_TYPE_CDMA_MED_PBX_L, /**< CDMA MED PBX L: {2600Hz 25ms, 2900Hz 25ms}20 times, 2000ms OFF, REPEAT.... */
143 TONE_TYPE_CDMA_LOW_PBX_L, /**< CDMA LOW PBX L: {1300Hz 25ms,1450Hz 25ms}20 times, 2000ms OFF, REPEAT.... */
144 TONE_TYPE_CDMA_HIGH_PBX_SS, /**< CDMA HIGH PBX SS tone: {3700Hz 25ms, 4000Hz 25ms} 8 times 200 ms OFF, {3700Hz 25ms 4000Hz 25ms}8 times, 2000ms OFF, REPEAT.... */
145 TONE_TYPE_CDMA_MED_PBX_SS, /**< CDMA MED PBX SS tone: {2600Hz 25ms, 2900Hz 25ms} 8 times 200 ms OFF, {2600Hz 25ms 2900Hz 25ms}8 times, 2000ms OFF, REPEAT.... */
146 TONE_TYPE_CDMA_LOW_PBX_SS, /**< CDMA LOW PBX SS tone: {1300Hz 25ms, 1450Hz 25ms} 8 times 200 ms OFF, {1300Hz 25ms 1450Hz 25ms}8 times, 2000ms OFF, REPEAT.... */
147 TONE_TYPE_CDMA_HIGH_PBX_SSL, /**< CDMA HIGH PBX SSL tone:{3700Hz 25ms, 4000Hz 25ms} 8 times 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} 8 times, 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} 16 times, 1000ms OFF, REPEAT.... */
148 TONE_TYPE_CDMA_MED_PBX_SSL, /**< CDMA MED PBX SSL tone:{2600Hz 25ms, 2900Hz 25ms} 8 times 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} 8 times, 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} 16 times, 1000ms OFF, REPEAT.... */
149 TONE_TYPE_CDMA_LOW_PBX_SSL, /**< CDMA LOW PBX SSL tone:{1300Hz 25ms, 1450Hz 25ms} 8 times 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} 8 times, 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} 16 times, 1000ms OFF, REPEAT.... */
150 TONE_TYPE_CDMA_HIGH_PBX_SLS, /**< CDMA HIGH PBX SLS tone:{3700Hz 25ms, 4000Hz 25ms} 8 times 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} 16 times, 200ms OFF, {3700Hz 25ms, 4000Hz 25ms} 8 times, 1000ms OFF, REPEAT.... */
151 TONE_TYPE_CDMA_MED_PBX_SLS, /**< CDMA MED PBX SLS tone:{2600Hz 25ms, 2900Hz 25ms} 8 times 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} 16 times, 200ms OFF, {2600Hz 25ms, 2900Hz 25ms} 8 times, 1000ms OFF, REPEAT.... */
152 TONE_TYPE_CDMA_LOW_PBX_SLS, /**< CDMA LOW PBX SLS tone:{1300Hz 25ms, 1450Hz 25ms} 8 times 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} 16 times, 200ms OFF, {1300Hz 25ms, 1450Hz 25ms} 8 times, 1000ms OFF, REPEAT.... */
153 TONE_TYPE_CDMA_HIGH_PBX_S_X4, /**< CDMA HIGH PBX X S4 tone: {3700Hz 25ms 4000Hz 25ms} 8 times, 200ms OFF, {3700Hz 25ms 4000Hz 25ms} 8 times, 200ms OFF, {3700Hz 25ms 4000Hz 25ms} 8 times, 200ms OFF, {3700Hz 25ms 4000Hz 25ms} 8 times, 800ms OFF, REPEAT... */
154 TONE_TYPE_CDMA_MED_PBX_S_X4, /**< CDMA MED PBX X S4 tone: {2600Hz 25ms 2900Hz 25ms} 8 times, 200ms OFF, {2600Hz 25ms 2900Hz 25ms} 8 times, 200ms OFF, {2600Hz 25ms 2900Hz 25ms} 8 times, 200ms OFF, {2600Hz 25ms 2900Hz 25ms} 8 times, 800ms OFF, REPEAT... */
155 TONE_TYPE_CDMA_LOW_PBX_S_X4, /**< CDMA LOW PBX X S4 tone: {1300Hz 25ms 1450Hz 25ms} 8 times, 200ms OFF, {1300Hz 25ms 1450Hz 25ms} 8 times, 200ms OFF, {1300Hz 25ms 1450Hz 25ms} 8 times, 200ms OFF, {1300Hz 25ms 1450Hz 25ms} 8 times, 800ms OFF, REPEAT... */
156 TONE_TYPE_CDMA_ALERT_NETWORK_LITE, /**< CDMA Alert Network Lite tone: 1109Hz 62ms ON, 784Hz 62ms ON, 740Hz 62ms ON 622Hz 62ms ON, 1109Hz 62ms ON */
157 TONE_TYPE_CDMA_ALERT_AUTOREDIAL_LITE, /**< CDMA Alert Auto Redial tone: {1245Hz 62ms ON, 659Hz 62ms ON} 3 times, 1245 62ms ON */
158 TONE_TYPE_CDMA_ONE_MIN_BEEP, /**< CDMA One Min Beep tone: 1150Hz+770Hz 400ms ON */
159 TONE_TYPE_CDMA_KEYPAD_VOLUME_KEY_LITE, /**< CDMA KEYPAD Volume key lite tone: 941Hz+1477Hz 120ms ON */
160 TONE_TYPE_CDMA_PRESSHOLDKEY_LITE, /**< CDMA PRESSHOLDKEY LITE tone: 587Hz 375ms ON, 1175Hz 125ms ON */
161 TONE_TYPE_CDMA_ALERT_INCALL_LITE, /**< CDMA ALERT INCALL LITE tone: 587Hz 62ms, 784 62ms, 831Hz 62ms, 784Hz 62ms, 1109 62ms, 784Hz 62ms, 831Hz 62ms, 784Hz 62ms*/
162 TONE_TYPE_CDMA_EMERGENCY_RINGBACK, /**< CDMA EMERGENCY RINGBACK tone: {941Hz 125ms ON, 10ms OFF} 3times 4990ms OFF, REPEAT... */
163 TONE_TYPE_CDMA_ALERT_CALL_GUARD, /**< CDMA ALERT CALL GUARD tone: {1319Hz 125ms ON, 125ms OFF} 3 times */
164 TONE_TYPE_CDMA_SOFT_ERROR_LITE, /**< CDMA SOFT ERROR LITE tone: 1047Hz 125ms ON, 370Hz 125ms */
165 TONE_TYPE_CDMA_CALLDROP_LITE, /**< CDMA CALLDROP LITE tone: 1480Hz 125ms, 1397Hz 125ms, 784Hz 125ms */
166 TONE_TYPE_CDMA_NETWORK_BUSY_ONE_SHOT, /**< CDMA_NETWORK_BUSY_ONE_SHOT tone: 425Hz 500ms ON, 500ms OFF. */
167 TONE_TYPE_CDMA_ABBR_ALERT, /**< CDMA_ABBR_ALERT tone: 1150Hz+770Hz 400ms ON */
168 TONE_TYPE_CDMA_SIGNAL_OFF, /**< CDMA_SIGNAL_OFF - silent tone */
169 TONE_TYPE_USER_DEFINED_LOW_FRE, /**< User Defined Tone: 100Hz continuous */
170 TONE_TYPE_USER_DEFINED_MED_FRE, /**< User Defined Tone: 200Hz continuous */
171 TONE_TYPE_USER_DEFINED_HIGH_FRE /**< User Defined Tone: 300Hz continuous */
181 * @addtogroup CAPI_MEDIA_TONE_PLAYER_MODULE
187 * @deprecated Deprecated since 3.0. Use tone_player_start_with_stream_info() instead.
188 * @brief Plays a tone.
190 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
192 * @remarks Sound can be mixed with other sounds if you don't control the sound session in sound-manager module since 3.0.\n
193 * You can refer to @ref CAPI_MEDIA_SUOND_MANAGER_MODULE.
195 * @param[in] tone The tone type to play
196 * @param[in] type The sound type
197 * @param[in] duration_ms The tone duration in milliseconds \n
198 * @c -1 indicates an infinite duration.
199 * @param[out] id The tone player ID ( can be set to @c NULL )
201 * @return @c 0 on success,
202 * otherwise a negative error value
203 * @retval #TONE_PLAYER_ERROR_NONE Successful
204 * @retval #TONE_PLAYER_ERROR_INVALID_PARAMETER Invalid parameter
205 * @retval #TONE_PLAYER_ERROR_INVALID_OPERATION Invalid operation
207 * @see tone_player_stop()
209 int tone_player_start(tone_type_e tone, sound_type_e type, int duration_ms, int *id);
212 * @brief Plays a tone with stream information of sound-manager.
216 * @remarks Voice Recognition stream type is not supported in this API.
218 * @param[in] tone The tone type to play
219 * @param[in] stream_info The sound stream information handle
220 * @param[in] duration_ms The tone duration in milliseconds \n
221 * @c -1 indicates an infinite duration.
222 * @param[out] id The tone player ID ( can be set to @c NULL )
224 * @return @c 0 on success,
225 * otherwise a negative error value
226 * @retval #TONE_PLAYER_ERROR_NONE Successful
227 * @retval #TONE_PLAYER_ERROR_INVALID_PARAMETER Invalid parameter
228 * @retval #TONE_PLAYER_ERROR_INVALID_OPERATION Invalid operation
229 * @retval #TONE_PLAYER_ERROR_NOT_SUPPORTED_TYPE Not supported stream type
231 * @see tone_player_stop()
232 * @see sound_manager_create_stream_information()
233 * @see sound_manager_destroy_stream_information()
235 int tone_player_start_with_stream_info(tone_type_e tone, sound_stream_info_h stream_info, int duration_ms, int *id);
238 * @brief Stops playing the tone.
240 * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
242 * @param[in] id The tone player ID to stop
244 * @return 0 on success, otherwise a negative error value.
245 * @retval #TONE_PLAYER_ERROR_NONE Successful
246 * @retval #TONE_PLAYER_ERROR_INVALID_PARAMETER Invalid parameter
247 * @retval #TONE_PLAYER_ERROR_INVALID_OPERATION Invalid operation
249 * @see tone_player_start()
251 int tone_player_stop(int id);
264 #endif /* __TIZEN_MEDIA_TONE_PLAYER_H__ */