include/feedback-ids.h

   1 /*
   2  * libfeedback
   3  * Copyright (c) 2012 Samsung Electronics Co., Ltd.
   4  *
   5  * Licensed under the Apache License, Version 2.0 (the License);
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *     http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  */
  17
  18
  19 #ifndef __FEEDBACK_IDS_H__
  20 #define __FEEDBACK_IDS_H__
  21
  22 #ifdef __cplusplus
  23 extern "C" {
  24 #endif
  25
  26 /**
  27  * @file feedback-ids.h
  28  * @brief This file contains the feedback API
  29  */
  30
  31 /**
  32  * @addtogroup CAPI_FEEDBACK_MODULE
  33  * @{
  34  */
  35
  36 /**
  37  * @brief Enumerations of the type for feedback interface
  38  * @details
  39  *
  40  */
  41 typedef enum
  42 {
  43         FEEDBACK_TYPE_NONE,
  44         FEEDBACK_TYPE_SOUND,
  45         FEEDBACK_TYPE_VIBRATION,
  46         FEEDBACK_TYPE_LED,
  47         FEEDBACK_TYPE_END
  48 } feedback_type_e;
  49
  50 /**
  51  * @brief Enumerations of the system pre-defined patterns for feedback interface
  52  * @details
  53  * Each feedback pattern can have separate media files of each types.
  54  * But Depending on vendor design, pattern may not have any type of file.
  55  *
  56  */
  57 typedef enum
  58 {
  59         FEEDBACK_PATTERN_NONE = -1,
  60
  61         FEEDBACK_PATTERN_TAP = 0,                       /**< feedback pattern when general touch */
  62         FEEDBACK_PATTERN_SIP,                           /**< feedback pattern when touch text key */
  63         FEEDBACK_PATTERN_SIP_BACKSPACE,                 /**< feedback pattern when touch backspace key */
  64         FEEDBACK_PATTERN_SIP_FUNCTION,                  /**< feedback pattern when touch function key */
  65         FEEDBACK_PATTERN_SIP_FJKEY,                     /**< feedback pattern when touch F,J key */
  66         FEEDBACK_PATTERN_MAX_CHARACTER,                 /**< feedback pattern when max character */
  67         FEEDBACK_PATTERN_KEY0,                          /**< feedback pattern when touch numeric 0 key */
  68         FEEDBACK_PATTERN_KEY1,                          /**< feedback pattern when touch numeric 1 key */
  69         FEEDBACK_PATTERN_KEY2,                          /**< feedback pattern when touch numeric 2 key */
  70         FEEDBACK_PATTERN_KEY3,                          /**< feedback pattern when touch numeric 3 key */
  71         FEEDBACK_PATTERN_KEY4,                          /**< feedback pattern when touch numeric 4 key */
  72         FEEDBACK_PATTERN_KEY5,                          /**< feedback pattern when touch numeric 5 key */
  73         FEEDBACK_PATTERN_KEY6,                          /**< feedback pattern when touch numeric 6 key */
  74         FEEDBACK_PATTERN_KEY7,                          /**< feedback pattern when touch numeric 7 key */
  75         FEEDBACK_PATTERN_KEY8,                          /**< feedback pattern when touch numeric 8 key */
  76         FEEDBACK_PATTERN_KEY9,                          /**< feedback pattern when touch numeric 9 key */
  77         FEEDBACK_PATTERN_KEY_STAR,                      /**< feedback pattern when touch star key */
  78         FEEDBACK_PATTERN_KEY_SHARP,                     /**< feedback pattern when touch sharp key */
  79         FEEDBACK_PATTERN_KEY_BACK,                      /**< feedback pattern when touch backspace key */
  80         FEEDBACK_PATTERN_HOLD,                          /**< feedback pattern when touch hold */
  81         FEEDBACK_PATTERN_MULTI_TAP,                     /**< feedback pattern when multi touch */
  82         FEEDBACK_PATTERN_HW_TAP,                        /**< feedback pattern when press hardware key */
  83         FEEDBACK_PATTERN_HW_HOLD,                       /**< feedback pattern when holding press hardware key */
  84
  85         FEEDBACK_PATTERN_MESSAGE,                       /**< feedback pattern when incoming a message */
  86         FEEDBACK_PATTERN_MESSAGE_ON_CALL,               /**< feedback pattern when incoming a message on call */
  87         FEEDBACK_PATTERN_EMAIL,                         /**< feedback pattern when incoming an email */
  88         FEEDBACK_PATTERN_EMAIL_ON_CALL,                 /**< feedback pattern when incoming an email on call */
  89         FEEDBACK_PATTERN_WAKEUP,                        /**< feedback pattern when alert wake up call */
  90         FEEDBACK_PATTERN_WAKEUP_ON_CALL,                /**< feedback pattern when alert wake up call on call */
  91         FEEDBACK_PATTERN_SCHEDULE,                      /**< feedback pattern when alert schedule alarm */
  92         FEEDBACK_PATTERN_SCHEDULE_ON_CALL,              /**< feedback pattern when alert schedule alarm on call */
  93         FEEDBACK_PATTERN_TIMER,                         /**< feedback pattern when alert timer */
  94         FEEDBACK_PATTERN_TIMER_ON_CALL,                 /**< feedback pattern when alert timer on call */
  95         FEEDBACK_PATTERN_GENERAL,                       /**< feedback pattern when alert general event */
  96         FEEDBACK_PATTERN_GENERAL_ON_CALL,               /**< feedback pattern when alert general event on call */
  97         FEEDBACK_PATTERN_SMART_ALERT,                   /**< feedback pattern when alert noti on motion */
  98
  99         FEEDBACK_PATTERN_POWERON,               /**< feedback pattern when power on */
 100         FEEDBACK_PATTERN_POWEROFF,              /**< feedback pattern when power off */
 101         FEEDBACK_PATTERN_CHARGERCONN,           /**< feedback pattern when connecting charger */
 102         FEEDBACK_PATTERN_CHARGERCONN_ON_CALL,   /**< feedback pattern when connecting charger on call */
 103         FEEDBACK_PATTERN_CHARGING_ERROR,        /**< feedback pattern when occuring charging error */
 104         FEEDBACK_PATTERN_CHARGING_ERROR_ON_CALL,/**< feedback pattern when occuring charging error on call */
 105         FEEDBACK_PATTERN_FULLCHARGED,           /**< feedback pattern when full charged */
 106         FEEDBACK_PATTERN_FULLCHARGED_ON_CALL,   /**< feedback pattern when full charged on call */
 107         FEEDBACK_PATTERN_LOWBATT,               /**< feedback pattern when low battery */
 108         FEEDBACK_PATTERN_LOWBATT_ON_CALL,       /**< feedback pattern when low battery on call */
 109         FEEDBACK_PATTERN_LOCK,                  /**< feedback pattern when lock */
 110         FEEDBACK_PATTERN_UNLOCK,                /**< feedback pattern when unlock */
 111         FEEDBACK_PATTERN_LOCK_SWIPE,            /**< feedback pattern when lock swipe */
 112         FEEDBACK_PATTERN_UNLOCK_SWIPE,          /**< feedback pattern when unlock swipe*/
 113         FEEDBACK_PATTERN_GEOMETRIC_LOCK,        /**< feedback pattern when lock by geometric effect */
 114         FEEDBACK_PATTERN_CALLCONNECT,           /**< feedback pattern when connecting call */
 115         FEEDBACK_PATTERN_DISCALLCONNECT,        /**< feedback pattern when disconnecting call */
 116         FEEDBACK_PATTERN_OUTGOING_CALL,         /**< feedback pattern when connected outgoing call */
 117         FEEDBACK_PATTERN_MINUTEMINDER,          /**< feedback pattern when minute minder */
 118         FEEDBACK_PATTERN_VIBRATION_ON,          /**< feedback pattern when turn on vibration mode */
 119         FEEDBACK_PATTERN_SILENT_OFF,            /**< feedback pattern when turn off silent mode */
 120         FEEDBACK_PATTERN_BT_CONNECTED,          /**< feedback pattern when connecting with bluetooth */
 121         FEEDBACK_PATTERN_BT_DISCONNECTED,       /**< feedback pattern when disconnecting with bluetooth */
 122         FEEDBACK_PATTERN_BT_PAIRING,            /**< feedback pattern when starting pare with bluetooth */
 123         FEEDBACK_PATTERN_BT_WAITING,            /**< feedback pattern when pairing bluetooth */
 124         FEEDBACK_PATTERN_SCREEN_CAPTURE,        /**< feedback pattern when screen capture */
 125         FEEDBACK_PATTERN_LIST_REORDER,          /**< feedback pattern when list reorder */
 126         FEEDBACK_PATTERN_LIST_SLIDER,           /**< feedback pattern when list slider sweep */
 127         FEEDBACK_PATTERN_VOLUME_KEY,            /**< feedback pattern when pressed volume key */
 128         FEEDBACK_PATTERN_MMS,                   /**< feedback pattern when message state changed to MMS */
 129         FEEDBACK_PATTERN_HOURLY_ALERT,          /**< feedback pattern when alert every hour on the hour */
 130
 131         FEEDBACK_PATTERN_SAFETY_ALERT,          /**< feedback pattern when safety alert from phone */
 132         FEEDBACK_PATTERN_ACCIDENT_DETECT,       /**< feedback pattern when accident detect */
 133         FEEDBACK_PATTERN_SEND_SOS_MESSAGE,      /**< feedback pattern when sending SOS message */
 134         FEEDBACK_PATTERN_END_SOS_MESSAGE,       /**< feedback pattern when finishing SOS message */
 135         FEEDBACK_PATTERN_EMERGENCY_BUZZER,      /**< feedback pattern when occurs emergency buzzer */
 136         FEEDBACK_PATTERN_SAFETY_LOW_POWER,      /**< this pattern is a low power ringtone */
 137         FEEDBACK_PATTERN_CMAS,                  /**< feedback pattern when alerting commercial mobile */
 138         FEEDBACK_PATTERN_SPEED_UP,              /**< feedback pattern when advising user to speed up */
 139         FEEDBACK_PATTERN_SLOW_DOWN,             /**< feedback pattern when advising user to slow down */
 140         FEEDBACK_PATTERN_KEEP_THIS_PACE,        /**< feedback pattern when advising user to keep this pace */
 141         FEEDBACK_PATTERN_GOAL_ACHIEVED,         /**< feedback pattern when alerting goal achieved */
 142         FEEDBACK_PATTERN_EXERCISE_COUNT,        /**< feedback pattern when changing count number */
 143         FEEDBACK_PATTERN_START_CUE,             /**< feedback pattern when starting cue */
 144         FEEDBACK_PATTERN_HEALTH_PACE,           /**< feedback pattern when alerting health pace */
 145         FEEDBACK_PATTERN_INACTIVE_TIME,         /**< feedback pattern when alerting inactive time */
 146         FEEDBACK_PATTERN_MEASURING_SUCCESS,     /**< feedback pattern when measuring is succeeded */
 147         FEEDBACK_PATTERN_MEASURING_FAILURE,     /**< feedback pattern when measuring is failed */
 148         FEEDBACK_PATTERN_UV_PROCESSING,         /**< feedback pattern when UV is processing */
 149         FEEDBACK_PATTERN_SHEALTH_START,         /**< feedback pattern when starting s-health */
 150         FEEDBACK_PATTERN_SHEALTH_PAUSE,         /**< feedback pattern when pausing s-health */
 151         FEEDBACK_PATTERN_SHEALTH_STOP,          /**< feedback pattern when stoping s-health */
 152         FEEDBACK_PATTERN_3RD_APPLICATION,       /**< feedback pattern when alert 3rd event */
 153
 154         FEEDBACK_PATTERN_END,
 155
 156         /* START : Will be removed */
 157         FEEDBACK_PATTERN_TOUCH_TAP = FEEDBACK_PATTERN_TAP,
 158         FEEDBACK_PATTERN_TOUCH_MULTI_TAP = FEEDBACK_PATTERN_MULTI_TAP,
 159         FEEDBACK_PATTERN_TOUCH_KEY = FEEDBACK_PATTERN_KEY0,
 160         FEEDBACK_PATTERN_TOUCH_HOLD = FEEDBACK_PATTERN_HOLD,
 161         FEEDBACK_PATTERN_REACTIVE_ALERT = FEEDBACK_PATTERN_SMART_ALERT,
 162         FEEDBACK_PATTERN_VIBRATION = FEEDBACK_PATTERN_VIBRATION_ON,
 163         FEEDBACK_PATTERN_SOUND_ON = FEEDBACK_PATTERN_SILENT_OFF,
 164         FEEDBACK_PATTERN_SHUTTER = FEEDBACK_PATTERN_SCREEN_CAPTURE,
 165         FEEDBACK_PATTERN_SLIDER_SWEEP = FEEDBACK_PATTERN_LIST_SLIDER,
 166         FEEDBACK_PATTERN_SAFETY_ASSISTANCE = FEEDBACK_PATTERN_SEND_SOS_MESSAGE,
 167         FEEDBACK_PATTERN_BT_PARING = FEEDBACK_PATTERN_BT_PAIRING,
 168         FEEDBACK_PATTERN_CONNECTED = FEEDBACK_PATTERN_BT_CONNECTED,
 169         FEEDBACK_PATTERN_DISCONNECTED = FEEDBACK_PATTERN_BT_DISCONNECTED,
 170         FEEDBACK_PATTERN_SUCCESS = FEEDBACK_PATTERN_MEASURING_SUCCESS,
 171         FEEDBACK_PATTERN_FAILURE = FEEDBACK_PATTERN_MEASURING_FAILURE,
 172         /* END : Will be removed */
 173
 174 } feedback_pattern_e;
 175
 176 /**
 177  * @}
 178  */
 179
 180 #ifdef __cplusplus
 181 }
 182 #endif
 183
 184 #endif //__FEEDBACK_IDS_H__