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

   1 #ifndef __DALI_HAPTIC_PLAYER_H__
   2 #define __DALI_HAPTIC_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 HapticPlayer;
  32 }
  33 }
  34
  35 /**
  36  * @brief Plays haptic effects.
  37  */
  38 class DALI_IMPORT_API HapticPlayer : public BaseHandle
  39 {
  40 public:
  41
  42   /**
  43    * @brief Create an uninitialized handle.
  44    *
  45    * This can be initialized by calling HapticPlayer::Get().
  46    */
  47   HapticPlayer();
  48
  49   /**
  50    * @brief Create an initialized handle to the HapticPlayer.
  51    *
  52    * @return A handle to a newly allocated Dali resource.
  53    */
  54   static HapticPlayer Get();
  55
  56   /**
  57    * @brief Destructor
  58    *
  59    * This is non-virtual since derived Handle types must not contain data or virtual methods.
  60    */
  61   ~HapticPlayer();
  62
  63   /**
  64    * @brief Plays a monotone vibration.
  65    * @param[in]  duration  The duration of the vibration.
  66    */
  67   void PlayMonotone(unsigned int duration);
  68
  69   /**
  70    * @brief Plays vibration in predefined patterns.
  71    * @param[in] filePath Path to the file containing the effect.
  72    */
  73   void PlayFile(const std::string filePath);
  74
  75   /**
  76    * @brief Stops the currently playing vibration effects.
  77    */
  78   void Stop();
  79
  80 public: // Not intended for application developers
  81
  82   /**
  83    * @brief This constructor is used by HapticPlayer::Get().
  84    * @param[in] hapticPlayer A pointer to the haptic player.
  85    */
  86   explicit DALI_INTERNAL HapticPlayer( Internal::Adaptor::HapticPlayer* hapticPlayer );
  87 };
  88
  89 } // namespace Dali
  90
  91 #endif // __DALI_HAPTIC_PLAYER_H__