1 #ifndef DALI_SOUND_PLAYER_H
2 #define DALI_SOUND_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>
30 namespace Internal DALI_INTERNAL
36 } // namespace DALI_INTERNAL
39 * @brief Plays sound effects.
41 class DALI_ADAPTOR_API SoundPlayer : public BaseHandle
44 typedef Signal<void(SoundPlayer&)> SoundPlayFinishedSignalType; ///< Sound play finished signal
47 * @brief Create an uninitialized handle.
49 * This can be initialized by calling SoundPlayer::Get().
54 * @brief Create an initialized handle to the SoundPlayer.
56 * @return A handle to a newly allocated Dali resource.
58 static SoundPlayer Get();
63 * This is non-virtual since derived Handle types must not contain data or virtual methods.
68 * @brief Plays a sound file.
70 * @pre The SoundPlayer needs to be initialized.
71 * @param[in] fileName Path to the sound file to play.
72 * @return a handle to the currently playing sound file which can be used to stop.
74 int PlaySound(const std::string fileName);
77 * @brief Stops the currently playing sound.
79 * @pre The SoundPlayer needs to be initialized.
82 void Stop(int handle);
85 * @brief This signal will be emitted after a given sound file is completely played.
87 * @pre The SoundPlayer needs to be initialized.
88 * @return The signal to connect to.
90 * @note The signal name is "soundPlayFinished" if using BaseHandle::ConnectSignal()
92 SoundPlayFinishedSignalType& SoundPlayFinishedSignal();
94 public: // Not intended for application developers
96 * @brief This constructor is used by SoundPlayer::Get().
98 * @param[in] soundPlayer A pointer to the sound player.
100 explicit DALI_INTERNAL SoundPlayer(Internal::Adaptor::SoundPlayer* soundPlayer);
105 #endif // DALI_SOUND_PLAYER_H