1 #ifndef DALI_FEEDBACK_PLAYER_H
2 #define DALI_FEEDBACK_PLAYER_H
5 * Copyright (c) 2020 Samsung Electronics Co., Ltd.
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
11 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 #include <dali/public-api/object/base-handle.h>
25 #include <dali/public-api/dali-adaptor-common.h>
29 namespace Internal DALI_INTERNAL
35 } // namespace DALI_INTERNAL
38 * @brief Plays feedback effects.
40 class DALI_ADAPTOR_API FeedbackPlayer : public BaseHandle
44 * @brief Create an uninitialized handle.
46 * This can be initialized by calling FeedbackPlayer::Get().
51 * @brief Create an initialized handle to the FeedbackPlayer.
53 * @return A handle to a newly allocated Dali resource.
55 static FeedbackPlayer Get();
60 * This is non-virtual since derived Handle types must not contain data or virtual methods.
65 * @brief Plays a monotone vibration.
66 * @param[in] duration The duration of the vibration.
68 void PlayMonotone(unsigned int duration);
71 * @brief Plays vibration in predefined patterns.
72 * @param[in] filePath Path to the file containing the effect.
74 void PlayFile(const std::string filePath);
77 * @brief Stops the currently playing vibration effects.
83 * @param[in] fileName Path to the sound file to play.
84 * @return A handle which can be used to stop the sound playback.
86 int PlaySound(const std::string& fileName);
89 * Stops a currently playing sound.
90 * @param[in] handle A handle to the currently playing sound.
92 void StopSound(int handle);
95 * Plays a feedback pattern.
96 * @param[in] type The type of feedback.
97 * @param[in] pattern The ID of the pattern to play.
99 void PlayFeedbackPattern(int type, int pattern);
102 * Loads a file into data
103 * @param[in] filename The filename.
104 * @param[in] data The data in the file.
105 * @return True if the file data could be loaded
107 bool LoadFile(const std::string& filename, std::string& data);
109 public: // Not intended for application developers
111 * @brief This constructor is used by FeedbackPlayer::Get().
112 * @param[in] feedbackPlayer A pointer to the feedback player.
114 explicit DALI_INTERNAL FeedbackPlayer(Internal::Adaptor::FeedbackPlayer* feedbackPlayer);
119 #endif // DALI_FEEDBACK_PLAYER_H