inc/FUixSpeechTextToSpeechTypes.h

   1 //
   2 // Open Service Platform
   3 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
   4 //
   5 // Licensed under the Apache License, Version 2.0 (the License);
   6 // you may not use this file except in compliance with the License.
   7 // You may obtain a copy of the License at
   8 //
   9 //     http://www.apache.org/licenses/LICENSE-2.0
  10 //
  11 // Unless required by applicable law or agreed to in writing, software
  12 // distributed under the License is distributed on an "AS IS" BASIS,
  13 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 // See the License for the specific language governing permissions and
  15 // limitations under the License.
  16 //
  17
  18 /**
  19  * @file    FUixSpeechTextToSpeechTypes.h
  20  * @brief   This is the header file for common data types used by the TextToSpeech class.
  21  *
  22  * This header file contains the declarations of the common data types and constants used by the TextToSpeech class.
  23  */
  24
  25 #ifndef _FUIX_SPEECH_TEXT_TO_SPEECH_TYPES_H_
  26 #define _FUIX_SPEECH_TEXT_TO_SPEECH_TYPES_H_
  27
  28 namespace Tizen { namespace Uix { namespace Speech
  29 {
  30
  31 /**
  32  * @enum    TextToSpeechRequestMode
  33  *
  34  * Defines the request mode.
  35  *
  36  * @since 2.0
  37  *
  38  * @see     TextToSpeech::Speak()
  39  */
  40 enum TextToSpeechRequestMode
  41 {
  42     TEXT_TO_SPEECH_REQUEST_MODE_APPEND,     /**< The new request is added at the queue */
  43     TEXT_TO_SPEECH_REQUEST_MODE_REPLACE     /**< All requests in the queue are dropped and replaced by the new request */
  44 };
  45
  46 /**
  47  * @enum    TextToSpeechSpeechRate
  48  *
  49  * Defines the level of the speech rate.
  50  *
  51  * @since 2.0
  52  *
  53  * @see     TextToSpeech::SetSpeechRate()
  54  */
  55 enum TextToSpeechSpeechRate
  56 {
  57     TEXT_TO_SPEECH_SPEECH_RATE_SYSTEM_SETTING,  /**< The speech rate from system setting */
  58     TEXT_TO_SPEECH_SPEECH_RATE_VERY_SLOW,       /**< The very slow speech rate */
  59     TEXT_TO_SPEECH_SPEECH_RATE_SLOW,            /**< The slow speech rate*/
  60     TEXT_TO_SPEECH_SPEECH_RATE_NORMAL,          /**< The normal speech rate */
  61     TEXT_TO_SPEECH_SPEECH_RATE_FAST,            /**< The fast speech rate */
  62     TEXT_TO_SPEECH_SPEECH_RATE_VERY_FAST        /**< The very fast speech rate */
  63 };
  64
  65 /**
  66  * @enum    TextToSpeechStatus
  67  *
  68  * Defines the status of the Text-To-Speech service.
  69  *
  70  * @since 2.0
  71  *
  72  * @see     ITextToSpeechEventListener::OnTextToSpeechStatusChanged()
  73  */
  74 enum TextToSpeechStatus
  75 {
  76     TEXT_TO_SPEECH_STATUS_NONE,         /**< The none status */
  77     TEXT_TO_SPEECH_STATUS_READY,        /**< The ready status */
  78     TEXT_TO_SPEECH_STATUS_SYNTHESIZING, /**< The synthesizing status */
  79     TEXT_TO_SPEECH_STATUS_PLAYING,      /**< The playing status */
  80     TEXT_TO_SPEECH_STATUS_PAUSED        /**< The paused status*/
  81 };
  82
  83 /**
  84  * @enum    TextToSpeechError
  85  *
  86  * Defines the errors that occur in the Text-To-Speech service.
  87  *
  88  * @since 2.0
  89  *
  90  * @see     ITextToSpeechEventListener::OnTextToSpeechErrorOccurred()
  91  */
  92 enum TextToSpeechError
  93 {
  94     TEXT_TO_SPEECH_ERROR_OUT_OF_MEMORY,         /**< The out of memory error */
  95     TEXT_TO_SPEECH_ERROR_IO_ERROR,              /**< The I/O error */
  96     TEXT_TO_SPEECH_ERROR_NETWORK_ERROR,         /**< The network connection error */
  97     TEXT_TO_SPEECH_ERROR_TIME_OUT,              /**< The timeout error */
  98     TEXT_TO_SPEECH_ERROR_SYSTEM_ERROR,          /**< The system error */
  99     TEXT_TO_SPEECH_ERROR_UNSUPPORTED_SERVICE    /**< The unsupported service error */
 100 };
 101
 102 } } } // Tizen::Uix::Speech
 103
 104 #endif