1 #ifndef DALI_TTS_PLAYER_H
2 #define DALI_TTS_PLAYER_H
5 * Copyright (c) 2020 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/public-api/object/base-handle.h>
23 #include <dali/public-api/signals/dali-signal.h>
26 #include <dali/public-api/dali-adaptor-common.h>
31 * @addtogroup dali_adaptor_framework
35 namespace Internal DALI_INTERNAL
41 } // namespace DALI_INTERNAL
44 * @brief The Text-to-speech (TTS) Player.
47 class DALI_ADAPTOR_API TtsPlayer : public BaseHandle
51 * @brief Enumeration for the instance of TTS mode.
56 DEFAULT = 0, ///< Default mode for normal application @SINCE_1_0.0
57 NOTIFICATION, ///< Notification mode, such as playing utterance is started or completed @SINCE_1_0.0
58 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
63 * @brief Enumeration for the instance of TTS state.
68 UNAVAILABLE = 0, ///< Player is not available @SINCE_1_0.0
69 READY, ///< Player is ready to play @SINCE_1_0.0
70 PLAYING, ///< Player is playing @SINCE_1_0.0
71 PAUSED ///< Player is paused @SINCE_1_0.0
76 * @brief Type of signal emitted when the TTS state changes.
79 typedef Signal<void(const Dali::TtsPlayer::State, const Dali::TtsPlayer::State)> StateChangedSignalType;
83 * @brief Creates an uninitialized handle.
85 * This can be initialized by calling TtsPlayer::Get().
91 * @brief Gets the singleton of the TtsPlayer for the given mode.
94 * @param mode The mode of tts-player
95 * @return A handle of the Ttsplayer for the given mode
97 static TtsPlayer Get(Dali::TtsPlayer::Mode mode = Dali::TtsPlayer::DEFAULT);
102 * This is non-virtual since derived Handle types must not contain data or virtual methods.
108 * @brief This copy constructor is required for (smart) pointer semantics.
111 * @param [in] handle A reference to the copied handle
113 TtsPlayer(const TtsPlayer& handle);
116 * @brief This assignment operator is required for (smart) pointer semantics.
119 * @param [in] rhs A reference to the copied handle
120 * @return A reference to this
122 TtsPlayer& operator=(const TtsPlayer& rhs);
125 * @brief Move constructor.
128 * @param[in] rhs A reference to the moved handle
130 TtsPlayer(TtsPlayer&& rhs);
133 * @brief Move assignment operator.
136 * @param[in] rhs A reference to the moved handle
137 * @return A reference to this handle
139 TtsPlayer& operator=(TtsPlayer&& rhs);
142 * @brief Starts playing the audio data synthesized from the specified text.
145 * @param[in] text The text to play
146 * @pre The TtsPlayer needs to be initialized.
148 void Play(const std::string& text);
151 * @brief Stops playing the utterance.
153 * @pre The TtsPlayer needs to be initialized.
158 * @brief Pauses the currently playing utterance.
160 * @pre The TtsPlayer needs to be initialized.
165 * @brief Resumes the previously paused utterance.
167 * @pre The TtsPlayer needs to be initialized.
172 * @brief Gets the current state of the player.
174 * @return The current TTS state
175 * @pre The TtsPlayer needs to be initialized.
180 * @brief Allows connection TTS state change signal.
182 * @return A reference to the signal for connection
183 * @note Only supported by some adaptor types.
185 Dali::TtsPlayer::StateChangedSignalType& StateChangedSignal();
187 public: // Not intended for application developers
190 * @brief This constructor is used by TtsPlayer::Get().
192 * @param[in] ttsPlayer A pointer to the TTS player
194 explicit DALI_INTERNAL TtsPlayer(Internal::Adaptor::TtsPlayer* ttsPlayer);
203 #endif // DALI_TTS_PLAYER_H