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

   1 #ifndef DALI_TTS_PLAYER_H
   2 #define DALI_TTS_PLAYER_H
   3
   4 /*
   5  * Copyright (c) 2020 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 #include <dali/public-api/signals/dali-signal.h>
  24
  25 // INTERNAL INCLUDES
  26 #include <dali/public-api/dali-adaptor-common.h>
  27
  28 namespace Dali
  29 {
  30 /**
  31  * @addtogroup dali_adaptor_framework
  32  * @{
  33  */
  34
  35 namespace Internal DALI_INTERNAL
  36 {
  37 namespace Adaptor
  38 {
  39 class TtsPlayer;
  40 }
  41 } // namespace DALI_INTERNAL
  42
  43 /**
  44  * @brief The Text-to-speech (TTS) Player.
  45  * @deprecated Instead of this class use Dali::Accessibility::Say() method
  46  * @SINCE_1_0.0
  47  */
  48 class DALI_ADAPTOR_API TtsPlayer : public BaseHandle
  49 {
  50 public: // ENUMs
  51   /**
  52    * @brief Enumeration for the instance of TTS mode.
  53    * @SINCE_1_0.0
  54    */
  55   enum Mode
  56   {
  57     DEFAULT = 0,   ///< Default mode for normal application @SINCE_1_0.0
  58     NOTIFICATION,  ///< Notification mode, such as playing utterance is started or completed @SINCE_1_0.0
  59     SCREEN_READER, ///< Screen reader mode. To help visually impaired users interact with their devices, screen reader reads text or graphic elements on the screen using the TTS engine. @SINCE_1_0.0
  60     MODE_NUM
  61   };
  62
  63   /**
  64    * @brief Enumeration for the instance of TTS state.
  65    * @SINCE_1_0.0
  66    */
  67   enum State
  68   {
  69     UNAVAILABLE = 0, ///< Player is not available @SINCE_1_0.0
  70     READY,           ///< Player is ready to play @SINCE_1_0.0
  71     PLAYING,         ///< Player is playing @SINCE_1_0.0
  72     PAUSED           ///< Player is paused @SINCE_1_0.0
  73   };
  74
  75 public: // Typedefs
  76   /**
  77    * @brief Type of signal emitted when the TTS state changes.
  78    * @SINCE_1_0.0
  79    */
  80   typedef Signal<void(const Dali::TtsPlayer::State, const Dali::TtsPlayer::State)> StateChangedSignalType;
  81
  82 public: // API
  83   /**
  84    * @brief Creates an uninitialized handle.
  85    *
  86    * This can be initialized by calling TtsPlayer::Get().
  87    * @SINCE_1_0.0
  88    */
  89   TtsPlayer();
  90
  91   /**
  92    * @brief Gets the singleton of the TtsPlayer for the given mode.
  93    *
  94    * @SINCE_1_0.0
  95    * @param mode The mode of tts-player
  96    * @return A handle of the Ttsplayer for the given mode
  97    */
  98   static TtsPlayer Get(Dali::TtsPlayer::Mode mode = Dali::TtsPlayer::DEFAULT);
  99
 100   /**
 101    * @brief Destructor.
 102    *
 103    * This is non-virtual since derived Handle types must not contain data or virtual methods.
 104    * @SINCE_1_0.0
 105    */
 106   ~TtsPlayer();
 107
 108   /**
 109    * @brief This copy constructor is required for (smart) pointer semantics.
 110    *
 111    * @SINCE_1_0.0
 112    * @param [in] handle A reference to the copied handle
 113    */
 114   TtsPlayer(const TtsPlayer& handle);
 115
 116   /**
 117    * @brief This assignment operator is required for (smart) pointer semantics.
 118    *
 119    * @SINCE_1_0.0
 120    * @param [in] rhs A reference to the copied handle
 121    * @return A reference to this
 122    */
 123   TtsPlayer& operator=(const TtsPlayer& rhs);
 124
 125   /**
 126    * @brief Move constructor.
 127    *
 128    * @SINCE_1_9.24
 129    * @param[in] rhs A reference to the moved handle
 130    */
 131   TtsPlayer(TtsPlayer&& rhs);
 132
 133   /**
 134    * @brief Move assignment operator.
 135    *
 136    * @SINCE_1_9.24
 137    * @param[in] rhs A reference to the moved handle
 138    * @return A reference to this handle
 139    */
 140   TtsPlayer& operator=(TtsPlayer&& rhs);
 141
 142   /**
 143    * @brief Starts playing the audio data synthesized from the specified text.
 144    *
 145    * @SINCE_1_0.0
 146    * @param[in] text The text to play
 147    * @pre The TtsPlayer needs to be initialized.
 148    */
 149   void Play(const std::string& text);
 150
 151   /**
 152    * @brief Stops playing the utterance.
 153    * @SINCE_1_0.0
 154    * @pre The TtsPlayer needs to be initialized.
 155    */
 156   void Stop();
 157
 158   /**
 159    * @brief Pauses the currently playing utterance.
 160    * @SINCE_1_0.0
 161    * @pre The TtsPlayer needs to be initialized.
 162    */
 163   void Pause();
 164
 165   /**
 166    * @brief Resumes the previously paused utterance.
 167    * @SINCE_1_0.0
 168    * @pre The TtsPlayer needs to be initialized.
 169    */
 170   void Resume();
 171
 172   /**
 173    * @brief Gets the current state of the player.
 174    * @SINCE_1_0.0
 175    * @return The current TTS state
 176    * @pre The TtsPlayer needs to be initialized.
 177    */
 178   State GetState();
 179
 180   /**
 181    * @brief Allows connection TTS state change signal.
 182    * @SINCE_1_0.0
 183    * @return A reference to the signal for connection
 184    * @note Only supported by some adaptor types.
 185    */
 186   Dali::TtsPlayer::StateChangedSignalType& StateChangedSignal();
 187
 188 public: // Not intended for application developers
 189   /// @cond internal
 190   /**
 191    * @brief This constructor is used by TtsPlayer::Get().
 192    * @SINCE_1_0.0
 193    * @param[in] ttsPlayer A pointer to the TTS player
 194    */
 195   explicit DALI_INTERNAL TtsPlayer(Internal::Adaptor::TtsPlayer* ttsPlayer);
 196   /// @endcond
 197 };
 198
 199 /**
 200  * @}
 201  */
 202 } // namespace Dali
 203
 204 #endif // DALI_TTS_PLAYER_H