2 * Copyright (c) 2011-2014 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.
28 * @addtogroup CAPI_UIX_TTS_MODULE
37 * @brief Enumeration for error code.
41 TTS_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */
42 TTS_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of Memory */
43 TTS_ERROR_IO_ERROR = TIZEN_ERROR_IO_ERROR, /**< I/O error */
44 TTS_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER,/**< Invalid parameter */
45 TTS_ERROR_OUT_OF_NETWORK = TIZEN_ERROR_NETWORK_DOWN, /**< Network is down */
46 TTS_ERROR_TIMED_OUT = TIZEN_ERROR_TIMED_OUT, /**< No answer from the daemon */
47 TTS_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED,/**< Permission denied */
48 TTS_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< TTS NOT supported */
49 TTS_ERROR_INVALID_STATE = TIZEN_ERROR_TTS | 0x01, /**< Invalid state */
50 TTS_ERROR_INVALID_VOICE = TIZEN_ERROR_TTS | 0x02, /**< Invalid voice */
51 TTS_ERROR_ENGINE_NOT_FOUND = TIZEN_ERROR_TTS | 0x03, /**< No available engine */
52 TTS_ERROR_OPERATION_FAILED = TIZEN_ERROR_TTS | 0x04, /**< Operation failed */
53 TTS_ERROR_AUDIO_POLICY_BLOCKED = TIZEN_ERROR_TTS | 0x05 /**< Audio policy blocked */
57 * @brief Enumeration for TTS mode.
61 TTS_MODE_DEFAULT = 0, /**< Default mode for normal application */
62 TTS_MODE_NOTIFICATION = 1, /**< Notification mode */
63 TTS_MODE_SCREEN_READER = 2 /**< Accessibiliity mode */
67 * @brief Enumerations for state.
71 TTS_STATE_CREATED = 0, /**< 'CREATED' state */
72 TTS_STATE_READY = 1, /**< 'READY' state */
73 TTS_STATE_PLAYING = 2, /**< 'PLAYING' state */
74 TTS_STATE_PAUSED = 3 /**< 'PAUSED' state*/
78 * @brief Definitions for automatic speaking speed.
81 #define TTS_SPEED_AUTO 0
84 * @brief Definitions for automatic voice type.
87 #define TTS_VOICE_TYPE_AUTO 0
90 * @brief Definitions for male voice type.
93 #define TTS_VOICE_TYPE_MALE 1
96 * @brief Definitions for female voice type.
99 #define TTS_VOICE_TYPE_FEMALE 2
102 * @brief Definitions for child voice type.
105 #define TTS_VOICE_TYPE_CHILD 3
108 * @brief The TTS handle.
111 typedef struct tts_s *tts_h;
115 * @brief Called when the state of TTS is changed.
118 * @details If the daemon must stop player because of changing engine and
119 * the daemon must pause player because of other requests, this callback function is called.
121 * @param[in] tts The TTS handle
122 * @param[in] previous The previous state
123 * @param[in] current The current state
124 * @param[in] user_data The user data passed from the callback registration function
126 * @pre An application registers this callback using tts_set_state_changed_cb() to detect changing state.
128 * @see tts_set_state_changed_cb()
129 * @see tts_unset_state_changed_cb()
131 typedef void (*tts_state_changed_cb)(tts_h tts, tts_state_e previous, tts_state_e current, void* user_data);
134 * @brief Called when utterance has started.
137 * @param[in] tts The TTS handle
138 * @param[in] utt_id The utterance ID passed from the add text function
139 * @param[in] user_data The user data passed from the callback registration function
141 * @pre An application registers this callback using tts_set_utterance_started_cb() to detect utterance started.
143 * @see tts_add_text()
144 * @see tts_set_utterance_started_cb()
145 * @see tts_unset_utterance_started_cb()
147 typedef void (*tts_utterance_started_cb)(tts_h tts, int utt_id, void* user_data);
150 * @brief Called when utterance is finished.
153 * @param[in] tts The TTS handle
154 * @param[in] utt_id The utterance ID passed from the add text function
155 * @param[in] user_data The user data passed from the callback registration function
157 * @pre An application registers this callback using tts_set_utterance_completed_cb() to detect utterance completed.
159 * @see tts_add_text()
160 * @see tts_set_utterance_completed_cb()
161 * @see tts_unset_utterance_completed_cb()
163 typedef void (*tts_utterance_completed_cb)(tts_h tts, int utt_id, void *user_data);
166 * @brief Called when an error occurs.
169 * @param[in] tts The TTS handle
170 * @param[in] utt_id The utterance ID passed from the add text function
171 * @param[in] reason The error code
172 * @param[in] user_data The user data passed from the callback registration function
174 * @pre An application registers this callback using tts_set_error_cb() to detect error.
179 * @see tts_set_error_cb()
180 * @see tts_unset_error_cb()
182 typedef void (*tts_error_cb)(tts_h tts, int utt_id, tts_error_e reason, void* user_data);
185 * @brief Called to retrieve the supported voice.
188 * @param[in] tts The TTS handle
189 * @param[in] language Language specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code (for example, "ko_KR" for Korean, "en_US" for American English)
190 * @param[in] voice_type A voice type (e.g. #TTS_VOICE_TYPE_MALE, #TTS_VOICE_TYPE_FEMALE)
191 * @param[in] user_data The user data passed from the foreach function
193 * @return @c true to continue with the next iteration of the loop, \n @c false to break out of the loop
194 * @pre tts_foreach_supported_voices() will invoke this callback function.
196 * @see tts_foreach_supported_voices()
198 typedef bool(*tts_supported_voice_cb)(tts_h tts, const char* language, int voice_type, void* user_data);
201 * @brief Called when the default voice is changed.
204 * @param[in] tts The TTS handle
205 * @param[in] previous_language The previous language
206 * @param[in] previous_voice_type The previous voice type
207 * @param[in] current_language The current language
208 * @param[in] current_voice_type The current voice type
209 * @param[in] user_data The user data passed from the callback registration function
211 * @see tts_set_default_voice_changed_cb()
213 typedef void (*tts_default_voice_changed_cb)(tts_h tts, const char* previous_language, int previous_voice_type,
214 const char* current_language, int current_voice_type, void* user_data);
218 * @brief Creates a handle for TTS.
221 * @remarks If the function succeeds, @a tts handle must be released with tts_destroy().
223 * @param[out] tts The TTS handle
225 * @return 0 on success, otherwise a negative error value
226 * @retval #TTS_ERROR_NONE Successful
227 * @retval #TTS_ERROR_OUT_OF_MEMORY Out of memory
228 * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
229 * @retval #TTS_ERROR_ENGINE_NOT_FOUND Engine not found
230 * @retval #TTS_ERROR_OPERATION_FAILED Operation failure
231 * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
233 * @post If this function is called, the TTS state will be #TTS_STATE_CREATED.
237 int tts_create(tts_h* tts);
240 * @brief Destroys the handle and disconnects the daemon.
243 * @param[in] tts The TTS handle
245 * @return 0 on success, otherwise a negative error value
246 * @retval #TTS_ERROR_NONE Successful
247 * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
248 * @retval #TTS_ERROR_OPERATION_FAILED Operation failure
249 * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
253 int tts_destroy(tts_h tts);
256 * @brief Sets the TTS mode.
259 * @param[in] tts The TTS handle
260 * @param[in] mode The mode
262 * @return 0 on success, otherwise a negative error value
263 * @retval #TTS_ERROR_NONE Successful
264 * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
265 * @retval #TTS_ERROR_INVALID_STATE Invalid state
266 * @retval #TTS_ERROR_OPERATION_FAILED Operation failure
267 * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
269 * @pre The state should be #TTS_STATE_CREATED.
271 * @see tts_get_mode()
273 int tts_set_mode(tts_h tts, tts_mode_e mode);
276 * @brief Gets the TTS mode.
279 * @param[in] tts The TTS handle
280 * @param[out] mode The mode
282 * @return 0 on success, otherwise a negative error value
283 * @retval #TTS_ERROR_NONE Successful
284 * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
285 * @retval #TTS_ERROR_INVALID_STATE Invalid state
286 * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
288 * @pre The state should be #TTS_STATE_CREATED.
290 * @see tts_set_mode()
292 int tts_get_mode(tts_h tts, tts_mode_e* mode);
295 * @brief Connects the daemon asynchronously.
298 * @param[in] tts The TTS handle
300 * @return 0 on success, otherwise a negative error value
301 * @retval #TTS_ERROR_NONE Successful
302 * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
303 * @retval #TTS_ERROR_INVALID_STATE Invalid state
304 * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
306 * @pre The state should be #TTS_STATE_CREATED.
307 * @post If this function is successful, the TTS state will be #TTS_STATE_READY. \n
308 * If this function is failed, the error callback is called. (e.g. #TTS_ERROR_ENGINE_NOT_FOUND)
310 * @see tts_unprepare()
312 int tts_prepare(tts_h tts);
315 * @brief Disconnects the daemon.
318 * @param[in] tts The TTS handle
320 * @return 0 on success, otherwise a negative error value
321 * @retval #TTS_ERROR_NONE Successful
322 * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
323 * @retval #TTS_ERROR_INVALID_STATE Invalid state
324 * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
326 * @pre The state should be #TTS_STATE_READY.
327 * @post If this function is called, the TTS state will be #TTS_STATE_CREATED.
331 int tts_unprepare(tts_h tts);
334 * @brief Retrieves all supported voices of the current engine using callback function.
337 * @param[in] tts The TTS handle
338 * @param[in] callback The callback function to invoke
339 * @param[in] user_data The user data to be passed to the callback function
341 * @return 0 on success, otherwise a negative error value
342 * @retval #TTS_ERROR_NONE Successful
343 * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
344 * @retval #TTS_ERROR_ENGINE_NOT_FOUND Engine not found
345 * @retval #TTS_ERROR_OPERATION_FAILED Operation failure
346 * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
348 * @post This function invokes tts_supported_voice_cb() repeatedly for getting voices.
350 * @see tts_get_default_voice()
352 int tts_foreach_supported_voices(tts_h tts, tts_supported_voice_cb callback, void* user_data);
355 * @brief Gets the default voice set by the user.
358 * @remarks If the function succeeds, @a language must be released with free().
360 * @param[in] tts The TTS handle
361 * @param[out] language Language specified as an ISO 3166 alpha-2 two letter country-code followed by ISO 639-1 for the two-letter language code (for example, "ko_KR" for Korean, "en_US" for American English)
362 * @param[out] voice_type The voice type
364 * @return 0 on success, otherwise a negative error value
365 * @retval #TTS_ERROR_NONE Successful
366 * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
367 * @retval #TTS_ERROR_ENGINE_NOT_FOUND Engine not found
368 * @retval #TTS_ERROR_OPERATION_FAILED Operation failure
369 * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
371 * @see tts_foreach_supported_voices()
373 int tts_get_default_voice(tts_h tts, char** language, int* voice_type);
376 * @brief Gets the maximum byte size for text.
379 * @param[in] tts The TTS handle
380 * @param[out] size The maximum byte size for text
382 * @return 0 on success, otherwise a negative error value
383 * @retval #TTS_ERROR_NONE Successful
384 * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
385 * @retval #TTS_ERROR_INVALID_STATE Invalid state
386 * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
388 * @pre The state should be #TTS_STATE_READY.
390 * @see tts_add_text()
392 int tts_get_max_text_size(tts_h tts, unsigned int* size);
395 * @brief Gets the current state of TTS.
398 * @param[in] tts The TTS handle
399 * @param[out] state The current state of TTS
401 * @return 0 on success, otherwise a negative error value
402 * @retval #TTS_ERROR_NONE Successful
403 * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
404 * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
410 int tts_get_state(tts_h tts, tts_state_e* state);
413 * @brief Gets the speed range.
416 * @param[in] tts The TTS handle
417 * @param[out] min The minimun speed value
418 * @param[out] normal The normal speed value
419 * @param[out] max The maximum speed value
421 * @return 0 on success, otherwise a negative error value
422 * @retval #TTS_ERROR_NONE Successful
423 * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
424 * @retval #TTS_ERROR_INVALID_STATE Invalid state
425 * @retval #TTS_ERROR_OPERATION_FAILED Operation failure
426 * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
428 * @pre The state should be #TTS_STATE_CREATED.
430 * @see tts_add_text()
432 int tts_get_speed_range(tts_h tts, int* min, int* normal, int* max);
435 * @brief Adds a text to the queue.
438 * @remarks Locale(e.g. setlocale()) MUST be set for utf8 text validation check.
440 * @param[in] tts The TTS handle
441 * @param[in] text An input text based utf8
442 * @param[in] language The language selected from the tts_foreach_supported_voices() (e.g. 'NULL'(Automatic), 'en_US')
443 * @param[in] voice_type The voice type selected from the tts_foreach_supported_voices() (e.g. #TTS_VOICE_TYPE_AUTO, #TTS_VOICE_TYPE_FEMALE)
444 * @param[in] speed A speaking speed (e.g. #TTS_SPEED_AUTO or the value from tts_get_speed_range())
445 * @param[out] utt_id The utterance ID passed to the callback function
447 * @return 0 on success, otherwise a negative error value
448 * @retval #TTS_ERROR_NONE Successful
449 * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
450 * @retval #TTS_ERROR_INVALID_STATE Invalid state
451 * @retval #TTS_ERROR_INVALID_VOICE Invalid voice about language, voice type
452 * @retval #TTS_ERROR_OPERATION_FAILED Operation failure
453 * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
455 * @pre The state should be #TTS_STATE_READY, #TTS_STATE_PLAYING or #TTS_STATE_PAUSED.
456 * @see tts_get_max_text_size()
458 int tts_add_text(tts_h tts, const char* text, const char* language, int voice_type, int speed, int* utt_id);
461 * @brief Starts synthesizing voice from the text and plays the synthesized audio data.
464 * @param[in] tts The TTS handle
466 * @return 0 on success, otherwise a negative error value
467 * @retval #TTS_ERROR_NONE Successful
468 * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
469 * @retval #TTS_ERROR_OUT_OF_NETWORK Out of network
470 * @retval #TTS_ERROR_INVALID_STATE Invalid state
471 * @retval #TTS_ERROR_OPERATION_FAILED Operation failure
472 * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
474 * @pre The current state should be #TTS_STATE_READY or #TTS_STATE_PAUSED.
475 * @post If this function succeeds, the TTS state will be #TTS_STATE_PLAYING.
477 * @see tts_add_text()
480 * @see tts_utterance_started_cb()
481 * @see tts_utterance_completed_cb()
482 * @see tts_error_cb()
484 int tts_play(tts_h tts);
487 * @brief Stops playing the utterance and clears the queue.
490 * @param[in] tts The TTS handle
492 * @return 0 on success, otherwise a negative error value
493 * @retval #TTS_ERROR_NONE Successful
494 * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
495 * @retval #TTS_ERROR_INVALID_STATE Invalid state
496 * @retval #TTS_ERROR_OPERATION_FAILED Operation failure
497 * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
499 * @pre The TTS state should be #TTS_STATE_READY or #TTS_STATE_PLAYING or #TTS_STATE_PAUSED.
500 * @post If this function succeeds, the TTS state will be #TTS_STATE_READY.
501 * This function will remove all text via tts_add_text() and synthesized sound data.
506 int tts_stop(tts_h tts);
509 * @brief Pauses the currently playing utterance.
512 * @param[in] tts The TTS handle
514 * @return 0 on success, otherwise a negative error value
515 * @retval #TTS_ERROR_NONE Successful
516 * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
517 * @retval #TTS_ERROR_INVALID_STATE Invalid state
518 * @retval #TTS_ERROR_OPERATION_FAILED Operation failure
519 * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
521 * @pre The TTS state should be #TTS_STATE_PLAYING.
522 * @post If this function succeeds, the TTS state will be #TTS_STATE_PAUSED.
526 * @see tts_error_cb()
527 * @see tts_interrupted_cb()
529 int tts_pause(tts_h tts);
532 * @brief Registers a callback function to be called when the TTS state changes.
535 * @param[in] tts The TTS handle
536 * @param[in] callback The callback function to register
537 * @param[in] user_data The user data to be passed to the callback function
539 * @return 0 on success, otherwise a negative error value
540 * @retval #TTS_ERROR_NONE Successful
541 * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
542 * @retval #TTS_ERROR_INVALID_STATE Invalid state
543 * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
545 * @pre The state should be #TTS_STATE_CREATED.
547 * @see tts_state_changed_cb()
548 * @see tts_unset_state_changed_cb()
550 int tts_set_state_changed_cb(tts_h tts, tts_state_changed_cb callback, void* user_data);
553 * @brief Unregisters the callback function.
556 * @param[in] tts The TTS handle
558 * @return 0 on success, otherwise a negative error value
559 * @retval #TTS_ERROR_NONE Successful
560 * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
561 * @retval #TTS_ERROR_INVALID_STATE Invalid state
562 * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
564 * @pre The state should be #TTS_STATE_CREATED.
566 * @see tts_set_state_changed_cb()
568 int tts_unset_state_changed_cb(tts_h tts);
571 * @brief Registers a callback function to detect utterance start.
574 * @param[in] tts The TTS handle
575 * @param[in] callback The callback function to register
576 * @param[in] user_data The user data to be passed to the callback function
578 * @return 0 on success, otherwise a negative error value
579 * @retval #TTS_ERROR_NONE Successful
580 * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
581 * @retval #TTS_ERROR_INVALID_STATE Invalid state
582 * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
584 * @pre The state should be #TTS_STATE_CREATED.
586 * @see tts_utterance_started_cb()
587 * @see tts_unset_utterance_started_cb()
589 int tts_set_utterance_started_cb(tts_h tts, tts_utterance_started_cb callback, void* user_data);
592 * @brief Unregisters the callback function.
595 * @param[in] tts The TTS handle
597 * @return 0 on success, otherwise a negative error value
598 * @retval #TTS_ERROR_NONE Successful
599 * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
600 * @retval #TTS_ERROR_INVALID_STATE Invalid state
601 * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
603 * @pre The state should be #TTS_STATE_CREATED.
605 * @see tts_set_utterance_started_cb()
607 int tts_unset_utterance_started_cb(tts_h tts);
610 * @brief Registers a callback function to detect utterance completion.
613 * @param[in] tts The TTS handle
614 * @param[in] callback The callback function to register
615 * @param[in] user_data The user data to be passed to the callback function
617 * @return 0 on success, otherwise a negative error value
618 * @retval #TTS_ERROR_NONE Successful
619 * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
620 * @retval #TTS_ERROR_INVALID_STATE Invalid state
621 * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
623 * @pre The state should be #TTS_STATE_CREATED.
625 * @see tts_utterance_completed_cb()
626 * @see tts_unset_utterance_completed_cb()
628 int tts_set_utterance_completed_cb(tts_h tts, tts_utterance_completed_cb callback, void* user_data);
631 * @brief Unregisters the callback function.
634 * @param[in] tts The TTS handle
636 * @return 0 on success, otherwise a negative error value
637 * @retval #TTS_ERROR_NONE Successful
638 * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
639 * @retval #TTS_ERROR_INVALID_STATE Invalid state
640 * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
642 * @pre The state should be #TTS_STATE_CREATED.
644 * @see tts_set_utterance_completed_cb()
646 int tts_unset_utterance_completed_cb(tts_h tts);
649 * @brief Registers a callback function to detect errors.
652 * @param[in] tts The TTS handle
653 * @param[in] callback The callback function to register
654 * @param[in] user_data The user data to be passed to the callback function
656 * @return 0 on success, otherwise a negative error value
657 * @retval #TTS_ERROR_NONE Successful
658 * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
659 * @retval #TTS_ERROR_INVALID_STATE Invalid state
660 * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
662 * @pre The state should be #TTS_STATE_CREATED.
664 * @see tts_error_cb()
665 * @see tts_unset_error_cb()
667 int tts_set_error_cb(tts_h tts, tts_error_cb callback, void* user_data);
670 * @brief Unregisters the callback function.
673 * @param[in] tts The TTS handle
675 * @return 0 on success, otherwise a negative error value
676 * @retval #TTS_ERROR_NONE Successful
677 * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
678 * @retval #TTS_ERROR_INVALID_STATE Invalid state
679 * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
681 * @pre The state should be #TTS_STATE_CREATED.
683 * @see tts_set_error_cb()
685 int tts_unset_error_cb(tts_h tts);
688 * @brief Registers a callback function to detect default voice change.
691 * @param[in] tts The TTS handle
692 * @param[in] callback The callback function to register
693 * @param[in] user_data The user data to be passed to the callback function
695 * @return 0 on success, otherwise a negative error value
696 * @retval #TTS_ERROR_NONE Successful
697 * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
698 * @retval #TTS_ERROR_INVALID_STATE Invalid state
699 * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
701 * @pre The state should be #TTS_STATE_CREATED.
703 * @see tts_default_voice_changed_cb()
704 * @see tts_unset_default_voice_changed_cb()
706 int tts_set_default_voice_changed_cb(tts_h tts, tts_default_voice_changed_cb callback, void* user_data);
709 * @brief Unregisters the callback function.
712 * @param[in] tts The TTS handle
714 * @return 0 on success, otherwise a negative error value
715 * @retval #TTS_ERROR_NONE Successful
716 * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
717 * @retval #TTS_ERROR_INVALID_STATE Invalid state
718 * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
720 * @pre The state should be #TTS_STATE_CREATED.
722 * @see tts_set_default_voice_changed_cb()
724 int tts_unset_default_voice_changed_cb(tts_h tts);
735 #endif /* __TTS_H__ */