inc/FUixSpeechSpeechToTextTypes.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    FUixSpeechSpeechToTextTypes.h
  20  * @brief   This is the header file for the common data types used by the SpeechToText class.
  21  *
  22  * This header file contains the declarations of the common data types and constants used by the SpeechToText class.
  23  */
  24
  25 #ifndef _FUIX_SPEECH_SPEECH_TO_TEXT_TYPES_H_
  26 #define _FUIX_SPEECH_SPEECH_TO_TEXT_TYPES_H_
  27
  28 namespace Tizen { namespace Uix { namespace Speech
  29 {
  30
  31 /**
  32 * @enum SpeechToTextStatus
  33 *
  34 * Defines the %SpeechToText status.
  35 *
  36 * @since 2.0
  37 *
  38 * @see ISpeechToTextEventListener::OnSpeechToTextStatusChanged()
  39 */
  40 enum SpeechToTextStatus
  41 {
  42     SPEECH_TO_TEXT_STATUS_NONE,         /**< The none status */
  43     SPEECH_TO_TEXT_STATUS_READY,        /**< The ready status */
  44     SPEECH_TO_TEXT_STATUS_RECORDING,    /**< The recording status */
  45     SPEECH_TO_TEXT_STATUS_PROCESSING    /**< The recognition processing status */
  46 };
  47
  48 /**
  49 * @enum SpeechToTextGrammar
  50 *
  51 * Defines the %SpeechToText grammar.
  52 *
  53 * @since 2.0
  54 *
  55 * @see SetGrammar()
  56 */
  57 enum SpeechToTextGrammar
  58 {
  59     SPEECH_TO_TEXT_GRAMMAR_FREE,        /**< The key is used for general purpose dictation */
  60     SPEECH_TO_TEXT_GRAMMAR_WEB_SEARCH   /**< The key is used for recognizing short phrases such as the ones used for %Web search */
  61 };
  62
  63 /**
  64 * @enum SpeechToTextError
  65 *
  66 * Defines the errors in %SpeechToText. @n
  67 * When an error occurs, the user can not receive any %SpeechToText result.
  68 *
  69 * @since 2.0
  70 *
  71 * @see ISpeechToTextEventListener::OnSpeechToTextErrorOccurred()
  72 */
  73 enum SpeechToTextError
  74 {
  75     SPEECH_TO_TEXT_ERROR_OUT_OF_MEMORY,         /**< The out of memory error */
  76     SPEECH_TO_TEXT_ERROR_IO_ERROR,              /**< The I/O error */
  77     SPEECH_TO_TEXT_ERROR_NETWORK_ERROR,         /**< The network connection error */
  78     SPEECH_TO_TEXT_ERROR_TIME_OUT,              /**< The timeout error */
  79     SPEECH_TO_TEXT_ERROR_SYSTEM_ERROR,          /**< The system error */
  80     SPEECH_TO_TEXT_ERROR_UNSUPPORTED_SERVICE    /**< The unsupported service error */
  81 };
  82
  83 } } } // Tizen::Uix::Speech
  84
  85 #endif