include/gesture_internal.h

   1 /*
   2  * Copyright (c) 2020 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef __TIZEN_UIX_GESTURE_INTERNAL_H__
  18 #define __TIZEN_UIX_GESTURE_INTERNAL_H__
  19
  20 #include <gesture_common_internal.h>
  21
  22 #ifdef __cplusplus
  23 extern "C" {
  24 #endif
  25
  26 /**
  27  * @file gesture_internal.h
  28  * @brief This file contains gesture's internal APIs.
  29  */
  30
  31 /**
  32  * @addtogroup CAPI_UIX_GESTURE_MODULE
  33  * @{
  34  */
  35
  36 /**
  37  * @brief Sets the hand type whether right hand or left hand.
  38  *
  39  * @since_tizen @if WEARABLE 6.0 @endif
  40  *
  41  * @param[in] handle     Gesture handle to be used to control the gesture event
  42  * @param[in] hand_type  Hand type using for gesture (right or left)
  43  *
  44  * @return @c 0 on success, otherwise a negative error value
  45  * @retval #HAND_GESTURE_ERROR_NONE               Successful
  46  * @retval #HAND_GESTURE_ERROR_NOT_SUPPORTED      Gesture recognition is not supported
  47  * @retval #HAND_GESTURE_ERROR_INVALID_PARAMETER  Invalid parameter used
  48  * @retval #HAND_GESTURE_ERROR_ALREADY_STARTED    The @c handle is being used already
  49  * @retval #HAND_GESTURE_ERROR_OPERATION_FAILED   Operation failed because of a system error
  50  *
  51  * @see hand_gesture_start_recognition()
  52  */
  53 int hand_gesture_set_handtype(hand_gesture_h handle, hand_gesture_handtype_e hand_type);
  54
  55 /**
  56  * @brief Sets the work mode for gesture recognition.
  57  *
  58  * @since_tizen @if WEARABLE 6.0 @endif
  59  *
  60  * @param[in] handle     Gesture handle to be used to control the gesture event
  61  * @param[in] work_mode  Determining whether to move the hand in one direction or back
  62  *
  63  * @return @c 0 on success, otherwise a negative error value
  64  * @retval #HAND_GESTURE_ERROR_NONE               Successful
  65  * @retval #HAND_GESTURE_ERROR_NOT_SUPPORTED      Gesture recognition is not supported
  66  * @retval #HAND_GESTURE_ERROR_INVALID_PARAMETER  Invalid parameter used
  67  * @retval #HAND_GESTURE_ERROR_ALREADY_STARTED    The @c handle is being used already
  68  * @retval #HAND_GESTURE_ERROR_OPERATION_FAILED   Operation failed because of a system error
  69  *
  70  * @see hand_gesture_start_recognition()
  71  */
  72 int hand_gesture_set_workmode(hand_gesture_h handle, hand_gesture_workmode_e work_mode);
  73
  74 /**
  75  * @brief Sets the sensitivity for gesture recognition.
  76  *
  77  * @since_tizen @if WEARABLE 6.0 @endif
  78  *
  79  * @param[in] handle       Gesture handle to be used to control the gesture event
  80  * @param[in] sensitivity  Set sensitivity for recognizing gesture
  81  *
  82  * @return @c 0 on success, otherwise a negative error value
  83  * @retval #HAND_GESTURE_ERROR_NONE               Successful
  84  * @retval #HAND_GESTURE_ERROR_NOT_SUPPORTED      Gesture recognition is not supported
  85  * @retval #HAND_GESTURE_ERROR_INVALID_PARAMETER  Invalid parameter used
  86  * @retval #HAND_GESTURE_ERROR_ALREADY_STARTED    The @c handle is being used already
  87  * @retval #HAND_GESTURE_ERROR_OPERATION_FAILED   Operation failed because of a system error
  88  *
  89  * @see hand_gesture_start_recognition()
  90  */
  91 int hand_gesture_set_sensitivity(hand_gesture_h handle, int sensitivity);
  92
  93 /**
  94  * @brief Gets the gesture event from the gesture data received.
  95  *
  96  * @since_tizen @if WEARABLE 6.0 @endif
  97  *
  98  * @param[out] data   Gesture data received through a callback function
  99  * @param[out] event  Gesture event data
 100  *
 101  * @return @c 0 on success, otherwise a negative error value
 102  * @retval #HAND_GESTURE_ERROR_NONE               Successful
 103  * @retval #HAND_GESTURE_ERROR_NOT_SUPPORTED      Gesture recognition is not supported
 104  * @retval #HAND_GESTURE_ERROR_INVALID_PARAMETER  Invalid parameter used
 105  * @retval #HAND_GESTURE_ERROR_OPERATION_FAILED   Operation failed because of a system error
 106  */
 107 int hand_gesture_get_event(const hand_gesture_data_h data, hand_gesture_event_e *event);
 108
 109 /**
 110  * @}
 111  */
 112
 113 #ifdef __cplusplus
 114 }
 115 #endif
 116
 117 #endif /* __TIZEN_UIX_GESTURE_INTERNAL_H__ */