diff options
Diffstat (limited to 'include/feedback.h')
| -rw-r--r-- | include/feedback.h | 40 |
1 files changed, 30 insertions, 10 deletions
diff --git a/include/feedback.h b/include/feedback.h index 2012c0c..b676f42 100644 --- a/include/feedback.h +++ b/include/feedback.h @@ -11,7 +11,7 @@ * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and - * limitations under the License. + * limitations under the License. */ @@ -46,7 +46,7 @@ extern "C" { /** * @brief Enumerations of the system pre-defined patterns for feedback interface - * @details + * @details * Each feedback pattern can have separate media files of each types. * But Depending on vendor design, pattern may not have any type of file. * @@ -81,7 +81,7 @@ typedef enum FEEDBACK_ERROR_INVALID_PARAMETER = TIZEN_ERROR_INVALID_PARAMETER, /**< Invalid parameter */ FEEDBACK_ERROR_NOT_INITIALIZED = TIZEN_ERROR_SYSTEM_CLASS | 0x52, /**< Has not yet been Initialized */ FEEDBACK_ERROR_OPERATION_FAILED = TIZEN_ERROR_SYSTEM_CLASS | 0x55, /**< Operation failed */ -} feedback_error_e; +} feedback_error_e; /** * @brief Initializes feedback API. @@ -92,8 +92,8 @@ typedef enum * * @return 0 on success, otherwise a negative error value. * @retval #FEEDBACK_ERROR_NONE Successful - * @retval #FEEDBACK_ERROR_OPERATION_FAILED Operation failed - * + * @retval #FEEDBACK_ERROR_OPERATION_FAILED Operation failed + * * @see feedback_deinitialize() */ int feedback_initialize(void); @@ -103,7 +103,7 @@ int feedback_initialize(void); * * @details This function must be called when feedback functions are no longer needed. * - * @return 0 on success, otherwise a negative error value. + * @return 0 on success, otherwise a negative error value. * @retval #FEEDBACK_ERROR_NONE Successful * @retval #FEEDBACK_ERROR_OPERATION_FAILED Operation failed * @@ -124,7 +124,7 @@ int feedback_deinitialize(void); * For example, when set to silent mode, the device doesn't produce any sound. * * @param[in] pattern The pre-defined pattern - * + * * @return 0 on success, otherwise a negative error value. * @retval #FEEDBACK_ERROR_NONE Successful * @retval #FEEDBACK_ERROR_INVALID_PARAMETER Invalid parameter @@ -132,8 +132,28 @@ int feedback_deinitialize(void); int feedback_play(feedback_pattern_e pattern); /** + * + * @brief Plays specific type of reactions that are pre-defined. + * + * @details + * This function can be used to react to pre-defined actions. \n + * It play specific type of system pre-defined pattern. + * + * @remarks + * Currently, there are two types of reactions: sound and vibration. + * + * @param[in] type The pattern type + * @param[in] pattern The pre-defined pattern + * + * @return 0 on success, otherwise a negative error value. + * @retval #FEEDBACK_ERROR_NONE Successful + * @retval #FEEDBACK_ERROR_INVALID_PARAMETER Invalid parameter + */ +int feedback_play_type(feedback_type_e type, feedback_pattern_e pattern); + +/** * @brief Gets the file path of resource for the given feedback type and pattern. - * + * * @details * Depending on the type of each pattern resouorce has a different format. \n * Currently, System supports two pattern types. \n @@ -146,12 +166,12 @@ int feedback_play(feedback_pattern_e pattern); * @param[in] type The pattern type * @param[in] pattern The pre-defined pattern * @param[out] path The file path of resource for feedback type and pattern - * + * * @return 0 on success, otherwise a negative error value. * @retval #FEEDBACK_ERROR_NONE Successful * @retval #FEEDBACK_ERROR_INVALID_PARAMETER Invalid parameter * @retval #FEEDBACK_ERROR_OPERATION_FAILED Operation failed - * + * */ int feedback_get_resource_path(feedback_type_e type, feedback_pattern_e pattern, char **path); |