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