plugins/dali-feedback.h

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