Fix to save time info and to make directories
[platform/core/uifw/stt.git] / doc / uix_stt_doc.h
index a55cb9a..e58d761 100644 (file)
  * 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>
+ * 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.
  * <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>
  *