• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2021-2023 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef VIBRATOR_AGENT_TYPE_H
17 #define VIBRATOR_AGENT_TYPE_H
18 
19 #ifdef __cplusplus
20 extern "C" {
21 #endif
22 
23 /**
24  * @brief Describes the vibration effect of the vibrator when a user adjusts the timer.
25  *
26  * @since 1
27  */
28 const char *VIBRATOR_TYPE_CLOCK_TIMER = "haptic.clock.timer";
29 
30 /**
31  * @brief Enumerates vibration usages.
32  *
33  * @since 9
34  */
35 typedef enum VibratorUsage {
36     USAGE_UNKNOWN = 0,            /**< Vibration is used for unknown, lowest priority */
37     USAGE_ALARM = 1,              /**< Vibration is used for alarm */
38     USAGE_RING = 2,               /**< Vibration is used for ring */
39     USAGE_NOTIFICATION = 3,       /**< Vibration is used for notification */
40     USAGE_COMMUNICATION = 4,      /**< Vibration is used for communication */
41     USAGE_TOUCH = 5,              /**< Vibration is used for touch */
42     USAGE_MEDIA = 6,              /**< Vibration is used for media */
43     USAGE_PHYSICAL_FEEDBACK = 7,  /**< Vibration is used for physical feedback */
44     USAGE_SIMULATE_REALITY = 8,   /**< Vibration is used for simulate reality */
45     USAGE_MAX = 9
46 } VibratorUsage;
47 
48 /** @} */
49 #ifdef __cplusplus
50 };
51 #endif
52 
53 #endif  // endif VIBRATOR_AGENT_TYPE_H