/*
- * Copyright (c) 2011-2014 Samsung Electronics Co., Ltd All Rights Reserved
+ * Copyright (c) 2011-2016 Samsung Electronics Co., Ltd All Rights Reserved
*
* Licensed under the Apache License, Version 2.0 (the License);
* you may not use this file except in compliance with the License.
* distributed under the License is distributed on an AS IS BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
- * limitations under the License.
+ * limitations under the License.
*/
#ifndef __TIZEN_UIX_STT_DOC_H__
#define __TIZEN_UIX_STT_DOC_H__
+
/**
- * @defgroup CAPI_UIX_STT_MODULE STT
* @ingroup CAPI_UIX_FRAMEWORK
+ * @defgroup CAPI_UIX_STT_MODULE STT
* @brief The @ref CAPI_UIX_STT_MODULE API provides functions to recognize the speech.
- *
* @section CAPI_UIX_STT_MODULE_HEADER Required Header
- * \#include <stt.h>
- *
+ * \#include <stt.h>
+ *
* @section CAPI_UIX_STT_MODULE_OVERVIEW Overview
* A main function of Speech-To-Text (below STT) API recognizes sound data recorded by users.
* After choosing a language, applications will start recording and recognizing.
* After recording, the applications will receive the recognized result.
- *
* To use of STT, use the following steps:<br>
* 1. Create a handle <br>
- * 2. Register callback functions for notifications <br>
- * 3. Prepare stt-daemon asynchronously <br>
+ * 2. Register callback functions for notifications <br>
+ * 3. Prepare stt-service asynchronously <br>
* 4. Start recording for recognition <br>
* 5. Stop recording <br>
* 6. Get result after processing <br>
* 7. Destroy a handle <br>
- *
* The STT has a client-server for the service of multi-applications.
- * The STT daemon as a server always works in the background for the STT service.
- * If the daemon is not working, client library will invoke it and client will communicate with it.
- * The daemon has engines and the recorder so client does not have the recorder itself.
- * Only the client request commands to the daemon for the service.
+ * The STT service always works in the background as a server.
+ * If the service is not working, client library will invoke it and client will communicate with it.
+ * The service has engines and the recorder so client does not have the recorder itself.
+ * Only the client request commands to the STT service for using STT.
*
* @section CAPI_STT_MODULE_STATE_DIAGRAM State Diagram
* The following diagram shows the life cycle and the states of the STT.
* @image html capi_uix_stt_state_diagram.png "State diagram"
*
* @section CAPI_STT_MODULE_STATE_TRANSITIONS State Transitions
- *
* <table>
* <tr>
* <th>FUNCTION</th>
* <td>stt_cancel()</td>
* <td>Recording or Processing</td>
* <td>Ready</td>
- * <td>SYNC</td>
+ * <td>ASYNC</td>
* </tr>
* </table>
- *
+ *
* @section CAPI_STT_MODULE_STATE_DEPENDENT_FUNCTION_FUNCTION_CALLS State Dependent Function Calls
* 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.
- *
* <table>
* <tr>
* <th>FUNCTION</th>
* <tr>
* <td>stt_prepare()</td>
* <td>Created</td>
- * <td>This function works asynchronously. If daemon fork is failed, application gets the error callback.</td>
+ * <td>This function works asynchronously. If the STT service fork is failed, application gets the error callback.</td>
* </tr>
* <tr>
* <td>stt_unprepare()</td>
* <td></td>
* </tr>
* <tr>
+ * <td>stt_set_credential()</td>
+ * <td>Created, Ready</td>
+ * <td></td>
+ * </tr>
+ * <tr>
+ * <td>stt_set_private_data()<br>stt_get_private_data()</td>
+ * <td>Ready</td>
+ * <td></td>
+ * </tr>
+ * <tr>
+ * <td>stt_get_error_message()</td>
+ * <td>Created, Ready, Recording, Processing</td>
+ * <td>This function should be called during STT error callback.</td>
+ * </tr>
+ * <tr>
* <td>stt_start()</td>
* <td>Ready</td>
* <td></td>
* <tr>
* <td>stt_foreach_detailed_result()</td>
* <td>Processing</td>
- * <td>This must be called in stt_recognition_result_cb()</td>
+ * <td>This must be called in stt_recognition_result_cb().</td>
* </tr>
* <tr>
* <td>stt_set_recognition_result_cb()<br>stt_unset_recognition_result_cb()<br>
* stt_set_state_changed_cb()<br>stt_unset_state_changed_cb()<br>stt_set_error_cb()<br>stt_unset_error_cb()<br>
- * stt_set_default_language_changed_cb()<br>stt_unset_default_language_changed_cb()
+ * stt_set_default_language_changed_cb()<br>stt_unset_default_language_changed_cb()<br>
+ * stt_set_engine_changed_cb()<br>stt_unset_engine_changed_cb()
* </td>
* <td>Created</td>
- * <td>All callback function should be registered / unregistered in Created state</td>
+ * <td>All callback function should be registered / unregistered in Created state.</td>
* </tr>
* </table>
- *
+ *
* @section CAPI_UIX_STT_MODULE_FEATURE Related Features
* This API is related with the following features:<br>
- * - http://tizen.org/feature/speech.recognition<br>
- * - http://tizen.org/feature/microphone<br>
- *
+ * - http://tizen.org/feature/speech.recognition<br>
+ * - http://tizen.org/feature/microphone<br>
* It is recommended to design feature related codes in your application for reliability.<br>
* 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.<br>
* 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.<br>
- * More details on featuring your application can be found from <a href="../org.tizen.mobile.native.appprogramming/html/ide_sdk_tools/feature_element.htm"><b>Feature Element</b>.</a>
- *
+ * More details on featuring your application can be found from <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element"><b>Feature Element</b>.</a>
*/
+
#endif /* __TIZEN_UIX_STT_DOC_H__ */
projects / platform / core / uifw / stt.git / blobdiff