X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=doc%2Fuix_stt_engine_main_doc.h;h=e811d2025a9d77b52e2c2ea1fc9886a8eb92602a;hb=b0430c08184979478ad4360f774d0c17eaed0610;hp=9d91867237ced83308a3bac1202354fdd9c83e0a;hpb=a0f10f8a82016e437f4f8adf8aef288ed2cf9404;p=platform%2Fcore%2Fuifw%2Fstt.git diff --git a/doc/uix_stt_engine_main_doc.h b/doc/uix_stt_engine_main_doc.h index 9d91867..e811d20 100755 --- a/doc/uix_stt_engine_main_doc.h +++ b/doc/uix_stt_engine_main_doc.h @@ -18,25 +18,21 @@ #ifndef __TIZEN_UIX_STT_ENGINE_DOC_H__ #define __TIZEN_UIX_STT_ENGINE_DOC_H__ + /** * @ingroup CAPI_UIX_FRAMEWORK * @defgroup CAPI_UIX_STTE_MODULE STT Engine * @brief The @ref CAPI_UIX_STTE_MODULE APIs provide functions to operate Speech-To-Text Engine. - * - * * @section CAPI_UIX_STTE_MODULE_HEADER Required Header - * \#include - * + * \#include * * @section CAPI_UIX_STTE_MODULE_OVERVIEW Overview * Speech-To-Text Engine (below STTE) is an engine for recording speech and resulting in texts of speech recognition. * Using the @ref CAPI_UIX_STTE_MODULE APIs, STTE developers can provide STTE service users, who want to apply STTE, with functions necessary to operate the engine. * According to the indispensability of STTE services, there are two ways to provide them to the users.
- * * A. Required STTE services
* These services are indispensable to operate STTE. Therefore, the STTE developers MUST implement callback functions corresponding to the required STTE services. * The following is a list of the callback functions.
- * * * * @@ -107,19 +103,16 @@ * * *
FUNCTIONCalled when the engine service user checks whether STT engine needs the application's credential.
- * * The STTE developers can register the above callback functions at a time with using a structure 'stte_request_callback_s' and an API 'stte_main()'. * To operate STTE, the following steps should be used:
* 1. Create a structure 'stte_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, STT framework will handle it as #STTE_ERROR_OPERATION_FAILED.)
+ * If the callback function returns an unstated value, STT framework will handle it as #STTE_ERROR_OPERATION_FAILED.)
* 3. Register callback functions using 'stte_main()'. (The registered callback functions will be called when the STTE service users request the STTE services.)
* 4. Use 'service_app_main()' for working STTE.
- * * B. Optional STTE services
* Unlike the required STTE services, these services are optional to operate STTE. The followings are optional STTE services.
* - receive/provide the private data
- * * If the STTE developers want to provide the above services, use the following APIs and implement the corresponding callback functions:
* * @@ -139,10 +132,8 @@ * *
*
- * * Using the above APIs, the STTE 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 STTE developers can use these APIs when they implement STTE services:
* * @@ -163,18 +154,16 @@ * *
* - * * @section CAPI_UIX_STTE_MODULE_FEATURE Related Features * This API is related with the following features:
- * - http://tizen.org/feature/speech.recognition
- * - http://tizen.org/feature/microphone
- * + * - http://tizen.org/feature/speech.recognition
+ * - http://tizen.org/feature/microphone
* 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_STT_ENGINE_DOC_H__ */