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