From: Suyeon Hwang Date: Wed, 15 Feb 2017 08:01:19 +0000 (+0900) Subject: Update header and doc files written in English X-Git-Tag: accepted/tizen/3.0/common/20170224.130006~3 X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Ftts.git;a=commitdiff_plain;h=dcc83a8f6a72f2aa3a74b2d98aaa86c6c62c8f51 Update header and doc files written in English Change-Id: I752fed56e389921e8ca9d862c58fafc9903bed86 Signed-off-by: Suyeon Hwang --- diff --git a/doc/uix_tts_doc.h b/doc/uix_tts_doc.h index 440d5bb..ee51edb 100644 --- a/doc/uix_tts_doc.h +++ b/doc/uix_tts_doc.h @@ -18,18 +18,17 @@ #ifndef __TIZEN_UIX_TTS_DOC_H__ #define __TIZEN_UIX_TTS_DOC_H__ + /** - * @defgroup CAPI_UIX_TTS_MODULE TTS * @ingroup CAPI_UIX_FRAMEWORK + * @defgroup CAPI_UIX_TTS_MODULE TTS * @brief The @ref CAPI_UIX_TTS_MODULE API provides functions for synthesizing voice from text and playing synthesized sound data. - * * @section CAPI_UIX_TTS_MODULE_HEADER Required Header - * \#include + * \#include * * @section CAPI_UIX_TTS_MODULE_OVERVIEW Overview * You can use Text-To-Speech (TTS) API to read sound data transformed by the engine from input texts. * Applications can add input-text to queue for reading continuously and control the player that can play, pause, and stop sound data synthesized from text. - * * To use TTS, follow these steps:
* 1. Create a handle
* 2. Register callback functions for notifications
@@ -40,7 +39,6 @@ * 7. Resume the player
* 8. Stop the player
* 9. Destroy a handle
- * * The TTS API also notifies you (by callback mechanism) when the state of TTS is changed, * utterance is started and completed, default voice is changed or an error occured. * An application should register callback functions: tts_state_changed_cb(), tts_utterance_started_cb(), @@ -61,8 +59,7 @@ * Please check both previous state and post state from the table carefully. * In case of tts_prepare() function, state doesn't be changed at once, but acynchronously. * From the above state diagram, you can see dotted line as asynchronous api. - * In this case, the state changed callback is only way to know state transition as ready. - * + * In this case, the state changed callback is only way to know state transition as ready. * * * @@ -100,7 +97,6 @@ * The following table shows state-dependent function calls. * It is forbidden to call functions listed below in wrong states. * Violation of this rule may result in an unpredictable behavior. - * *
FUNCTION
* * @@ -218,14 +214,13 @@ * * @section CAPI_UIX_TTS_MODULE_FEATURE Related Features * This API is related with the following features:
- * - http://tizen.org/feature/speech.synthesis
- * + * - http://tizen.org/feature/speech.synthesis
* It is recommended to design feature related codes in your application for reliability.
* You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.
* To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.
* More details on featuring your application can be found from Feature Element. - * */ + #endif /* __TIZEN_UIX_TTS_DOC_H__ */ diff --git a/doc/uix_tts_engine_main_doc.h b/doc/uix_tts_engine_main_doc.h index 9dade17..81fcd37 100755 --- a/doc/uix_tts_engine_main_doc.h +++ b/doc/uix_tts_engine_main_doc.h @@ -18,25 +18,21 @@ #ifndef __TIZEN_UIX_TTS_ENGINE_DOC_H__ #define __TIZEN_UIX_TTS_ENGINE_DOC_H__ + /** * @ingroup CAPI_UIX_FRAMEWORK * @defgroup CAPI_UIX_TTSE_MODULE TTS Engine * @brief The @ref CAPI_UIX_TTSE_MODULE APIs provide functions to operate Text-To-Speech Engine. - * - * * @section CAPI_UIX_TTSE_MODULE_HEADER Required Header - * \#include - * + * \#include * * @section CAPI_UIX_TTSE_MODULE_OVERVIEW Overview * Text-To-Speech Engine (below TTSE) is an engine for synthesizing voice from text and playing synthesized sound data. * Using the @ref CAPI_UIX_TTSE_MODULE APIs, TTSE developers can provide TTSE service users, who want to apply TTSE, with functions necessary to operate the engine. * According to the indispensability of TTSE services, there are two ways to provide them to the users.
- * * A. Required TTSE services
* These services are indispensable to operate TTSE. Therefore, the TTSE developers MUST implement callback functions corresponding to the required TTSE services. * The following is a list of the callback functions.
- * *
FUNCTION
* * @@ -91,19 +87,16 @@ * * *
FUNCTIONCalled when the engine service user checks whether TTS engine needs the application's credential.
- * * The TTSE developers can register the above callback functions at a time with using a structure 'ttse_request_callback_s' and an API 'ttse_main()'. * To operate TTSE, the following steps should be used:
* 1. Create a structure 'ttse_request_callback_s' * 2. Implement callback functions. (NOTE that the callback functions should return appropriate values in accordance with the instruction. - * If the callback function returns an unstated value, TTS framework will handle it as #TTSE_ERROR_OPERATION_FAILED.)
+ * If the callback function returns an unstated value, TTS framework will handle it as #TTSE_ERROR_OPERATION_FAILED.)
* 3. Register callback functions using 'ttse_main()'. (The registered callback functions will be invoked when the TTSE service users request the TTSE services.)
* 4. Use 'service_app_main()' for working TTSE.
- * * B. Optional TTSE services
* Unlike the required TTSE services, these services are optional to operate TTSE. The followings are optional TTSE services.
* - receive/provide the private data
- * * If the TTSE developers want to provide the above services, use the following APIs and implement the corresponding callback functions:
* * @@ -122,10 +115,8 @@ * * *
ttse_private_data_requested_cb()
- * * Using the above APIs, the TTSE developers can register the optional callback functions respectively. * (For normal operation, put those APIs before 'service_app_main()' starts.) - * * Unlike callback functions, the following APIs are functions for getting and sending data. The TTSE developers can use these APIs when they implement TTSE services:
* * @@ -150,17 +141,15 @@ * *
* - * * @section CAPI_UIX_TTSE_MODULE_FEATURE Related Features * This API is related with the following features:
- * - http://tizen.org/feature/speech.synthesis
- * + * - http://tizen.org/feature/speech.synthesis
* It is recommended to design feature related codes in your application for reliability.
* You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.
* To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.
* More details on featuring your application can be found from Feature Element. - * */ + #endif /* __TIZEN_UIX_TTS_ENGINE_DOC_H__ */ diff --git a/include/tts.h b/include/tts.h index ff1d0d8..c46f108 100644 --- a/include/tts.h +++ b/include/tts.h @@ -18,94 +18,107 @@ #ifndef __TTS_H__ #define __TTS_H__ + #include + /** * @file tts.h */ + /** * @addtogroup CAPI_UIX_TTS_MODULE * @{ */ + #ifdef __cplusplus extern "C" { #endif + /** * @brief Enumeration for error code. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ typedef enum { - TTS_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ - TTS_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of Memory */ - TTS_ERROR_IO_ERROR = TIZEN_ERROR_IO_ERROR, /**< I/O error */ - TTS_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER,/**< Invalid parameter */ - TTS_ERROR_OUT_OF_NETWORK = TIZEN_ERROR_NETWORK_DOWN, /**< Network is down */ - TTS_ERROR_TIMED_OUT = TIZEN_ERROR_TIMED_OUT, /**< No answer from the daemon */ - TTS_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED,/**< Permission denied */ - TTS_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< TTS NOT supported */ - TTS_ERROR_INVALID_STATE = TIZEN_ERROR_TTS | 0x01, /**< Invalid state */ - TTS_ERROR_INVALID_VOICE = TIZEN_ERROR_TTS | 0x02, /**< Invalid voice */ - TTS_ERROR_ENGINE_NOT_FOUND = TIZEN_ERROR_TTS | 0x03, /**< No available engine */ - TTS_ERROR_OPERATION_FAILED = TIZEN_ERROR_TTS | 0x04, /**< Operation failed */ - TTS_ERROR_AUDIO_POLICY_BLOCKED = TIZEN_ERROR_TTS | 0x05, /**< Audio policy blocked */ - TTS_ERROR_NOT_SUPPORTED_FEATURE = TIZEN_ERROR_TTS | 0x06, /**< Not supported feature of current engine @if MOBILE (Since 3.0) @elseif WEARABLE (Since 2.3.2) @endif */ - TTS_ERROR_SERVICE_RESET = TIZEN_ERROR_TTS | 0x07 /**< Service reset @if MOBILE (Since 3.0) @elseif WEARABLE (Since 2.3.2) @endif */ + TTS_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ + TTS_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of Memory */ + TTS_ERROR_IO_ERROR = TIZEN_ERROR_IO_ERROR, /**< I/O error */ + TTS_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */ + TTS_ERROR_OUT_OF_NETWORK = TIZEN_ERROR_NETWORK_DOWN, /**< Network is down */ + TTS_ERROR_TIMED_OUT = TIZEN_ERROR_TIMED_OUT, /**< No answer from the daemon */ + TTS_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */ + TTS_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED, /**< TTS NOT supported */ + TTS_ERROR_INVALID_STATE = TIZEN_ERROR_TTS | 0x01, /**< Invalid state */ + TTS_ERROR_INVALID_VOICE = TIZEN_ERROR_TTS | 0x02, /**< Invalid voice */ + TTS_ERROR_ENGINE_NOT_FOUND = TIZEN_ERROR_TTS | 0x03, /**< No available engine */ + TTS_ERROR_OPERATION_FAILED = TIZEN_ERROR_TTS | 0x04, /**< Operation failed */ + TTS_ERROR_AUDIO_POLICY_BLOCKED = TIZEN_ERROR_TTS | 0x05, /**< Audio policy blocked */ + TTS_ERROR_NOT_SUPPORTED_FEATURE = TIZEN_ERROR_TTS | 0x06, /**< Not supported feature of current engine @if MOBILE (Since 3.0) @elseif WEARABLE (Since 2.3.2) @endif */ + TTS_ERROR_SERVICE_RESET = TIZEN_ERROR_TTS | 0x07 /**< Service reset @if MOBILE (Since 3.0) @elseif WEARABLE (Since 2.3.2) @endif */ } tts_error_e; + /** * @brief Enumeration for TTS mode. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ typedef enum { - TTS_MODE_DEFAULT = 0, /**< Default mode for normal application */ - TTS_MODE_NOTIFICATION = 1, /**< Notification mode */ - TTS_MODE_SCREEN_READER = 2 /**< Accessibiliity mode */ + TTS_MODE_DEFAULT = 0, /**< Default mode for normal application */ + TTS_MODE_NOTIFICATION = 1, /**< Notification mode */ + TTS_MODE_SCREEN_READER = 2 /**< Accessibiliity mode */ } tts_mode_e; + /** - * @brief Enumerations for state. + * @brief Enumeration for state. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ typedef enum { - TTS_STATE_CREATED = 0, /**< 'CREATED' state */ - TTS_STATE_READY = 1, /**< 'READY' state */ - TTS_STATE_PLAYING = 2, /**< 'PLAYING' state */ - TTS_STATE_PAUSED = 3 /**< 'PAUSED' state*/ + TTS_STATE_CREATED = 0, /**< 'CREATED' state */ + TTS_STATE_READY = 1, /**< 'READY' state */ + TTS_STATE_PLAYING = 2, /**< 'PLAYING' state */ + TTS_STATE_PAUSED = 3 /**< 'PAUSED' state*/ } tts_state_e; + /** - * @brief Definitions for automatic speaking speed. + * @brief Definition for automatic speaking speed. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ #define TTS_SPEED_AUTO 0 + /** - * @brief Definitions for automatic voice type. + * @brief Definition for automatic voice type. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ #define TTS_VOICE_TYPE_AUTO 0 + /** - * @brief Definitions for male voice type. + * @brief Definition for male voice type. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ #define TTS_VOICE_TYPE_MALE 1 + /** - * @brief Definitions for female voice type. + * @brief Definition for female voice type. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ #define TTS_VOICE_TYPE_FEMALE 2 + /** - * @brief Definitions for child voice type. + * @brief Definition for child voice type. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif */ #define TTS_VOICE_TYPE_CHILD 3 + /** * @brief The TTS handle. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif @@ -116,65 +129,55 @@ typedef struct tts_s *tts_h; /** * @brief Called when the state of TTS is changed. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @details If the daemon must stop player because of changing engine and - * the daemon must pause player because of other requests, this callback function is called. - * + * the daemon must pause player because of other requests, this callback function is called. * @param[in] tts The TTS handle * @param[in] previous The previous state * @param[in] current The current state * @param[in] user_data The user data passed from the callback registration function - * * @pre An application registers this callback using tts_set_state_changed_cb() to detect changing state. - * * @see tts_set_state_changed_cb() * @see tts_unset_state_changed_cb() */ typedef void (*tts_state_changed_cb)(tts_h tts, tts_state_e previous, tts_state_e current, void* user_data); + /** * @brief Called when utterance has started. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle * @param[in] utt_id The utterance ID passed from the add text function * @param[in] user_data The user data passed from the callback registration function - * * @pre An application registers this callback using tts_set_utterance_started_cb() to detect utterance started. - * * @see tts_add_text() * @see tts_set_utterance_started_cb() * @see tts_unset_utterance_started_cb() */ typedef void (*tts_utterance_started_cb)(tts_h tts, int utt_id, void* user_data); + /** * @brief Called when utterance is finished. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle * @param[in] utt_id The utterance ID passed from the add text function * @param[in] user_data The user data passed from the callback registration function - * * @pre An application registers this callback using tts_set_utterance_completed_cb() to detect utterance completed. - * * @see tts_add_text() * @see tts_set_utterance_completed_cb() * @see tts_unset_utterance_completed_cb() */ typedef void (*tts_utterance_completed_cb)(tts_h tts, int utt_id, void *user_data); + /** * @brief Called when an error occurs. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle * @param[in] utt_id The utterance ID passed from the add text function * @param[in] reason The error code * @param[in] user_data The user data passed from the callback registration function - * * @pre An application registers this callback using tts_set_error_cb() to detect error. - * * @see tts_play() * @see tts_pause() * @see tts_stop() @@ -183,48 +186,46 @@ typedef void (*tts_utterance_completed_cb)(tts_h tts, int utt_id, void *user_dat */ typedef void (*tts_error_cb)(tts_h tts, int utt_id, tts_error_e reason, void* user_data); + /** * @brief Called to retrieve the supported voice. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle * @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) * @param[in] voice_type A voice type (e.g. #TTS_VOICE_TYPE_MALE, #TTS_VOICE_TYPE_FEMALE) * @param[in] user_data The user data passed from the foreach function - * - * @return @c true to continue with the next iteration of the loop, \n @c false to break out of the loop + * @return @c true to continue with the next iteration of the loop, + * @c false to break out of the loop * @pre tts_foreach_supported_voices() will invoke this callback function. - * * @see tts_foreach_supported_voices() */ typedef bool(*tts_supported_voice_cb)(tts_h tts, const char* language, int voice_type, void* user_data); + /** * @brief Called when the default voice is changed. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle * @param[in] previous_language The previous language * @param[in] previous_voice_type The previous voice type * @param[in] current_language The current language * @param[in] current_voice_type The current voice type * @param[in] user_data The user data passed from the callback registration function - * * @see tts_set_default_voice_changed_cb() */ typedef void (*tts_default_voice_changed_cb)(tts_h tts, const char* previous_language, int previous_voice_type, const char* current_language, int current_voice_type, void* user_data); + + /** * @brief Called when the engine is changed. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * * @param[in] tts The TTS handle - * @param[in] engine_id Engine id + * @param[in] engine_id Engine ID * @param[in] language The default 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) * @param[in] voice_type The default voice type * @param[in] need_credential The necessity of credential * @param[in] user_data The user data passed from the callback registration function - * * @see tts_set_engine_changed_cb() */ typedef void (*tts_engine_changed_cb)(tts_h tts, const char* engine_id, const char* language, int voice_type, bool need_credential, void* user_data); @@ -233,336 +234,301 @@ typedef void (*tts_engine_changed_cb)(tts_h tts, const char* engine_id, const ch /** * @brief Creates a handle for TTS. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @remarks If the function succeeds, @a tts handle must be released with tts_destroy(). - * * @param[out] tts The TTS handle - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_OUT_OF_MEMORY Out of memory * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_ENGINE_NOT_FOUND Engine not found * @retval #TTS_ERROR_OPERATION_FAILED Operation failure * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @post If this function is called, the TTS state will be #TTS_STATE_CREATED. - * * @see tts_destroy() */ int tts_create(tts_h* tts); + /** * @brief Destroys the handle and disconnects the daemon. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_OPERATION_FAILED Operation failure * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @see tts_create() */ int tts_destroy(tts_h tts); + /** * @brief Sets the TTS mode. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle * @param[in] mode The mode - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_INVALID_STATE Invalid state * @retval #TTS_ERROR_OPERATION_FAILED Operation failure * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @pre The state should be #TTS_STATE_CREATED. - * * @see tts_get_mode() */ int tts_set_mode(tts_h tts, tts_mode_e mode); + /** * @brief Gets the TTS mode. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle * @param[out] mode The mode - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_INVALID_STATE Invalid state * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @pre The state should be #TTS_STATE_CREATED. - * * @see tts_set_mode() */ int tts_get_mode(tts_h tts, tts_mode_e* mode); + /** * @brief Sets the app credential. * @details Using this API, the application can set a credential. - * The credential is a key to verify the authorization about using the engine. - * If the application sets the credential, it will be able to use functions of the engine entirely. + * The credential is a key to verify the authorization about using the engine. + * If the application sets the credential, it will be able to use functions of the engine entirely. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * * @remarks The necessity of the credential depends on the engine. In case of the engine which is basically embedded in Tizen, the credential is not necessary so far. - * However, if the user wants to apply the 3rd party's engine, the credential may be necessary. In that case, please follow the policy provided by the corresponding engine. - * + * However, if the user wants to apply the 3rd party's engine, the credential may be necessary. In that case, please follow the policy provided by the corresponding engine. * @param[in] tts The TTS handle * @param[in] credential The app credential - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Success * @retval #TTS_ERROR_INVALID_STATE Invalid state * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @pre The state should be #TTS_STATE_CREATED or #TTS_STATE_READY. - * * @see tts_play() */ int tts_set_credential(tts_h tts, const char* credential); + /** * @brief Connects the daemon asynchronously. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_INVALID_STATE Invalid state * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @pre The state should be #TTS_STATE_CREATED. - * @post If this function is successful, the TTS state will be #TTS_STATE_READY. \n - * If this function is failed, the error callback is called. (e.g. #TTS_ERROR_ENGINE_NOT_FOUND) - * + * @post If this function is successful, the TTS state will be #TTS_STATE_READY. + * If this function is failed, the error callback is called. (e.g. #TTS_ERROR_ENGINE_NOT_FOUND) * @see tts_unprepare() */ int tts_prepare(tts_h tts); + /** * @brief Disconnects the daemon. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_INVALID_STATE Invalid state * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @pre The state should be #TTS_STATE_READY. * @post If this function is called, the TTS state will be #TTS_STATE_CREATED. - * * @see tts_prepare() */ int tts_unprepare(tts_h tts); + /** * @brief Retrieves all supported voices of the current engine using callback function. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle * @param[in] callback The callback function to invoke * @param[in] user_data The user data to be passed to the callback function - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_ENGINE_NOT_FOUND Engine not found * @retval #TTS_ERROR_OPERATION_FAILED Operation failure * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @post This function invokes tts_supported_voice_cb() repeatedly for getting voices. - * * @see tts_get_default_voice() */ int tts_foreach_supported_voices(tts_h tts, tts_supported_voice_cb callback, void* user_data); + /** * @brief Gets the default voice set by the user. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @remarks If the function succeeds, @a language must be released with free(). - * * @param[in] tts The TTS handle * @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) * @param[out] voice_type The voice type - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_ENGINE_NOT_FOUND Engine not found * @retval #TTS_ERROR_OPERATION_FAILED Operation failure * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @see tts_foreach_supported_voices() */ int tts_get_default_voice(tts_h tts, char** language, int* voice_type); + /** * @brief Sets the private data to tts engine. * @details The private data is the setting parameter for applying keys provided by the engine. - * Using this API, the application can set the private data and use the corresponding key of the engine. - * For example, if the engine provides 'girl's voice' as a voice type, the application can set the private data as the following. \n - * int ret = tts_set_private_data(tts_h, "voice_type", "GIRL"); - * + * Using this API, the application can set the private data and use the corresponding key of the engine. + * For example, if the engine provides 'girl's voice' as a voice type, the application can set the private data as the following. + * int ret = tts_set_private_data(tts_h, "voice_type", "GIRL"); * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * * @remarks If the engine is replaced with the other engine, the key may be ignored. - * * @param[in] tts The TTS handle * @param[in] key The field name of private data * @param[in] data The data for set - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_INVALID_STATE Invalid state * @retval #TTS_ERROR_ENGINE_NOT_FOUND Engine not found * @retval #TTS_ERROR_OPERATION_FAILED Operation failure * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @pre The state should be #TTS_STATE_READY. - * * @see tts_get_private_data() */ int tts_set_private_data(tts_h tts, const char* key, const char* data); + /** * @brief Gets the private data from tts engine. * @details The private data is the information provided by the engine. - * Using this API, the application can get the private data which corresponds to the key from the engine. + * Using this API, the application can get the private data which corresponds to the key from the engine. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * * @remarks The @a data must be released using free() when it is no longer required. - * If the engine is replaced with the other engine, the key may be ignored. - * + * If the engine is replaced with the other engine, the key may be ignored. * @param[in] tts The TTS handle * @param[in] key The field name of private data * @param[out] data The data field of private data - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_STATE Invalid state * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_ENGINE_NOT_FOUND Engine not found * @retval #TTS_ERROR_OPERATION_FAILED Operation failure * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @pre The state should be #TTS_STATE_READY. - * * @see tts_set_private_data() */ int tts_get_private_data(tts_h tts, const char* key, char** data); + /** * @brief Gets the maximum byte size for text. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle * @param[out] size The maximum byte size for text - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_INVALID_STATE Invalid state * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @pre The state should be #TTS_STATE_READY. - * * @see tts_add_text() */ int tts_get_max_text_size(tts_h tts, unsigned int* size); + /** * @brief Gets the current state of TTS. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle * @param[out] state The current state of TTS - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @see tts_play() * @see tts_stop() * @see tts_pause() */ int tts_get_state(tts_h tts, tts_state_e* state); + /** * @brief Gets the speed range. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle - * @param[out] min The minimun speed value + * @param[out] min The minimum speed value * @param[out] normal The normal speed value * @param[out] max The maximum speed value - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_INVALID_STATE Invalid state * @retval #TTS_ERROR_OPERATION_FAILED Operation failure * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @pre The state should be #TTS_STATE_CREATED. - * * @see tts_add_text() */ int tts_get_speed_range(tts_h tts, int* min, int* normal, int* max); + /** * @brief Gets the current error message. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * - * @remarks This function should be called from a tts error callback. Calling in any other context will result in an Operation failed error. \n - * A successful call will allocate @a err_msg, which must be released by calling free() when it is no longer required. - * + * @remarks This function should be called from a tts error callback. Calling in any other context will result in an Operation failed error. + * A successful call will allocate @a err_msg, which must be released by calling free() when it is no longer required. * @param[in] tts The TTS handle * @param[out] err_msg The current error message - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported * @retval #TTS_ERROR_OPERATION_FAILED Operation failure - * * @see tts_set_error_cb() * @see tts_unset_error_cb() */ int tts_get_error_message(tts_h tts, char** err_msg); + /** * @brief Adds a text to the queue. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @remarks Locale(e.g. setlocale()) MUST be set for utf8 text validation check. - * * @param[in] tts The TTS handle * @param[in] text An input text based utf8 * @param[in] language The language selected from the tts_foreach_supported_voices() (e.g. 'NULL'(Automatic), 'en_US') * @param[in] voice_type The voice type selected from the tts_foreach_supported_voices() (e.g. #TTS_VOICE_TYPE_AUTO, #TTS_VOICE_TYPE_FEMALE) * @param[in] speed A speaking speed (e.g. #TTS_SPEED_AUTO or the value from tts_get_speed_range()) * @param[out] utt_id The utterance ID passed to the callback function - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_INVALID_STATE Invalid state @@ -570,20 +536,19 @@ int tts_get_error_message(tts_h tts, char** err_msg); * @retval #TTS_ERROR_OPERATION_FAILED Operation failure * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported * @retval #TTS_ERROR_PERMISSION_DENIED Permission denied - * * @pre The state should be #TTS_STATE_READY, #TTS_STATE_PLAYING or #TTS_STATE_PAUSED. * @see tts_get_max_text_size() * @see tts_set_credential() */ int tts_add_text(tts_h tts, const char* text, const char* language, int voice_type, int speed, int* utt_id); + /** * @brief Starts synthesizing voice from the text and plays the synthesized audio data. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_OUT_OF_NETWORK Out of network @@ -591,10 +556,8 @@ int tts_add_text(tts_h tts, const char* text, const char* language, int voice_ty * @retval #TTS_ERROR_OPERATION_FAILED Operation failure * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported * @retval #TTS_ERROR_PERMISSION_DENIED Permission denied - * * @pre The current state should be #TTS_STATE_READY or #TTS_STATE_PAUSED. * @post If this function succeeds, the TTS state will be #TTS_STATE_PLAYING. - * * @see tts_add_text() * @see tts_pause() * @see tts_stop() @@ -605,44 +568,40 @@ int tts_add_text(tts_h tts, const char* text, const char* language, int voice_ty */ int tts_play(tts_h tts); + /** * @brief Stops playing the utterance and clears the queue. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_INVALID_STATE Invalid state * @retval #TTS_ERROR_OPERATION_FAILED Operation failure * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @pre The TTS state should be #TTS_STATE_READY or #TTS_STATE_PLAYING or #TTS_STATE_PAUSED. * @post If this function succeeds, the TTS state will be #TTS_STATE_READY. - * This function will remove all text via tts_add_text() and synthesized sound data. - * + * This function will remove all text via tts_add_text() and synthesized sound data. * @see tts_play() * @see tts_pause() */ int tts_stop(tts_h tts); + /** * @brief Pauses the currently playing utterance. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_INVALID_STATE Invalid state * @retval #TTS_ERROR_OPERATION_FAILED Operation failure * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @pre The TTS state should be #TTS_STATE_PLAYING. * @post If this function succeeds, the TTS state will be #TTS_STATE_PAUSED. - * * @see tts_play() * @see tts_stop() * @see tts_error_cb() @@ -650,236 +609,212 @@ int tts_stop(tts_h tts); */ int tts_pause(tts_h tts); + /** * @brief Registers a callback function to be called when the TTS state changes. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_INVALID_STATE Invalid state * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @pre The state should be #TTS_STATE_CREATED. - * * @see tts_state_changed_cb() * @see tts_unset_state_changed_cb() */ int tts_set_state_changed_cb(tts_h tts, tts_state_changed_cb callback, void* user_data); + /** * @brief Unregisters the callback function. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_INVALID_STATE Invalid state * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @pre The state should be #TTS_STATE_CREATED. - * * @see tts_set_state_changed_cb() */ int tts_unset_state_changed_cb(tts_h tts); + /** * @brief Registers a callback function to detect utterance start. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_INVALID_STATE Invalid state * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @pre The state should be #TTS_STATE_CREATED. - * * @see tts_utterance_started_cb() * @see tts_unset_utterance_started_cb() */ int tts_set_utterance_started_cb(tts_h tts, tts_utterance_started_cb callback, void* user_data); + /** * @brief Unregisters the callback function. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_INVALID_STATE Invalid state * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @pre The state should be #TTS_STATE_CREATED. - * * @see tts_set_utterance_started_cb() */ int tts_unset_utterance_started_cb(tts_h tts); + /** * @brief Registers a callback function to detect utterance completion. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_INVALID_STATE Invalid state * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @pre The state should be #TTS_STATE_CREATED. - * * @see tts_utterance_completed_cb() * @see tts_unset_utterance_completed_cb() */ int tts_set_utterance_completed_cb(tts_h tts, tts_utterance_completed_cb callback, void* user_data); + /** * @brief Unregisters the callback function. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_INVALID_STATE Invalid state * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @pre The state should be #TTS_STATE_CREATED. - * * @see tts_set_utterance_completed_cb() */ int tts_unset_utterance_completed_cb(tts_h tts); + /** * @brief Registers a callback function to detect errors. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_INVALID_STATE Invalid state * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @pre The state should be #TTS_STATE_CREATED. - * * @see tts_error_cb() * @see tts_unset_error_cb() */ int tts_set_error_cb(tts_h tts, tts_error_cb callback, void* user_data); + /** * @brief Unregisters the callback function. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_INVALID_STATE Invalid state * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @pre The state should be #TTS_STATE_CREATED. - * * @see tts_set_error_cb() */ int tts_unset_error_cb(tts_h tts); + /** * @brief Registers a callback function to detect default voice change. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_INVALID_STATE Invalid state * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @pre The state should be #TTS_STATE_CREATED. - * * @see tts_default_voice_changed_cb() * @see tts_unset_default_voice_changed_cb() */ int tts_set_default_voice_changed_cb(tts_h tts, tts_default_voice_changed_cb callback, void* user_data); + /** * @brief Unregisters the callback function. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif - * * @param[in] tts The TTS handle - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_INVALID_STATE Invalid state * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @pre The state should be #TTS_STATE_CREATED. - * * @see tts_set_default_voice_changed_cb() */ int tts_unset_default_voice_changed_cb(tts_h tts); + /** * @brief Registers a callback function to detect the engine change. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * * @param[in] tts The TTS handle * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_INVALID_STATE Invalid state * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @pre The state should be #TTS_STATE_CREATED. - * * @see tts_engine_changed_cb() * @see tts_unset_engine_changed_cb() */ int tts_set_engine_changed_cb(tts_h tts, tts_engine_changed_cb callback, void* user_data); + /** * @brief Unregisters the callback function. * @since_tizen @if MOBILE 3.0 @elseif WEARABLE 2.3.2 @endif - * * @param[in] tts The TTS handle - * - * @return 0 on success, otherwise a negative error value + * @return @c 0 on success, + * otherwise a negative error value * @retval #TTS_ERROR_NONE Successful * @retval #TTS_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTS_ERROR_INVALID_STATE Invalid state * @retval #TTS_ERROR_NOT_SUPPORTED TTS NOT supported - * * @pre The state should be #TTS_STATE_CREATED. - * * @see tts_set_engine_changed_cb() */ int tts_unset_engine_changed_cb(tts_h tts); @@ -889,8 +824,10 @@ int tts_unset_engine_changed_cb(tts_h tts); } #endif + /** * @}@} */ + #endif /* __TTS_H__ */ diff --git a/include/ttse.h b/include/ttse.h index c2dbfde..43081fb 100755 --- a/include/ttse.h +++ b/include/ttse.h @@ -15,182 +15,179 @@ #ifndef __TTSE_H__ #define __TTSE_H__ + #include + /** * @addtogroup CAPI_UIX_TTSE_MODULE * @{ */ + #ifdef __cplusplus extern "C" { #endif + /** -* @brief Enumerations for error codes. +* @brief Enumeration for error codes. * @since_tizen 3.0 */ typedef enum { - TTSE_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ - TTSE_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of Memory */ - TTSE_ERROR_IO_ERROR = TIZEN_ERROR_IO_ERROR, /**< I/O error */ - TTSE_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */ - TTSE_ERROR_NETWORK_DOWN = TIZEN_ERROR_NETWORK_DOWN, /**< Out of network */ - TTSE_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */ - TTSE_ERROR_INVALID_STATE = TIZEN_ERROR_TTS | 0x01, /**< Invalid state */ - TTSE_ERROR_INVALID_VOICE = TIZEN_ERROR_TTS | 0x02, /**< Invalid voice */ - TTSE_ERROR_OPERATION_FAILED = TIZEN_ERROR_TTS | 0x04, /**< Operation failed */ - TTSE_ERROR_NOT_SUPPORTED_FEATURE = TIZEN_ERROR_TTS | 0x06, /**< Not supported feature */ - TTSE_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED /**< Not supported */ + TTSE_ERROR_NONE = TIZEN_ERROR_NONE, /**< Successful */ + TTSE_ERROR_OUT_OF_MEMORY = TIZEN_ERROR_OUT_OF_MEMORY, /**< Out of Memory */ + TTSE_ERROR_IO_ERROR = TIZEN_ERROR_IO_ERROR, /**< I/O error */ + TTSE_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */ + TTSE_ERROR_NETWORK_DOWN = TIZEN_ERROR_NETWORK_DOWN, /**< Out of network */ + TTSE_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED, /**< Permission denied */ + TTSE_ERROR_INVALID_STATE = TIZEN_ERROR_TTS | 0x01, /**< Invalid state */ + TTSE_ERROR_INVALID_VOICE = TIZEN_ERROR_TTS | 0x02, /**< Invalid voice */ + TTSE_ERROR_OPERATION_FAILED = TIZEN_ERROR_TTS | 0x04, /**< Operation failed */ + TTSE_ERROR_NOT_SUPPORTED_FEATURE = TIZEN_ERROR_TTS | 0x06, /**< Not supported feature */ + TTSE_ERROR_NOT_SUPPORTED = TIZEN_ERROR_NOT_SUPPORTED /**< Not supported */ } ttse_error_e; + /** -* @brief Enumerations for audio type. +* @brief Enumeration for audio type. * @since_tizen 3.0 */ typedef enum { - TTSE_AUDIO_TYPE_RAW_S16 = 0, /**< Signed 16-bit audio type */ - TTSE_AUDIO_TYPE_RAW_U8, /**< Unsigned 8-bit audio type */ + TTSE_AUDIO_TYPE_RAW_S16 = 0, /**< Signed 16-bit audio type */ + TTSE_AUDIO_TYPE_RAW_U8, /**< Unsigned 8-bit audio type */ TTSE_AUDIO_TYPE_MAX } ttse_audio_type_e; + /** -* @brief Enumerations for result event type. +* @brief Enumeration for result event type. * @since_tizen 3.0 */ typedef enum { - TTSE_RESULT_EVENT_FAIL = -1, /**< Event when the voice synthesis is failed */ - TTSE_RESULT_EVENT_START = 1, /**< Event when the sound data is first data by callback function */ - TTSE_RESULT_EVENT_CONTINUE = 2, /**< Event when the next sound data exist, not first and not last */ - TTSE_RESULT_EVENT_FINISH = 3 /**< Event when the sound data is last data or sound data is only one result */ + TTSE_RESULT_EVENT_FAIL = -1, /**< Event when the voice synthesis is failed */ + TTSE_RESULT_EVENT_START = 1, /**< Event when the sound data is first data by callback function */ + TTSE_RESULT_EVENT_CONTINUE = 2, /**< Event when the next sound data exist, not first and not last */ + TTSE_RESULT_EVENT_FINISH = 3 /**< Event when the sound data is last data or sound data is only one result */ } ttse_result_event_e; + /** -* @brief Definitions for male voice type. +* @brief Definition for male voice type. * @since_tizen 3.0 */ #define TTSE_VOICE_TYPE_MALE 1 + /** -* @brief Definitions for female voice type. +* @brief Definition for female voice type. * @since_tizen 3.0 */ #define TTSE_VOICE_TYPE_FEMALE 2 + /** -* @brief Definitions for child's voice type. +* @brief Definition for child's voice type. * @since_tizen 3.0 */ #define TTSE_VOICE_TYPE_CHILD 3 - /** * @brief Called when TTS engine informs the engine service user about whole supported language and voice type list. * @details This callback function is implemented by the engine service user. Therefore, the engine developer does NOT have to implement this callback function. * @since_tizen 3.0 -* * @remarks This callback function is called by ttse_foreach_supported_voices_cb() to inform the whole supported voice list. -* @a user_data must be transferred from ttse_foreach_supported_voices_cb(). -* +* @a user_data must be transferred from ttse_foreach_supported_voices_cb(). * @param[in] language The language is specified as an ISO 3166 alpha-2 two-letter country code -* followed by ISO 639-1 for the two-letter language code. \n -* For example, "ko_KR" for Korean, "en_US" for American English. +* followed by ISO 639-1 for the two-letter language code. +* For example, "ko_KR" for Korean, "en_US" for American English * @param[in] type The voice type * @param[in] user_data The user data passed from ttse_foreach_supported_voices_cb() -* -* @return @c true to continue with the next iteration of the loop \n @c false to break out of the loop -* +* @return @c true to continue with the next iteration of the loop +* @c false to break out of the loop * @pre ttse_foreach_supported_voices_cb() will invoke this callback function. -* * @see ttse_foreach_supported_voices_cb() */ typedef bool (*ttse_supported_voice_cb)(const char* language, int type, void* user_data); + /** * @brief Called when the engine service user initializes TTS engine. * @since_tizen 3.0 -* * @remarks This callback function is mandatory and must be registered using ttse_main(). -* -* @return 0 on success, otherwise a negative error value +* @return @c 0 on success, +* otherwise a negative error value * @retval #TTSE_ERROR_NONE Successful * @retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTSE_ERROR_INVALID_STATE Already initialized * @retval #TTSE_ERROR_OPERATION_FAILED Operation failure * @retval #TTSE_ERROR_PERMISSION_DENIED Permission denied -* * @see ttse_deinitialize_cb() */ typedef int (*ttse_initialize_cb)(void); + /** * @brief Called when the engine service user deinitializes TTS engine. * @since_tizen 3.0 -* * @remarks This callback function is mandatory and must be registered using ttse_main(). -* NOTE that the engine may be terminated automatically. -* When this callback function is invoked, the release of resources is necessary. -* -* @return 0 on success, otherwise a negative error value +* NOTE that the engine may be terminated automatically. +* When this callback function is invoked, the release of resources is necessary. +* @return @c 0 on success, +* otherwise a negative error value * @retval #TTSE_ERROR_NONE Successful * @retval #TTSE_ERROR_INVALID_STATE Not initialized -* * @see ttse_initialize_cb() */ typedef int (*ttse_deinitialize_cb)(void); + /** * @brief Called when the engine service user gets the whole supported voice list. * @since_tizen 3.0 -* * @remarks This callback function is mandatory and must be registered using ttse_main(). -* In this function, the engine service user's callback function 'ttse_supported_voice_cb()' is invoked repeatedly for getting all supported voices, and @a user_data must be transferred to 'ttse_supported_voice_cb()'. -* If 'ttse_supported_voice_cb()' returns @c false, it should be stopped to call 'ttse_supported_voice_cb()'. -* -* +* In this function, the engine service user's callback function 'ttse_supported_voice_cb()' is invoked repeatedly for getting all supported voices, and @a user_data must be transferred to 'ttse_supported_voice_cb()'. +* If 'ttse_supported_voice_cb()' returns @c false, it should be stopped to call 'ttse_supported_voice_cb()'. * @param[in] callback The callback function * @param[in] user_data The user data which must be passed to ttse_supported_voice_cb() -* -* @return 0 on success, otherwise a negative error value +* @return @c 0 on success, +* otherwise a negative error value * @retval #TTSE_ERROR_NONE Successful * @retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTSE_ERROR_INVALID_STATE Not initialized -* * @post This callback function invokes ttse_supported_voice_cb() repeatedly for getting all supported voices. -* * @see ttse_supported_voice_cb() */ typedef int (*ttse_foreach_supported_voices_cb)(ttse_supported_voice_cb callback, void* user_data); + /** * @brief Called when the engine service user checks whether the voice is valid or not in TTS engine. * @since_tizen 3.0 -* * @remarks This callback function is mandatory and must be registered using ttse_main(). -* * @param[in] language The language is specified as an ISO 3166 alpha-2 two-letter country code -* followed by ISO 639-1 for the two-letter language code. \n -* For example, "ko_KR" for Korean, "en_US" for American English. +* followed by ISO 639-1 for the two-letter language code. +* For example, "ko_KR" for Korean, "en_US" for American English * @param[in] type The voice type -* @param[out] is_valid A variable for checking whether the corresponding voice is valid or not. \n @c true to be valid, @c false to be invalid. -* -* @return 0 on success, otherwise a negative error value +* @param[out] is_valid A variable for checking whether the corresponding voice is valid or not. +* @c true to be valid, +* @c false to be invalid +* @return @c 0 on success, +* otherwise a negative error value * @retval #TTSE_ERROR_NONE Successful * @retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter -* * @see ttse_foreach_supported_voices_cb() */ typedef int (*ttse_is_valid_voice_cb)(const char* language, int type, bool* is_valid); + /** * @brief Called when the engine service user sets the default pitch of TTS engine. * @since_tizen 3.0 -* * @remarks This callback function is mandatory and must be registered using ttse_main(). -* * @param[in] pitch The default pitch -* -* @return 0 on success, otherwise a negative error value +* @return @c 0 on success, +* otherwise a negative error value * @retval #TTSE_ERROR_NONE Successful * @retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTSE_ERROR_INVALID_STATE Not initialized @@ -198,65 +195,62 @@ typedef int (*ttse_is_valid_voice_cb)(const char* language, int type, bool* is_v */ typedef int (*ttse_set_pitch_cb)(int pitch); + /** * @brief Called when the engine service user requests to load the corresponding voice type for the first time. * @since_tizen 3.0 -* * @remarks This callback function is mandatory and must be registered using ttse_main(). -* * @param[in] language The language is specified as an ISO 3166 alpha-2 two-letter country code -* followed by ISO 639-1 for the two-letter language code. \n -* For example, "ko_KR" for Korean, "en_US" for American English. +* followed by ISO 639-1 for the two-letter language code. +* For example, "ko_KR" for Korean, "en_US" for American English * @param[in] type The voice type -* -* @return 0 on success, otherwise a negative error value +* @return @c 0 on success, +* otherwise a negative error value * @retval #TTSE_ERROR_NONE Successful * @retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTSE_ERROR_INVALID_STATE Not initialized * @retval #TTSE_ERROR_OUT_OF_MEMORY Out of memory * @retval #TTSE_ERROR_INVALID_VOICE Invalid voice * @retval #TTSE_ERROR_OPERATION_FAILED Operation failure -* * @see ttse_unload_voice_cb() */ typedef int (*ttse_load_voice_cb)(const char* language, int type); + /** * @brief Called when the engine service user requests to unload the corresponding voice type or to stop using voice. * @since_tizen 3.0 -* * @remarks This callback function is mandatory and must be registered using ttse_main(). -* * @param[in] language The language is specified as an ISO 3166 alpha-2 two-letter country code -* followed by ISO 639-1 for the two-letter language code. \n -* For example, "ko_KR" for Korean, "en_US" for American English. +* followed by ISO 639-1 for the two-letter language code. +* For example, "ko_KR" for Korean, "en_US" for American English * @param[in] type The voice type -* -* @return 0 on success, otherwise a negative error value +* @return @c 0 on success, +* otherwise a negative error value * @retval #TTSE_ERROR_NONE Successful * @retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTSE_ERROR_INVALID_STATE Not initialized * @retval #TTSE_ERROR_INVALID_VOICE Invalid voice * @retval #TTSE_ERROR_OPERATION_FAILED Operation failure -* * @see ttse_load_voice_cb() */ typedef int (*ttse_unload_voice_cb)(const char* language, int type); + /** * @brief Called when the engine service user requests for TTS engine to check whether the application agreed the usage of TTS engine. * @details This callback function is called when the engine service user requests for TTS engine to check the application's agreement about using the engine. -* According to the need, the engine developer can provide some user interfaces to check the agreement. +* According to the need, the engine developer can provide some user interfaces to check the agreement. * @since_tizen 3.0 -* * @remarks This callback function is mandatory and must be registered using ttse_main(). -* If the TTS engine developer wants not to check the agreement, the developer has need to return proper values as @a is_agreed in accordance with the intention. \n @c true if the developer regards that every application agreed the usage of the engine, @c false if the developer regards that every application disagreed. -* NOTE that, however, there may be any legal issue unless the developer checks the agreement. Therefore, we suggest that the engine developers should provide a function to check the agreement. -* +* If the TTS engine developer wants not to check the agreement, the developer has need to return proper values as @a is_agreed in accordance with the intention. @c true if the developer regards that every application agreed the usage of the engine, @c false if the developer regards that every application disagreed. +* NOTE that, however, there may be any legal issue unless the developer checks the agreement. Therefore, we suggest that the engine developers should provide a function to check the agreement. * @param[in] appid The Application ID -* @param[out] is_agreed A variable for checking whether the application agreed to use TTS engine or not. \n @c true to agree, @c false to disagree. -* -* @return 0 on success, otherwise a negative error value +* @param[out] is_agreed A variable for checking whether the application agreed to use TTS engine or not. +* @c true to agree, +* @c false to disagree +* @return @c 0 on success, +* otherwise a negative error value * @retval #TTSE_ERROR_NONE Successful * @retval #TTSE_ERROR_INVALID_STATE Not initialized * @retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter @@ -264,35 +258,34 @@ typedef int (*ttse_unload_voice_cb)(const char* language, int type); */ typedef int (*ttse_check_app_agreed_cb)(const char* appid, bool* is_agreed); + /** * @brief Called when the engine service user checks whether TTS engine needs the application's credential. * @since_tizen 3.0 -* * @remarks This callback function is mandatory and must be registered using ttse_main(). -* -* @return @c true if TTS engine needs the application's credential, otherwise @c false +* @return @c true if TTS engine needs the application's credential, +* otherwise @c false */ typedef bool (*ttse_need_app_credential_cb)(void); + /** * @brief Called when the engine service user starts to synthesize a voice, asynchronously. * @since_tizen 3.0 -* * @remarks This callback function is mandatory and must be registered using ttse_main(). -* In this callback function, TTS engine must transfer the synthesized result and @a user_data to the engine service user using ttse_send_result(). -* Also, if TTS engine needs the application's credential, it can set the credential granted to the application. -* +* In this callback function, TTS engine must transfer the synthesized result and @a user_data to the engine service user using ttse_send_result(). +* Also, if TTS engine needs the application's credential, it can set the credential granted to the application. * @param[in] language The language is specified as an ISO 3166 alpha-2 two-letter country code -* followed by ISO 639-1 for the two-letter language code. \n -* For example, "ko_KR" for Korean, "en_US" for American English. +* followed by ISO 639-1 for the two-letter language code. +* For example, "ko_KR" for Korean, "en_US" for American English * @param[in] type The voice type * @param[in] text Texts * @param[in] speed The speed of speaking * @param[in] appid The Application ID * @param[in] credential The credential granted to the application * @param[in] user_data The user data which must be passed to ttse_send_result() -* -* @return 0 on success, otherwise a negative error value +* @return @c 0 on success, +* otherwise a negative error value * @retval #TTSE_ERROR_NONE Successful * @retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTSE_ERROR_INVALID_STATE Not initialized or already started synthesis @@ -300,90 +293,80 @@ typedef bool (*ttse_need_app_credential_cb)(void); * @retval #TTSE_ERROR_OPERATION_FAILED Operation failure * @retval #TTSE_ERROR_NETWORK_DOWN Out of network * @retval #TTSE_ERROR_PERMISSION_DENIED Permission denied -* * @post This function invokes ttse_send_result(). -* * @see ttse_send_result() * @see ttse_cancel_synthesis_cb() * @see ttse_need_app_credential_cb() */ typedef int (*ttse_start_synthesis_cb)(const char* language, int type, const char* text, int speed, const char* appid, const char* credential, void* user_data); + /** * @brief Called when the engine service user cancels to synthesize a voice. * @since_tizen 3.0 -* * @remarks This callback function is mandatory and must be registered using ttse_main(). -* -* @return 0 on success, otherwise a negative error value +* @return @c 0 on success, +* otherwise a negative error value * @retval #TTSE_ERROR_NONE Successful * @retval #TTSE_ERROR_INVALID_STATE Not initialized or not started synthesis -* * @pre The ttse_start_synthesis_cb() should be performed -* * @see ttse_start_synthesis_cb() */ typedef int (*ttse_cancel_synthesis_cb)(void); + /** * @brief Called when the engine service user requests the basic information of TTS engine. * @since_tizen 3.0 -* * @remarks This callback function is mandatory and must be registered using ttse_main(). -* The allocated @a engine_uuid, @a engine_name, and @a engine_setting will be released internally. -* In order to upload the engine at Tizen Appstore, both a service app and a ui app are necessary. -* Therefore, @a engine_setting must be transferred to the engine service user. -* +* The allocated @a engine_uuid, @a engine_name, and @a engine_setting will be released internally. +* In order to upload the engine at Tizen Appstore, both a service app and a ui app are necessary. +* Therefore, @a engine_setting must be transferred to the engine service user. * @param[out] engine_uuid UUID of engine * @param[out] engine_name Name of engine -* @param[out] engine_setting The engine setting application(ui app)'s app id +* @param[out] engine_setting The engine setting application(ui app)'s app ID * @param[out] use_network The status for using network -* -* @return 0 on success, otherwise a negative error code on failure +* @return @c 0 on success, +* otherwise a negative error code on failure * @retval #TTSE_ERROR_NONE Successful * @retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTSE_ERROR_OPERATION_FAILED Operation failure -* */ typedef int (*ttse_get_info_cb)(char** engine_uuid, char** engine_name, char** engine_setting, bool* use_network); + /** * @brief Called when TTS engine receives the private data from the engine service user. * @details This callback function is called when the engine service user sends the private data to TTS engine. * @since_tizen 3.0 -* * @remarks This callback function is optional and is registered using ttse_set_private_data_set_cb(). -* -* @param[in] key The key field of private data. -* @param[in] data The data field of private data. -* -* @return 0 on success, otherwise a negative error value +* @param[in] key The key field of private data +* @param[in] data The data field of private data +* @return @c 0 on success, +* otherwise a negative error value * @retval #TTSE_ERROR_NONE Successful * @retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTSE_ERROR_OPERATION_FAILED Operation failure * @retval #TTSE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature -* * @see ttse_private_data_requested_cb() * @see ttse_set_private_data_set_cb() */ typedef int (*ttse_private_data_set_cb)(const char* key, const char* data); + /** * @brief Called when TTS engine provides the engine service user with the private data. * @details This callback function is called when the engine service user gets the private data from TTS engine. * @since_tizen 3.0 -* * @remarks This callback function is optional and is registered using ttse_set_private_data_requested_cb(). -* -* @param[out] key The key field of private data. -* @param[out] data The data field of private data. -* -* @return 0 on success, otherwise a negative error value +* @param[out] key The key field of private data +* @param[out] data The data field of private data +* @return @c 0 on success, +* otherwise a negative error value * @retval #TTSE_ERROR_NONE Successful * @retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTSE_ERROR_OPERATION_FAILED Operation failure * @retval #TTSE_ERROR_NOT_SUPPORTED_FEATURE Not supported feature -* * @see ttse_private_data_set_cb() * @see ttse_set_private_data_requested_cb() */ @@ -394,50 +377,45 @@ typedef int (*ttse_private_data_requested_cb)(const char* key, char** data); * @brief A structure for the TTS engine functions. * @details This structure contains essential callback functions for operating TTS engine. * @since_tizen 3.0 -* * @remarks These functions are mandatory for operating TTS engine. Therefore, all functions MUST be implemented. */ typedef struct { - int version; /**< The version of the structure 'ttse_request_callback_s' */ - ttse_get_info_cb get_info; /**< Called when the engine service user requests the basic information of TTS engine */ + int version; /**< The version of the structure 'ttse_request_callback_s' */ + ttse_get_info_cb get_info; /**< Called when the engine service user requests the basic information of TTS engine */ - ttse_initialize_cb initialize; /**< Called when the engine service user initializes TTS engine */ - ttse_deinitialize_cb deinitialize; /**< Called when the engine service user deinitializes TTS engine */ + ttse_initialize_cb initialize; /**< Called when the engine service user initializes TTS engine */ + ttse_deinitialize_cb deinitialize; /**< Called when the engine service user deinitializes TTS engine */ - ttse_foreach_supported_voices_cb foreach_voices; /**< Called when the engine service user gets the whole supported voice list */ - ttse_is_valid_voice_cb is_valid_voice; /**< Called when the engine service user checks whether the voice is valid or not in TTS engine */ - ttse_set_pitch_cb set_pitch; /**< Called when the engine service user sets the default pitch of TTS engine */ + ttse_foreach_supported_voices_cb foreach_voices; /**< Called when the engine service user gets the whole supported voice list */ + ttse_is_valid_voice_cb is_valid_voice; /**< Called when the engine service user checks whether the voice is valid or not in TTS engine */ + ttse_set_pitch_cb set_pitch; /**< Called when the engine service user sets the default pitch of TTS engine */ - ttse_load_voice_cb load_voice; /**< Called when the engine service user requests to load the corresponding voice type for the first time */ - ttse_unload_voice_cb unload_voice; /**< Called when the engine service user requests to unload the corresponding voice type or to stop using voice */ + ttse_load_voice_cb load_voice; /**< Called when the engine service user requests to load the corresponding voice type for the first time */ + ttse_unload_voice_cb unload_voice; /**< Called when the engine service user requests to unload the corresponding voice type or to stop using voice */ - ttse_start_synthesis_cb start_synth; /**< Called when the engine service user starts to synthesize a voice, asynchronously */ - ttse_cancel_synthesis_cb cancel_synth; /**< Called when the engine service user cancels to synthesize a voice */ + ttse_start_synthesis_cb start_synth; /**< Called when the engine service user starts to synthesize a voice, asynchronously */ + ttse_cancel_synthesis_cb cancel_synth; /**< Called when the engine service user cancels to synthesize a voice */ - ttse_check_app_agreed_cb check_app_agreed; /**< Called when the engine service user requests for TTS engine to check whether the application agreed the usage of TTS engine */ - ttse_need_app_credential_cb need_app_credential; /**< Called when the engine service user checks whether TTS engine needs the application's credential */ + ttse_check_app_agreed_cb check_app_agreed; /**< Called when the engine service user requests for TTS engine to check whether the application agreed the usage of TTS engine */ + ttse_need_app_credential_cb need_app_credential; /**< Called when the engine service user checks whether TTS engine needs the application's credential */ } ttse_request_callback_s; + /** * @brief Main function for Text-To-Speech (TTS) engine. * @details This function is the main function for operating TTS engine. -* * @since_tizen 3.0 -* * @remarks The service_app_main() should be used for working the engine after this function. -* * @param[in] argc The argument count(original) * @param[in] argv The argument(original) * @param[in] callback The structure of engine request callback function -* -* @return This function returns zero on success, or negative with error code on failure +* @return This function returns zero on success, +* or negative with error code on failure * @retval #TTSE_ERROR_NONE Successful * @retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTSE_ERROR_OPERATION_FAILED Operation failure * @retval #TTSE_ERROR_NOT_SUPPORTED Not supported -* * @see ttse_request_callback_s -* * @code #include @@ -508,150 +486,136 @@ int main(int argc, char* argv[]) */ int ttse_main(int argc, char** argv, ttse_request_callback_s *callback); + /** * @brief Gets the speed range from Tizen platform. * @since_tizen 3.0 -* * @remarks This API is used when TTS engine wants to get the speed range from Tizen platform. -* * @param[out] min The minimum speed value * @param[out] normal The normal speed value * @param[out] max The maximum speed value -* -* @return 0 on success, otherwise a negative error value +* @return @c 0 on success, +* otherwise a negative error value * @retval #TTSE_ERROR_NONE Successful * @retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTSE_ERROR_NOT_SUPPORTED Not supported * @retval #TTSE_ERROR_OPERATION_FAILED Operation failure -* */ int ttse_get_speed_range(int* min, int* normal, int* max); + /** * @brief Gets the pitch range from Tizen platform. * @since_tizen 3.0 -* * @remarks This API is used when TTS engine wants to get the pitch range from Tizen platform. -* * @param[out] min The minimum pitch value * @param[out] normal The normal pitch value * @param[out] max The maximum pitch value -* -* @return 0 on success, otherwise a negative error value +* @return @c 0 on success, +* otherwise a negative error value * @retval #TTSE_ERROR_NONE Successful * @retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTSE_ERROR_NOT_SUPPORTED Not supported * @retval #TTSE_ERROR_OPERATION_FAILED Operation failure -* */ int ttse_get_pitch_range(int* min, int* normal, int* max); + /** * @brief Sends the synthesized result to the engine service user. * @since_tizen 3.0 -* * @remarks This API is used in ttse_start_synthesis_cb(), when TTS engine sends the synthesized result to the engine service user. -* The synthesized result and @a user_data must be transferred to the engine service user through this function. -* +* The synthesized result and @a user_data must be transferred to the engine service user through this function. * @param[in] event The result event * @param[in] data Result data * @param[in] data_size Result data size * @param[in] audio_type The audio type * @param[in] rate The sample rate * @param[in] user_data The user data passed from ttse_start_synthesis_cb() -* -* @return 0 on success, otherwise a negative error value +* @return @c 0 on success, +* otherwise a negative error value * @retval #TTSE_ERROR_NONE Successful * @retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTSE_ERROR_NOT_SUPPORTED Not supported * @retval #TTSE_ERROR_OPERATION_FAILED Operation failure -* * @pre The ttse_main() function should be invoked before this function is called. -* ttse_start_synthesis_cb() will invoke this function. -* +* ttse_start_synthesis_cb() will invoke this function. * @see ttse_start_synthesis_cb() */ int ttse_send_result(ttse_result_event_e event, const void* data, unsigned int data_size, ttse_audio_type_e audio_type, int rate, void* user_data); + /** * @brief Sends the error to the engine service user. -* @details The following error codes can be delivered.\n -* #TTSE_ERROR_NONE,\n -* #TTSE_ERROR_OUT_OF_MEMORY,\n -* #TTSE_ERROR_IO_ERROR,\n -* #TTSE_ERROR_INVALID_PARAMETER,\n -* #TTSE_ERROR_NETWORK_DOWN,\n -* #TTSE_ERROR_PERMISSION_DENIED,\n -* #TTSE_ERROR_INVALID_STATE,\n -* #TTSE_ERROR_INVALID_VOICE,\n -* #TTSE_ERROR_OPERATION_FAILED,\n -* #TTSE_ERROR_NOT_SUPPORTED_FEATURE,\n -* #TTSE_ERROR_NOT_SUPPORTED.\n -* +* @details The following error codes can be delivered. +* #TTSE_ERROR_NONE, +* #TTSE_ERROR_OUT_OF_MEMORY, +* #TTSE_ERROR_IO_ERROR, +* #TTSE_ERROR_INVALID_PARAMETER, +* #TTSE_ERROR_NETWORK_DOWN, +* #TTSE_ERROR_PERMISSION_DENIED, +* #TTSE_ERROR_INVALID_STATE, +* #TTSE_ERROR_INVALID_VOICE, +* #TTSE_ERROR_OPERATION_FAILED, +* #TTSE_ERROR_NOT_SUPPORTED_FEATURE, +* #TTSE_ERROR_NOT_SUPPORTED. * @since_tizen 3.0 - * @param[in] error The error reason * @param[in] msg The error message -* -* @return 0 on success, otherwise a negative error value +* @return @c 0 on success, +* otherwise a negative error value * @retval #TTSE_ERROR_NONE Successful * @retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTSE_ERROR_NOT_SUPPORTED Not supported * @retval #TTSE_ERROR_OPERATION_FAILED Operation failure -* * @pre The ttse_main() function should be invoked before this function is called. */ int ttse_send_error(ttse_error_e error, const char* msg); + /** * @brief Sets a callback function for setting the private data. * @since_tizen 3.0 -* * @remarks The ttse_private_data_set_cb() function is called when the engine service user sends the private data. -* * @param[in] callback_func ttse_private_data_set event callback function -* -* @return 0 on success, otherwise a negative error value +* @return @c 0 on success, +* otherwise a negative error value * @retval #TTSE_ERROR_NONE Successful * @retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTSE_ERROR_NOT_SUPPORTED Not supported * @retval #TTSE_ERROR_OPERATION_FAILED Operation failure -* * @pre The ttse_main() function should be invoked before this function is called. -* * @see ttse_private_data_set_cb() */ int ttse_set_private_data_set_cb(ttse_private_data_set_cb callback_func); + /** * @brief Sets a callback function for requesting the private data. * @since_tizen 3.0 -* * @remarks The ttse_private_data_requested_cb() function is called when the engine service user gets the private data from TTS engine. -* * @param[in] callback_func ttse_private_data_requested event callback function -* -* @return 0 on success, otherwise a negative error value +* @return @c 0 on success, +* otherwise a negative error value * @retval #TTSE_ERROR_NONE Successful * @retval #TTSE_ERROR_INVALID_PARAMETER Invalid parameter * @retval #TTSE_ERROR_NOT_SUPPORTED Not supported * @retval #TTSE_ERROR_OPERATION_FAILED Operation failure -* * @pre The ttse_main() function should be invoked before this function is called. -* * @see ttse_private_data_requested_cb() */ int ttse_set_private_data_requested_cb(ttse_private_data_requested_cb callback_func); - #ifdef __cplusplus } #endif + /** * @}@} */ + #endif /* __TTSE_H__ */