X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=doc%2Fuix_tts_doc.h;h=c69d451f82274fef519398660d70556b36de0a5c;hb=65251843db39748e4d67cbb0306ed22d4f23382e;hp=03446f65bf01016b6dae4277481437095a689769;hpb=3148014a7511856db9228c211cad9f4e80d103a4;p=platform%2Fcore%2Fuifw%2Ftts.git

diff --git a/doc/uix_tts_doc.h b/doc/uix_tts_doc.h
index 03446f6..c69d451 100644
--- a/doc/uix_tts_doc.h
+++ b/doc/uix_tts_doc.h
@@ -1,5 +1,5 @@
 /*
- * 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.
@@ -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 <tts.h>
+ * \#include <tts.h>
  * 
  * @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:<br>
  * 1. Create a handle <br>
  * 2. Register callback functions for notifications <br> 
@@ -40,11 +39,10 @@
  * 7. Resume the player <br>
  * 8. Stop the player <br>
  * 9. Destroy a handle <br>
- * 
  * 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.
+ * utterance is started and completed, default voice is changed or an error occurred.
  * An application should register callback functions: tts_state_changed_cb(), tts_utterance_started_cb(), 
- * tts_utterance_completed_cb(), tts_default_voice_changed_cb(), tts_error_cb().
+ * tts_utterance_completed_cb(), tts_default_voice_changed_cb(), tts_error_cb(), tts_engine_changed_cb().
  *
  * @section CAPI_UIX_TTS_MODULE_STATE_DIAGRAM State Diagram
  * The following diagram shows the life cycle and the states of the TTS. 
@@ -59,10 +57,9 @@
  * The following table shows previous state and post state of main function. 
  * It can be known what precondition is and which synchronous type is. 
  * 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. 
+ * In case of tts_prepare() function, state doesn't be changed at once, but asynchronously.
  * 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.
  * <table>
  * <tr>
  * <th>FUNCTION</th>
@@ -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.
- * 
  * <table>
  * <tr>
  * <th>FUNCTION</th>
@@ -163,6 +159,21 @@
  * <td></td>
  * </tr>
  * <tr>
+ * <td>tts_set_credential()</td>
+ * <td>Created, Ready</td>
+ * <td></td>
+ * </tr>
+ * <tr>
+ * <td>tts_set_private_data()<br>tts_get_private_data()</td>
+ * <td>Ready</td>
+ * <td></td>
+ * </tr>
+ * <tr>
+ * <td>tts_get_error_message()</td>
+ * <td>Created, Ready, Recording, Processing</td>
+ * <td>This function should be called during TTS error callback.</td>
+ * </tr>
+ * <tr>
  * <td>tts_add_text()</td>
  * <td>Ready, Playing, Paused</td>
  * <td></td>
@@ -193,7 +204,9 @@
  * tts_set_default_voice_changed_cb()<br>
  * tts_unset_default_voice_changed_cb()<br>
  * tts_set_error_cb()<br>
- * tts_unset_error_cb()</td>
+ * tts_unset_error_cb()<br>
+ * tts_set_engine_changed_cb()<br>
+ * tts_unset_engine_changed_cb()</td>
  * <td>Created</td>
  * <td> All callback function should be registered in Created state </td>
  * </tr>
@@ -201,14 +214,13 @@
  * 
  * @section CAPI_UIX_TTS_MODULE_FEATURE Related Features
  * This API is related with the following features:<br>
- *  - http://tizen.org/feature/speech.synthesis<br>
- *
+ * - http://tizen.org/feature/speech.synthesis<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="https://developer.tizen.org/development/tools/native-tools/manifest-text-editor#feature"><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_TTS_DOC_H__ */