adaptors/public-api/adaptor-framework/tts-player.h

   1 #ifndef __DALI_TTS_PLAYER_H__
   2 #define __DALI_TTS_PLAYER_H__
   3
   4 /*
   5  * Copyright (c) 2015 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  */
  20
  21 // EXTERNAL INCLUDES
  22 #include <dali/public-api/object/base-handle.h>
  23
  24 namespace Dali
  25 {
  26
  27 namespace Internal DALI_INTERNAL
  28 {
  29 namespace Adaptor
  30 {
  31 class TtsPlayer;
  32 }
  33 }
  34
  35 /**
  36  * @brief The Text-to-speech Player.
  37  */
  38 class DALI_IMPORT_API TtsPlayer : public BaseHandle
  39 {
  40 public: // ENUMs
  41
  42   /**
  43    * @brief Enumeration of TTS mode.
  44    */
  45   enum Mode
  46   {
  47     DEFAULT = 0,  ///< Default mode for normal application
  48     NOTIFICATION, ///< Notification mode
  49     SCREEN_READER, ///< Screen reader mode
  50     MODE_NUM
  51   };
  52
  53 public: // API
  54
  55   /**
  56    * @brief Create an uninitialized handle.
  57    *
  58    * This can be initialized by calling TtsPlayer::Get().
  59    */
  60   TtsPlayer();
  61
  62   /**
  63    * @brief Gets the singleton of the TtsPlayer for the given mode.
  64    *
  65    * @param mode the mode of tts-player
  66    * @return A handle of the Ttsplayer for the given mode.
  67    */
  68   static TtsPlayer Get(Dali::TtsPlayer::Mode mode = Dali::TtsPlayer::DEFAULT);
  69
  70   /**
  71    * @brief Destructor
  72    *
  73    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  74    */
  75   ~TtsPlayer();
  76
  77   /**
  78    * @brief This copy constructor is required for (smart) pointer semantics.
  79    *
  80    * @param [in] handle A reference to the copied handle
  81    */
  82   TtsPlayer(const TtsPlayer& handle);
  83
  84   /**
  85    * @brief This assignment operator is required for (smart) pointer semantics.
  86    *
  87    * @param [in] rhs  A reference to the copied handle
  88    * @return A reference to this
  89    */
  90   TtsPlayer& operator=(const TtsPlayer& rhs);
  91
  92   /**
  93    * @brief Start playing the audio data synthesized from the specified text.
  94    *
  95    * @pre The TtsPlayer needs to be initialized.
  96    * @param[in] text to play.
  97    */
  98   void Play(const std::string& text);
  99
 100   /**
 101    * @brief Stops playing the utterance.
 102    * @pre The TtsPlayer needs to be initialized.
 103    */
 104   void Stop();
 105
 106   /**
 107    * @brief Pauses the currently playing utterance.
 108    * @pre The TtsPlayer needs to be initialized.
 109    */
 110   void Pause();
 111
 112   /**
 113    * @brief Resumes the previously paused utterance.
 114    * @pre The TtsPlayer needs to be initialized.
 115    */
 116   void Resume();
 117
 118 public: // Not intended for application developers
 119
 120   /**
 121    * @brief This constructor is used by TtsPlayer::Get().
 122    * @param[in] ttsPlayer A pointer to the TTS player.
 123    */
 124   explicit DALI_INTERNAL TtsPlayer( Internal::Adaptor::TtsPlayer* ttsPlayer );
 125 };
 126
 127 } // namespace Dali
 128
 129 #endif // __DALI_TTS_PLAYER_H__