doc/uix_tts_engine_main_doc.h

   1 /*
   2  * Copyright (c) 2011-2016 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17
  18 #ifndef __TIZEN_UIX_TTS_ENGINE_DOC_H__
  19 #define __TIZEN_UIX_TTS_ENGINE_DOC_H__
  20
  21
  22 /**
  23  * @ingroup CAPI_UIX_FRAMEWORK
  24  * @defgroup CAPI_UIX_TTSE_MODULE TTS Engine
  25  * @brief The @ref CAPI_UIX_TTSE_MODULE APIs provide functions to operate Text-To-Speech Engine.
  26  * @section CAPI_UIX_TTSE_MODULE_HEADER Required Header
  27  * \#include <ttse.h>
  28  *
  29  * @section CAPI_UIX_TTSE_MODULE_OVERVIEW Overview
  30  * Text-To-Speech Engine (below TTSE) is an engine for synthesizing voice from text and playing synthesized sound data.
  31  * 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.
  32  * According to the indispensability of TTSE services, there are two ways to provide them to the users. <br>
  33  * <b>A. Required TTSE services</b> <br>
  34  * These services are indispensable to operate TTSE. Therefore, the TTSE developers MUST implement callback functions corresponding to the required TTSE services.
  35  * The following is a list of the callback functions. <br>
  36  * <table>
  37  * <tr>
  38  * <th>FUNCTION</th>
  39  * <th>DESCRIPTION</th>
  40  * </tr>
  41  * <tr>
  42  * <td>ttse_get_info_cb()</td>
  43  * <td>Called when the engine service user requests the basic information of TTS engine.</td>
  44  * </tr>
  45  * <tr>
  46  * <td>ttse_initialize_cb()</td>
  47  * <td>Called when the engine service user initializes TTS engine.</td>
  48  * </tr>
  49  * <tr>
  50  * <td>ttse_deinitialize_cb()</td>
  51  * <td>Called when the engine service user deinitializes TTS engine.</td>
  52  * </tr>
  53  * <tr>
  54  * <td>ttse_is_valid_voice_cb()</td>
  55  * <td>Called when the engine service user checks whether the voice is valid or not in TTS engine.</td>
  56  * </tr>
  57  * <tr>
  58  * <td>ttse_foreach_supported_voices_cb()</td>
  59  * <td>Called when the engine service user gets the whole supported voice list.</td>
  60  * </tr>
  61  * <tr>
  62  * <td>ttse_set_pitch_cb()</td>
  63  * <td>Called when the engine service user sets the default pitch of TTS engine.</td>
  64  * </tr>
  65  * <tr>
  66  * <td>ttse_load_voice_cb()</td>
  67  * <td>Called when the engine service user requests to load the corresponding voice type for the first time.</td>
  68  * </tr>
  69  * <tr>
  70  * <td>ttse_unload_voice_cb()</td>
  71  * <td>Called when the engine service user requests to unload the corresponding voice type or to stop using voice.</td>
  72  * </tr>
  73  * <tr>
  74  * <td>ttse_start_synthesis_cb()</td>
  75  * <td>Called when the engine service user starts to synthesize a voice, asynchronously.</td>
  76  * </tr>
  77  * <tr>
  78  * <td>ttse_cancel_synthesis_cb()</td>
  79  * <td>Called when the engine service user cancels to synthesize a voice.</td>
  80  * </tr>
  81  * <tr>
  82  * <td>ttse_check_app_agreed_cb()</td>
  83  * <td>Called when the engine service user requests for TTS engine to check whether the application agreed the usage of TTS engine.</td>
  84  * </tr>
  85  * <tr>
  86  * <td>ttse_need_app_credential_cb()</td>
  87  * <td>Called when the engine service user checks whether TTS engine needs the application's credential.</td>
  88  * </tr>
  89  * </table>
  90  * 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()'.
  91  * To operate TTSE, the following steps should be used: <br>
  92  * 1. Create a structure 'ttse_request_callback_s'
  93  * 2. Implement callback functions. (NOTE that the callback functions should return appropriate values in accordance with the instruction.
  94  *    If the callback function returns an unstated value, TTS framework will handle it as #TTSE_ERROR_OPERATION_FAILED.) <br>
  95  * 3. Register callback functions using 'ttse_main()'. (The registered callback functions will be invoked when the TTSE service users request the TTSE services.) <br>
  96  * 4. Use 'service_app_main()' for working TTSE. <br>
  97  * <b>B. Optional TTSE services</b> <br>
  98  * Unlike the required TTSE services, these services are optional to operate TTSE. The followings are optional TTSE services. <br>
  99  * - receive/provide the private data <br>
 100  * If the TTSE developers want to provide the above services, use the following APIs and implement the corresponding callback functions: <br>
 101  * <table>
 102  * <tr>
 103  * <th>FUNCTION</th>
 104  * <th>DESCRIPTION</th>
 105  * <th>CORRESPONDING CALLBACK</th>
 106  * </tr>
 107  * <tr>
 108  * <td>ttse_set_private_data_set_cb()</td>
 109  * <td>Sets a callback function for receiving the private data from the engine service user.</td>
 110  * <td>ttse_private_data_set_cb()</td>
 111  * </tr>
 112  * <tr>
 113  * <td>ttse_set_private_data_requested_cb()</td>
 114  * <td>Sets a callback function for providing the private data to the engine service user.</td>
 115  * <td>ttse_private_data_requested_cb()</td>
 116  * </tr>
 117  * </table>
 118  * Using the above APIs, the TTSE developers can register the optional callback functions respectively.
 119  * (For normal operation, put those APIs before 'service_app_main()' starts.)
 120  * 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: <br>
 121  * <table>
 122  * <tr>
 123  * <th>FUNCTION</th>
 124  * <th>DESCRIPTION</th>
 125  * </tr>
 126  * <tr>
 127  * <td>ttse_get_speed_range()</td>
 128  * <td>Gets the speed range from Tizen platform.</td>
 129  * </tr>
 130  * <tr>
 131  * <td>ttse_get_pitch_range()</td>
 132  * <td>Gets the pitch range from Tizen platform.</td>
 133  * </tr>
 134  * <tr>
 135  * <td>ttse_send_result()</td>
 136  * <td>Sends the synthesized result to the engine service user.</td>
 137  * </tr>
 138  * <tr>
 139  * <td>ttse_send_error()</td>
 140  * <td>Sends the error to the engine service user.</td>
 141  * </tr>
 142  * </table>
 143  *
 144  * @section CAPI_UIX_TTSE_MODULE_FEATURE Related Features
 145  * This API is related with the following features:<br>
 146  * - http://tizen.org/feature/speech.synthesis<br>
 147  * It is recommended to design feature related codes in your application for reliability.<br>
 148  * 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>
 149  * 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>
 150  * 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>
 151  */
 152
 153
 154 #endif /* __TIZEN_UIX_TTS_ENGINE_DOC_H__ */
 155