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