adaptors/devel-api/adaptor-framework/sound-player.h

   1 #ifndef __DALI_SOUND_PLAYER_H__
   2 #define __DALI_SOUND_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 #include <dali/public-api/signals/dali-signal.h>
  24
  25 namespace Dali
  26 {
  27
  28 namespace Internal DALI_INTERNAL
  29 {
  30 namespace Adaptor
  31 {
  32 class SoundPlayer;
  33 }
  34 }
  35
  36 /**
  37  * @brief Plays sound effects.
  38  */
  39 class DALI_IMPORT_API SoundPlayer : public BaseHandle
  40 {
  41 public:
  42
  43   typedef Signal< void (SoundPlayer&) > SoundPlayFinishedSignalType; ///< Sound play finished signal
  44
  45   /**
  46    * @brief Create an uninitialized handle.
  47    *
  48    * This can be initialized by calling SoundPlayer::Get().
  49    */
  50   SoundPlayer();
  51
  52   /**
  53    * @brief Create an initialized handle to the SoundPlayer.
  54    *
  55    * @return A handle to a newly allocated Dali resource.
  56    */
  57   static SoundPlayer Get();
  58
  59   /**
  60    * @brief Destructor
  61    *
  62    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  63    */
  64   ~SoundPlayer();
  65
  66   /**
  67    * @brief Plays a sound file.
  68    *
  69    * @pre The SoundPlayer needs to be initialized.
  70    * @param[in]  fileName Path to the sound file to play.
  71    * @return a handle to the currently playing sound file which can be used to stop.
  72    */
  73   int PlaySound(const std::string fileName);
  74
  75   /**
  76    * @brief Stops the currently playing sound.
  77    *
  78    * @pre The SoundPlayer needs to be initialized.
  79    * @param[in] handle
  80    */
  81   void Stop(int handle);
  82
  83   /**
  84    * @brief This signal will be emitted after a given sound file is completely played.
  85    *
  86    * @pre The SoundPlayer needs to be initialized.
  87    * @return The signal to connect to.
  88    *
  89    * @note The signal name is "sound-play-finished" if using BaseHandle::ConnectSignal()
  90    */
  91   SoundPlayFinishedSignalType& SoundPlayFinishedSignal();
  92
  93 public: // Not intended for application developers
  94
  95   /**
  96    * @brief This constructor is used by SoundPlayer::Get().
  97    *
  98    * @param[in] soundPlayer A pointer to the sound player.
  99    */
 100   explicit DALI_INTERNAL SoundPlayer( Internal::Adaptor::SoundPlayer* soundPlayer );
 101 };
 102
 103 } // namespace Dali
 104
 105 #endif // __DALI_SOUND_PLAYER_H__