include/tts.h

   1 /*
   2  * Copyright (c) 2011-2014 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   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
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17
  18 #ifndef __TTS_H__
  19 #define __TTS_H__
  20
  21 #include <tizen.h>
  22
  23 /**
  24 * @file tts.h
  25 */
  26
  27 /**
  28 * @addtogroup CAPI_UIX_TTS_MODULE
  29 * @{
  30 */
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 /**
  37  * @brief Enumeration for error code.
  38  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  39 */
  40 typedef enum {
  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 */
  54 } tts_error_e;
  55
  56 /**
  57  * @brief Enumeration for TTS mode.
  58  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  59 */
  60 typedef enum {
  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 */
  64 } tts_mode_e;
  65
  66 /**
  67  * @brief Enumerations for state.
  68  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  69 */
  70 typedef enum {
  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*/
  75 } tts_state_e;
  76
  77 /**
  78  * @brief Definitions for automatic speaking speed.
  79  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  80 */
  81 #define TTS_SPEED_AUTO          0
  82
  83 /**
  84  * @brief Definitions for automatic voice type.
  85  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  86 */
  87 #define TTS_VOICE_TYPE_AUTO     0
  88
  89 /**
  90  * @brief Definitions for male voice type.
  91  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  92 */
  93 #define TTS_VOICE_TYPE_MALE     1
  94
  95 /**
  96  * @brief Definitions for female voice type.
  97  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  98 */
  99 #define TTS_VOICE_TYPE_FEMALE   2
 100
 101 /**
 102  * @brief Definitions for child voice type.
 103  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 104 */
 105 #define TTS_VOICE_TYPE_CHILD    3
 106
 107 /**
 108  * @brief The TTS handle.
 109  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 110 */
 111 typedef struct tts_s *tts_h;
 112
 113
 114 /**
 115  * @brief Called when the state of TTS is changed.
 116  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 117  *
 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.
 120  *
 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
 125  *
 126  * @pre An application registers this callback using tts_set_state_changed_cb() to detect changing state.
 127  *
 128  * @see tts_set_state_changed_cb()
 129  * @see tts_unset_state_changed_cb()
 130 */
 131 typedef void (*tts_state_changed_cb)(tts_h tts, tts_state_e previous, tts_state_e current, void* user_data);
 132
 133 /**
 134  * @brief Called when utterance has started.
 135  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 136  *
 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
 140  *
 141  * @pre An application registers this callback using tts_set_utterance_started_cb() to detect utterance started.
 142  *
 143  * @see tts_add_text()
 144  * @see tts_set_utterance_started_cb()
 145  * @see tts_unset_utterance_started_cb()
 146 */
 147 typedef void (*tts_utterance_started_cb)(tts_h tts, int utt_id, void* user_data);
 148
 149 /**
 150  * @brief Called when utterance is finished.
 151  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 152  *
 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
 156  *
 157  * @pre An application registers this callback using tts_set_utterance_completed_cb() to detect utterance completed.
 158  *
 159  * @see tts_add_text()
 160  * @see tts_set_utterance_completed_cb()
 161  * @see tts_unset_utterance_completed_cb()
 162 */
 163 typedef void (*tts_utterance_completed_cb)(tts_h tts, int utt_id, void *user_data);
 164
 165 /**
 166  * @brief Called when an error occurs.
 167  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 168  *
 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
 173  *
 174  * @pre An application registers this callback using tts_set_error_cb() to detect error.
 175  *
 176  * @see tts_play()
 177  * @see tts_pause()
 178  * @see tts_stop()
 179  * @see tts_set_error_cb()
 180  * @see tts_unset_error_cb()
 181 */
 182 typedef void (*tts_error_cb)(tts_h tts, int utt_id, tts_error_e reason, void* user_data);
 183
 184 /**
 185  * @brief Called to retrieve the supported voice.
 186  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 187  *
 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
 192  *
 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.
 195  *
 196  * @see tts_foreach_supported_voices()
 197 */
 198 typedef bool(*tts_supported_voice_cb)(tts_h tts, const char* language, int voice_type, void* user_data);
 199
 200 /**
 201  * @brief Called when the default voice is changed.
 202  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 203  *
 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
 210  *
 211  * @see tts_set_default_voice_changed_cb()
 212 */
 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);
 215
 216
 217 /**
 218  * @brief Creates a handle for TTS.
 219  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 220  *
 221  * @remarks If the function succeeds, @a tts handle must be released with tts_destroy().
 222  *
 223  * @param[out] tts The TTS handle
 224  *
 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
 232  *
 233  * @post If this function is called, the TTS state will be #TTS_STATE_CREATED.
 234  *
 235  * @see tts_destroy()
 236 */
 237 int tts_create(tts_h* tts);
 238
 239 /**
 240  * @brief Destroys the handle and disconnects the daemon.
 241  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 242  *
 243  * @param[in] tts The TTS handle
 244  *
 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
 250  *
 251  * @see tts_create()
 252 */
 253 int tts_destroy(tts_h tts);
 254
 255 /**
 256  * @brief Sets the TTS mode.
 257  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 258  *
 259  * @param[in] tts The TTS handle
 260  * @param[in] mode The mode
 261  *
 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
 268  *
 269  * @pre The state should be #TTS_STATE_CREATED.
 270  *
 271  * @see tts_get_mode()
 272 */
 273 int tts_set_mode(tts_h tts, tts_mode_e mode);
 274
 275 /**
 276  * @brief Gets the TTS mode.
 277  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 278  *
 279  * @param[in] tts The TTS handle
 280  * @param[out] mode The mode
 281  *
 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
 287  *
 288  * @pre The state should be #TTS_STATE_CREATED.
 289  *
 290  * @see tts_set_mode()
 291 */
 292 int tts_get_mode(tts_h tts, tts_mode_e* mode);
 293
 294 /**
 295  * @brief Connects the daemon asynchronously.
 296  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 297  *
 298  * @param[in] tts The TTS handle
 299  *
 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
 305  *
 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)
 309  *
 310  * @see tts_unprepare()
 311 */
 312 int tts_prepare(tts_h tts);
 313
 314 /**
 315  * @brief Disconnects the daemon.
 316  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 317  *
 318  * @param[in] tts The TTS handle
 319  *
 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
 325  *
 326  * @pre The state should be #TTS_STATE_READY.
 327  * @post If this function is called, the TTS state will be #TTS_STATE_CREATED.
 328  *
 329  * @see tts_prepare()
 330 */
 331 int tts_unprepare(tts_h tts);
 332
 333 /**
 334  * @brief Retrieves all supported voices of the current engine using callback function.
 335  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 336  *
 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
 340  *
 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
 347  *
 348  * @post This function invokes tts_supported_voice_cb() repeatedly for getting voices.
 349  *
 350  * @see tts_get_default_voice()
 351 */
 352 int tts_foreach_supported_voices(tts_h tts, tts_supported_voice_cb callback, void* user_data);
 353
 354 /**
 355  * @brief Gets the default voice set by the user.
 356  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 357  *
 358  * @remarks If the function succeeds, @a language must be released with free().
 359  *
 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
 363  *
 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
 370  *
 371  * @see tts_foreach_supported_voices()
 372 */
 373 int tts_get_default_voice(tts_h tts, char** language, int* voice_type);
 374
 375 /**
 376  * @brief Gets the maximum byte size for text.
 377  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 378  *
 379  * @param[in] tts The TTS handle
 380  * @param[out] size The maximum byte size for text
 381  *
 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
 387  *
 388  * @pre The state should be #TTS_STATE_READY.
 389  *
 390  * @see tts_add_text()
 391 */
 392 int tts_get_max_text_size(tts_h tts, unsigned int* size);
 393
 394 /**
 395  * @brief Gets the current state of TTS.
 396  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 397  *
 398  * @param[in] tts The TTS handle
 399  * @param[out] state The current state of TTS
 400  *
 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
 405  *
 406  * @see tts_play()
 407  * @see tts_stop()
 408  * @see tts_pause()
 409 */
 410 int tts_get_state(tts_h tts, tts_state_e* state);
 411
 412 /**
 413  * @brief Gets the speed range.
 414  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 415  *
 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
 420  *
 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
 427  *
 428  * @pre The state should be #TTS_STATE_CREATED.
 429  *
 430  * @see tts_add_text()
 431 */
 432 int tts_get_speed_range(tts_h tts, int* min, int* normal, int* max);
 433
 434 /**
 435  * @brief Gets the current error message.
 436  * @since_tizen 3.0
 437  * @privlevel public
 438  * @remarks This function should be called during an tts error callback. If not, the error as operation failure will be returned. \n
 439  * If the function succeeds, @a err_msg must be released using free() when it is no longer required.
 440  *
 441  * @param[in] tts The TTS handle
 442  * @param[out] err_msg The current error message
 443  *
 444  * @return 0 on success, otherwise a negative error value
 445  * @retval #TTS_ERROR_NONE Successful
 446  * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
 447  * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
 448  * @retval #TTS_ERROR_OPERATION_FAILED Operation failure
 449  *
 450  * @see tts_set_error_cb()
 451  * @see tts_unset_error_cb()
 452 */
 453 int tts_get_error_message(tts_h tts, char** err_msg);
 454
 455 /**
 456  * @brief Adds a text to the queue.
 457  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 458  *
 459  * @remarks Locale(e.g. setlocale()) MUST be set for utf8 text validation check.
 460  *
 461  * @param[in] tts The TTS handle
 462  * @param[in] text An input text based utf8
 463  * @param[in] language The language selected from the tts_foreach_supported_voices() (e.g. 'NULL'(Automatic), 'en_US')
 464  * @param[in] voice_type The voice type selected from the tts_foreach_supported_voices() (e.g. #TTS_VOICE_TYPE_AUTO, #TTS_VOICE_TYPE_FEMALE)
 465  * @param[in] speed A speaking speed (e.g. #TTS_SPEED_AUTO or the value from tts_get_speed_range())
 466  * @param[out] utt_id The utterance ID passed to the callback function
 467  *
 468  * @return 0 on success, otherwise a negative error value
 469  * @retval #TTS_ERROR_NONE Successful
 470  * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
 471  * @retval #TTS_ERROR_INVALID_STATE Invalid state
 472  * @retval #TTS_ERROR_INVALID_VOICE Invalid voice about language, voice type
 473  * @retval #TTS_ERROR_OPERATION_FAILED Operation failure
 474  * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
 475  *
 476  * @pre The state should be #TTS_STATE_READY, #TTS_STATE_PLAYING or #TTS_STATE_PAUSED.
 477  * @see tts_get_max_text_size()
 478 */
 479 int tts_add_text(tts_h tts, const char* text, const char* language, int voice_type, int speed, int* utt_id);
 480
 481 /**
 482  * @brief Starts synthesizing voice from the text and plays the synthesized audio data.
 483  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 484  *
 485  * @param[in] tts The TTS handle
 486  *
 487  * @return 0 on success, otherwise a negative error value
 488  * @retval #TTS_ERROR_NONE Successful
 489  * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
 490  * @retval #TTS_ERROR_OUT_OF_NETWORK Out of network
 491  * @retval #TTS_ERROR_INVALID_STATE Invalid state
 492  * @retval #TTS_ERROR_OPERATION_FAILED Operation failure
 493  * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
 494  *
 495  * @pre The current state should be #TTS_STATE_READY or #TTS_STATE_PAUSED.
 496  * @post If this function succeeds, the TTS state will be #TTS_STATE_PLAYING.
 497  *
 498  * @see tts_add_text()
 499  * @see tts_pause()
 500  * @see tts_stop()
 501  * @see tts_utterance_started_cb()
 502  * @see tts_utterance_completed_cb()
 503  * @see tts_error_cb()
 504 */
 505 int tts_play(tts_h tts);
 506
 507 /**
 508  * @brief Stops playing the utterance and clears the queue.
 509  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 510  *
 511  * @param[in] tts The TTS handle
 512  *
 513  * @return 0 on success, otherwise a negative error value
 514  * @retval #TTS_ERROR_NONE Successful
 515  * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
 516  * @retval #TTS_ERROR_INVALID_STATE Invalid state
 517  * @retval #TTS_ERROR_OPERATION_FAILED Operation failure
 518  * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
 519  *
 520  * @pre The TTS state should be #TTS_STATE_READY or #TTS_STATE_PLAYING or #TTS_STATE_PAUSED.
 521  * @post If this function succeeds, the TTS state will be #TTS_STATE_READY.
 522  *      This function will remove all text via tts_add_text() and synthesized sound data.
 523  *
 524  * @see tts_play()
 525  * @see tts_pause()
 526 */
 527 int tts_stop(tts_h tts);
 528
 529 /**
 530  * @brief Pauses the currently playing utterance.
 531  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 532  *
 533  * @param[in] tts The TTS handle
 534  *
 535  * @return 0 on success, otherwise a negative error value
 536  * @retval #TTS_ERROR_NONE Successful
 537  * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
 538  * @retval #TTS_ERROR_INVALID_STATE Invalid state
 539  * @retval #TTS_ERROR_OPERATION_FAILED Operation failure
 540  * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
 541  *
 542  * @pre The TTS state should be #TTS_STATE_PLAYING.
 543  * @post If this function succeeds, the TTS state will be #TTS_STATE_PAUSED.
 544  *
 545  * @see tts_play()
 546  * @see tts_stop()
 547  * @see tts_error_cb()
 548  * @see tts_interrupted_cb()
 549 */
 550 int tts_pause(tts_h tts);
 551
 552 /**
 553  * @brief Registers a callback function to be called when the TTS state changes.
 554  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 555  *
 556  * @param[in] tts The TTS handle
 557  * @param[in] callback The callback function to register
 558  * @param[in] user_data The user data to be passed to the callback function
 559  *
 560  * @return 0 on success, otherwise a negative error value
 561  * @retval #TTS_ERROR_NONE Successful
 562  * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
 563  * @retval #TTS_ERROR_INVALID_STATE Invalid state
 564  * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
 565  *
 566  * @pre The state should be #TTS_STATE_CREATED.
 567  *
 568  * @see tts_state_changed_cb()
 569  * @see tts_unset_state_changed_cb()
 570 */
 571 int tts_set_state_changed_cb(tts_h tts, tts_state_changed_cb callback, void* user_data);
 572
 573 /**
 574  * @brief Unregisters the callback function.
 575  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 576  *
 577  * @param[in] tts The TTS handle
 578  *
 579  * @return 0 on success, otherwise a negative error value
 580  * @retval #TTS_ERROR_NONE Successful
 581  * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
 582  * @retval #TTS_ERROR_INVALID_STATE Invalid state
 583  * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
 584  *
 585  * @pre The state should be #TTS_STATE_CREATED.
 586  *
 587  * @see tts_set_state_changed_cb()
 588 */
 589 int tts_unset_state_changed_cb(tts_h tts);
 590
 591 /**
 592  * @brief Registers a callback function to detect utterance start.
 593  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 594  *
 595  * @param[in] tts The TTS handle
 596  * @param[in] callback The callback function to register
 597  * @param[in] user_data The user data to be passed to the callback function
 598  *
 599  * @return 0 on success, otherwise a negative error value
 600  * @retval #TTS_ERROR_NONE Successful
 601  * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
 602  * @retval #TTS_ERROR_INVALID_STATE Invalid state
 603  * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
 604  *
 605  * @pre The state should be #TTS_STATE_CREATED.
 606  *
 607  * @see tts_utterance_started_cb()
 608  * @see tts_unset_utterance_started_cb()
 609 */
 610 int tts_set_utterance_started_cb(tts_h tts, tts_utterance_started_cb callback, void* user_data);
 611
 612 /**
 613  * @brief Unregisters the callback function.
 614  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 615  *
 616  * @param[in] tts The TTS handle
 617  *
 618  * @return 0 on success, otherwise a negative error value
 619  * @retval #TTS_ERROR_NONE Successful
 620  * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
 621  * @retval #TTS_ERROR_INVALID_STATE Invalid state
 622  * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
 623  *
 624  * @pre The state should be #TTS_STATE_CREATED.
 625  *
 626  * @see tts_set_utterance_started_cb()
 627 */
 628 int tts_unset_utterance_started_cb(tts_h tts);
 629
 630 /**
 631  * @brief Registers a callback function to detect utterance completion.
 632  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 633  *
 634  * @param[in] tts The TTS handle
 635  * @param[in] callback The callback function to register
 636  * @param[in] user_data The user data to be passed to the callback function
 637  *
 638  * @return 0 on success, otherwise a negative error value
 639  * @retval #TTS_ERROR_NONE Successful
 640  * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
 641  * @retval #TTS_ERROR_INVALID_STATE Invalid state
 642  * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
 643  *
 644  * @pre The state should be #TTS_STATE_CREATED.
 645  *
 646  * @see tts_utterance_completed_cb()
 647  * @see tts_unset_utterance_completed_cb()
 648 */
 649 int tts_set_utterance_completed_cb(tts_h tts, tts_utterance_completed_cb callback, void* user_data);
 650
 651 /**
 652  * @brief Unregisters the callback function.
 653  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 654  *
 655  * @param[in] tts The TTS handle
 656  *
 657  * @return 0 on success, otherwise a negative error value
 658  * @retval #TTS_ERROR_NONE Successful
 659  * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
 660  * @retval #TTS_ERROR_INVALID_STATE Invalid state
 661  * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
 662  *
 663  * @pre The state should be #TTS_STATE_CREATED.
 664  *
 665  * @see tts_set_utterance_completed_cb()
 666 */
 667 int tts_unset_utterance_completed_cb(tts_h tts);
 668
 669 /**
 670  * @brief Registers a callback function to detect errors.
 671  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 672  *
 673  * @param[in] tts The TTS handle
 674  * @param[in] callback The callback function to register
 675  * @param[in] user_data The user data to be passed to the callback function
 676  *
 677  * @return 0 on success, otherwise a negative error value
 678  * @retval #TTS_ERROR_NONE Successful
 679  * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
 680  * @retval #TTS_ERROR_INVALID_STATE Invalid state
 681  * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
 682  *
 683  * @pre The state should be #TTS_STATE_CREATED.
 684  *
 685  * @see tts_error_cb()
 686  * @see tts_unset_error_cb()
 687 */
 688 int tts_set_error_cb(tts_h tts, tts_error_cb callback, void* user_data);
 689
 690 /**
 691  * @brief Unregisters the callback function.
 692  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 693  *
 694  * @param[in] tts The TTS handle
 695  *
 696  * @return 0 on success, otherwise a negative error value
 697  * @retval #TTS_ERROR_NONE Successful
 698  * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
 699  * @retval #TTS_ERROR_INVALID_STATE Invalid state
 700  * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
 701  *
 702  * @pre The state should be #TTS_STATE_CREATED.
 703  *
 704  * @see tts_set_error_cb()
 705 */
 706 int tts_unset_error_cb(tts_h tts);
 707
 708 /**
 709  * @brief Registers a callback function to detect default voice change.
 710  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 711  *
 712  * @param[in] tts The TTS handle
 713  * @param[in] callback The callback function to register
 714  * @param[in] user_data The user data to be passed to the callback function
 715  *
 716  * @return 0 on success, otherwise a negative error value
 717  * @retval #TTS_ERROR_NONE Successful
 718  * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
 719  * @retval #TTS_ERROR_INVALID_STATE Invalid state
 720  * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
 721  *
 722  * @pre The state should be #TTS_STATE_CREATED.
 723  *
 724  * @see tts_default_voice_changed_cb()
 725  * @see tts_unset_default_voice_changed_cb()
 726 */
 727 int tts_set_default_voice_changed_cb(tts_h tts, tts_default_voice_changed_cb callback, void* user_data);
 728
 729 /**
 730  * @brief Unregisters the callback function.
 731  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 732  *
 733  * @param[in] tts The TTS handle
 734  *
 735  * @return 0 on success, otherwise a negative error value
 736  * @retval #TTS_ERROR_NONE Successful
 737  * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter
 738  * @retval #TTS_ERROR_INVALID_STATE Invalid state
 739  * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported
 740  *
 741  * @pre The state should be #TTS_STATE_CREATED.
 742  *
 743  * @see tts_set_default_voice_changed_cb()
 744 */
 745 int tts_unset_default_voice_changed_cb(tts_h tts);
 746
 747
 748 #ifdef __cplusplus
 749 }
 750 #endif
 751
 752 /**
 753 * @}
 754 */
 755
 756 #endif  /* __TTS_H__ */