[ACR-1820] Deprecate low usability fields
[platform/core/api/media-content.git] / include / media_image.h
index 8e8ff9a..8041193 100755 (executable)
@@ -28,11 +28,11 @@ extern "C" {
 /**
  * @brief This file contains the image metadata API and related functions to proceed with them.
  *        Functions include cloning and destroying the image metadata, getting image metadata such as width, height, \n
- *        orientation, date taken, title, burst shot id and updating image to DB.
+ *        orientation, date taken.
  */
 
 /**
- * @addtogroup CAPI_CONTENT_MEDIA_IMAGE_MODULE
+ * @addtogroup CAPI_CONTENT_MEDIA_IMAGE_META_MODULE
  * @{
  */
 
@@ -41,7 +41,7 @@ extern "C" {
  * @brief Clones the image metadata.
  * @details The function copies the image metadata handle from a source to destination.
  *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @remarks The @a dst should be released using image_meta_destroy().
  *
@@ -62,10 +62,10 @@ int image_meta_clone(image_meta_h *dst, image_meta_h src);
 /**
  * @brief Destroys the image metadata.
  * @details The function frees all resources related to the image metadata handle. This handle
- *          no longer can be used to perform any operation. A new handle has to
+ *          no longer can be used to perform any operations. A new handle has to
  *          be created before next usage.
  *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] image The handle to the image metadata
  *
@@ -83,7 +83,7 @@ int image_meta_destroy(image_meta_h image);
 
 /**
  * @brief Gets the ID of an image.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @remarks The @a media_id should be released using free().
  *
@@ -101,7 +101,7 @@ int image_meta_get_media_id(image_meta_h image, char **media_id);
 
 /**
  * @brief Gets the image width in pixels.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] image The handle to the image metadata
  * @param[out] width The image width in pixels
@@ -116,7 +116,7 @@ int image_meta_get_width(image_meta_h image, int *width);
 
 /**
  * @brief Gets the image height in pixels.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] image The handle to the image metadata
  * @param[out] height The image height in pixels
@@ -131,7 +131,7 @@ int image_meta_get_height(image_meta_h image, int *height);
 
 /**
  * @brief Gets the image orientation.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] image The handle to the image metadata
  * @param[out] orientation The image orientation
@@ -146,7 +146,7 @@ int image_meta_get_orientation(image_meta_h image, media_content_orientation_e *
 
 /**
  * @brief Gets the image creation time.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @remarks The @a date_taken should be released using free().
  *
@@ -163,28 +163,9 @@ int image_meta_get_orientation(image_meta_h image, media_content_orientation_e *
 int image_meta_get_date_taken(image_meta_h image, char **date_taken);
 
 /**
- * @deprecated Deprecated since 4.0.
- * @brief Gets the burst shot ID.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- * @remarks The @a burst_id should be released using free().
- *
- * @param[in] image The handle to the image metadata
- * @param[out] burst_id The ID of the burst shot\ n
- *                      If @a burst_id is @c NULL, this is not burst shot
- *
- * @return @c 0 on success,
- *         otherwise a negative error value
- *
- * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- */
-int image_meta_get_burst_id(image_meta_h image, char **burst_id) TIZEN_DEPRECATED_API;
-
-/**
+ * @deprecated Deprecated since 8.0.
  * @brief Gets the exposure time from EXIF.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  *
  * @remarks The @a exposure_time should be released using free().
  *
@@ -199,11 +180,12 @@ int image_meta_get_burst_id(image_meta_h image, char **burst_id) TIZEN_DEPRECATE
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  *
  */
-int image_meta_get_exposure_time(image_meta_h image, char **exposure_time);
+int image_meta_get_exposure_time(image_meta_h image, char **exposure_time) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Gets the fnumber from EXIF.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  *
  * @param[in] image The handle to the image metadata
  * @param[out] fnumber The value of fnumber, getting from EXIF
@@ -215,11 +197,12 @@ int image_meta_get_exposure_time(image_meta_h image, char **exposure_time);
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  *
  */
-int image_meta_get_fnumber(image_meta_h image, double *fnumber);
+int image_meta_get_fnumber(image_meta_h image, double *fnumber) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Gets the iso from EXIF.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  *
  * @param[in] image The handle to the image metadata
  * @param[out] iso The value of iso, getting from EXIF
@@ -231,11 +214,12 @@ int image_meta_get_fnumber(image_meta_h image, double *fnumber);
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  *
  */
-int image_meta_get_iso(image_meta_h image, int *iso);
+int image_meta_get_iso(image_meta_h image, int *iso) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Gets the model from EXIF.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @since_tizen 2.4
  *
  * @remarks The @a model should be released using free().
  *
@@ -250,74 +234,7 @@ int image_meta_get_iso(image_meta_h image, int *iso);
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  *
  */
-int image_meta_get_model(image_meta_h image, char **model);
-
-/**
- * @deprecated Deprecated since 4.0.
- * @brief Checks whether the media is a burst shot image.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- * @param[in] image The handle to the image metadata
- * @param[out] is_burst_shot @c true if the media is a burst shot image,
- *                           otherwise @c false if the media is not a burst shot image
- *
- * @return @c 0 on success,
- *         otherwise a negative error value
- *
- * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- */
-int image_meta_is_burst_shot(image_meta_h image, bool *is_burst_shot) TIZEN_DEPRECATED_API;
-
-/**
- * @deprecated Deprecated since 4.0. This data cannot be saved to the file.
- * @brief Sets an orientation of the image.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- * @param[in] image The handle to the image metadata
- * @param[in] orientation The image orientation
- *
- * @return @c 0 on success,
- *         otherwise a negative error value
- *
- * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- */
-int image_meta_set_orientation(image_meta_h image, media_content_orientation_e orientation) TIZEN_DEPRECATED_API;
-
-/**
- * @deprecated Deprecated since 4.0. Related setter functions are deprecated, therefore this function is not needed anymore.
- * @brief Updates the image to the media database.
- *
- * @details The function updates the given image meta in the media database. \n
- *               The function should be called after any change in image attributes, to be updated to the media database.
- *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- * @privlevel public
- * @privilege %http://tizen.org/privilege/content.write
- *
- * @remarks Do not call this function in callback function of foreach function like media_info_foreach_media_from_db().
- *
- * @param[in] image The handle to the image metadata
- *
- * @return @c 0 on success,
- *         otherwise a negative error value
- *
- * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
- * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
- * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
- * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
- * @retval #MEDIA_CONTENT_ERROR_NETWORK           Network fail
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
- *
- * @pre This function requires opened connection to content service by media_content_connect().
- *
- * @see media_content_connect()
- */
-int image_meta_update_to_db(image_meta_h image) TIZEN_DEPRECATED_API;
+int image_meta_get_model(image_meta_h image, char **model) TIZEN_DEPRECATED_API;
 
 /**
  * @}