mv_roi_tracker: add description to doc

[Version] : 0.23.18
[Issue type] : bug fix

Change-Id: Ibe3a79b8622fdcf1a69ed275d76739cbd2c8f194
Signed-off-by: Hyunsoo Park <hance.park@samsung.com>

diff --git a/doc/mediavision_doc.h b/doc/mediavision_doc.h
index 4678ceb..3f0f952 100644 (file)
--- a/doc/mediavision_doc.h
+++ b/doc/mediavision_doc.h
@@ -30,7 +30,7 @@
  * * Inference: Image classification, object detection,
  *   face detection, facial landmark detection and face recognition;\n
  * * Training: Face recognition;\n
- *
+ * * Roi Tracker: Tracking Region of interest inside image;\n
  *
  * @defgroup    CAPI_MEDIA_VISION_COMMON_MODULE Media Vision Common
  * @ingroup     CAPI_MEDIA_VISION_MODULE
@@ -467,6 +467,37 @@
  * to delete face data to a given label string.
  *
  * For more details, please refer to test/testsuites/machine_learning/face_recognition/test_face_recognition.cpp
+ *
+ * @defgroup    CAPI_MEDIA_VISION_ROI_TRACKER_MODULE Media Vision Roi tracker
+ * @ingroup     CAPI_MEDIA_VISION_MODULE
+ * @brief Tracking Region of interest inside image.
+ * @section CAPI_MEDIA_VISION_ROI_TRACKER_MODULE_HEADER Required Header
+ *      \#include <mv_roi_tracker.h>
+ *
+ * @section CAPI_MEDIA_VISION_ROI_TRACKER_MODULE_FEATURE Related Features
+ * This API is related with the following features:\n
+ *  - %http://tizen.org/feature/vision.roi_tracking\n
+ *
+ * It is recommended to use features in your application for reliability.\n
+ * You can check if the device supports the related features for this API by using
+ * System Information, and control your application's actions accordingly.\n
+ * To ensure your application is only running on devices with specific
+ * features, please define the features in your manifest file using the manifest
+ * editor in the SDK.\n
+ * More details on using features in your application can be found in
+ * <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element">
+ *   <b>Feature Element</b>.
+ * </a>
+ *
+ * @section CAPI_MEDIA_VISION_ROI_TRACKER_MODULE_OVERVIEW Overview
+ * @ref CAPI_MEDIA_VISION_ROI_TRACKER_MODULE contains #mv_tracker_h handle to perform roi tracking.
+ * Roi Tracker handle should be created with mv_roi_tracker_create() and destroyed with
+ * mv_roi_tracker_destroy(). After creation, #mv_inference_h should be set by
+ * calling mv_roi_tracker_set_coordinate() which sets coordinates of roi.
+ * After setting coordinates, mv_roi_tracker_set_tracker_type() could be called optionally in case of setting other tracker type.
+ * It is set to MV_ROI_TRACKER_TYPE_BALANCE as default.
+ * After setting tracker type, mv_roi_tracker_perform() has to be called to tracking roi of images on #mv_source_h,
+ * and it sets newly generated coordinates to result parameter.
  */
 
 #endif  /* __TIZEN_MEDIAVISION_DOC_H__ */

diff --git a/packaging/capi-media-vision.spec b/packaging/capi-media-vision.spec
index 72f62a8..8de4f60 100644 (file)
--- a/packaging/capi-media-vision.spec
+++ b/packaging/capi-media-vision.spec
@@ -1,6 +1,6 @@
 Name:        capi-media-vision
 Summary:     Media Vision library for Tizen Native API
-Version:     0.23.17
+Version:     0.23.18
 Release:     0
 Group:       Multimedia/Framework
 License:     Apache-2.0 and BSD-3-Clause