plugins/dali-feedback.h

   1 #ifndef __FEEDBACK_PLUGIN_H__
   2 #define __FEEDBACK_PLUGIN_H__
   3
   4 //
   5 // Copyright (c) 2014 Samsung Electronics Co., Ltd.
   6 //
   7 // Licensed under the Flora License, Version 1.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://floralicense.org/license/
  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 // EXTERNAL INCLUDES
  21 #if defined(DALI_PROFILE_MOBILE)
  22 #include <dd-haptic.h>
  23 #else
  24 #include <haptic.h>
  25 #endif
  26
  27 // INTERNAL INCLUDES
  28 #include <public-api/adaptor-framework/common/feedback-plugin.h>
  29
  30 namespace Dali
  31 {
  32
  33 namespace Plugin
  34 {
  35
  36 /**
  37  * Plays feedback effects for Dali-Toolkit UI Controls.
  38  */
  39 class DaliFeedback : public Dali::FeedbackPlugin
  40 {
  41
  42 public: // Construction & Destruction
  43
  44   /**
  45    * Constructor
  46    */
  47   DaliFeedback();
  48
  49   /**
  50    * Destructor
  51    */
  52   virtual ~DaliFeedback();
  53
  54 public: // FeedbackPlugin overrides
  55
  56   /**
  57    * @copydoc Dali::Integration::FeedbackPlugin::PlayHaptic()
  58    */
  59   void PlayHaptic( const std::string& filePath );
  60
  61   /**
  62    * @copydoc Dali::FeedbackPlugin::PlayHapticMonotone()
  63    */
  64   void PlayHapticMonotone( unsigned int duration );
  65
  66   /**
  67    * @copydoc Dali::FeedbackPlugin::StopHaptic()
  68    */
  69   void StopHaptic();
  70
  71   /**
  72    * @copydoc Dali::FeedbackPlugin::PlaySound()
  73    */
  74   int PlaySound( const std::string& fileName );
  75
  76   /**
  77    * @copydoc Dali::FeedbackPlugin::StopSound()
  78    */
  79   void StopSound( int handle );
  80
  81   /**
  82    * @copydoc Dali::FeedbackPlugin::PlayFeedbackPattern()
  83    */
  84   void PlayFeedbackPattern( int type, int pattern );
  85
  86 private:
  87
  88   haptic_device_h mDeviceHandle;
  89
  90   bool mHapticInitialized;
  91 };
  92
  93 }  // namespace Plugin
  94
  95 }  // namespace Dali
  96
  97 #endif // __FEEDBACK_PLUGIN_H__