Remove weather in image struct
[platform/core/api/media-content.git] / include / media_image.h
index 450ade4..0ec7bbd 100755 (executable)
@@ -41,20 +41,19 @@ extern "C" {
  * @brief Clones the image metadata.
  * @details The function copies the image metadata handle from a source to destination.
  *
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @remarks The destination handle must be released with image_meta_destroy().
  *
  * @param[out] dst  The destination handle to the image metadata
  * @param[in]  src  The source handle to the image metadata
  *
- * @return @c 0 on success, 
+ * @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_PERMISSION_DENIED Permission denied
  *
  * @see image_meta_destroy()
  */
@@ -66,15 +65,15 @@ int image_meta_clone(image_meta_h *dst, image_meta_h src);
  *          no longer can be used to perform any operation. A new handle has to
  *          be created before next usage.
  *
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in] image The image metadata handle
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  *
  * @pre Get a copy of image_meta handle by calling image_meta_clone().
  *
@@ -84,87 +83,85 @@ int image_meta_destroy(image_meta_h image);
 
 /**
  * @brief Gets the ID of an image.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in]  image    The image metadata handle
  * @param[out] media_id The ID of an image
  *
- * @return @c 0 on success, 
+ * @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
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  */
 int image_meta_get_media_id(image_meta_h image, char **media_id);
 
 /**
  * @brief Gets the image width in pixels.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in]  image The image metadata handle
  * @param[out] width The image width in pixels
  *
- * @return @c 0 on success, 
+ * @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_PERMISSION_DENIED Permission denied
  */
 int image_meta_get_width(image_meta_h image, int *width);
 
 /**
  * @brief Gets the image height in pixels.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in]  image  The image metadata handle
  * @param[out] height The image height in pixels
  *
- * @return @c 0 on success, 
+ * @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_PERMISSION_DENIED Permission denied
  */
 int image_meta_get_height(image_meta_h image, int *height);
 
 /**
  * @brief Gets the image orientation.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in]  image       The image metadata handle
  * @param[out] orientation The image orientation
  *
- * @return @c 0 on success, 
+ * @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_PERMISSION_DENIED Permission denied
  */
 int image_meta_get_orientation(image_meta_h image, media_content_orientation_e *orientation);
 
 /**
  * @brief Gets the image creation time.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in]  image      The image metadata handle
  * @param[out] date_taken The time, when image was taken (in seconds, since the Epoch)
  *
- * @return @c 0 on success, 
+ * @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
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  */
 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 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @remarks You must release @a burst_id using free().
  *
@@ -172,22 +169,22 @@ int image_meta_get_date_taken(image_meta_h image, char **date_taken);
  * @param[out] burst_id The ID of burst shot\ n
  *                      If @a burst_id is @c NULL, this is not burst shot
  *
- * @return @c 0 on success, 
+ * @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_PERMISSION_DENIED Permission denied
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  */
-int image_meta_get_burst_id(image_meta_h image, char **burst_id);
+int image_meta_get_burst_id(image_meta_h image, char **burst_id) TIZEN_DEPRECATED_API;
 
 /**
  * @brief Gets the exposure time from exif.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @remarks @a exposure time must be released with free() by you.
  *
- * @param[in] media The handle to image metadata
+ * @param[in]  image    The image metadata handle
  * @param[out] exposure_time The value of exposure_time, getting from exif
  *
  * @return 0 on success,
@@ -202,16 +199,15 @@ int image_meta_get_exposure_time(image_meta_h image, char **exposure_time);
 
 /**
  * @brief Gets the fnumber from exif.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
- * @param[in] media The handle toimage metadata
+ * @param[in]  image    The image metadata handle
  * @param[out] fnumber The value of fnumber, getting from exif
  *
  * @return 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
  *
  */
@@ -219,16 +215,15 @@ int image_meta_get_fnumber(image_meta_h image, double *fnumber);
 
 /**
  * @brief Gets the iso from exif.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
- * @param[in] media The handle toimage metadata
+ * @param[in]  image    The image metadata handle
  * @param[out] iso The value of iso, getting from exif
  *
  * @return 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
  *
  */
@@ -236,11 +231,11 @@ int image_meta_get_iso(image_meta_h image, int *iso);
 
 /**
  * @brief Gets the model from exif.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @remarks @a model must be released with free() by you.
  *
- * @param[in] media The handle toimage metadata
+ * @param[in]  image    The image metadata handle
  * @param[out] model The value of model, getting from exif
  *
  * @return 0 on success,
@@ -254,48 +249,46 @@ int image_meta_get_iso(image_meta_h image, int *iso);
 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 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in]  image         The image metadata handle
  * @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, 
+ * @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_PERMISSION_DENIED Permission denied
  */
-int image_meta_is_burst_shot(image_meta_h image, bool *is_burst_shot);
+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 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in] image       The image metadata handle
  * @param[in] orientation The image orientation
  *
- * @return @c 0 on success, 
+ * @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_PERMISSION_DENIED Permission denied
- *
- * @post image_meta_update_to_db()
  */
-int image_meta_set_orientation(image_meta_h image, media_content_orientation_e orientation);
+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. The function should be called after any change in image attributes, to be updated to the media
- *          database. For example, after using image_meta_set_orientation() for setting the orientation of the image, the image_meta_update_to_db() function should be called so as to update
- *          the given image attributes in 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 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @privlevel public
  * @privilege %http://tizen.org/privilege/content.write
@@ -304,7 +297,7 @@ int image_meta_set_orientation(image_meta_h image, media_content_orientation_e o
  *
  * @param[in] image The handle to the image
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
@@ -319,9 +312,8 @@ int image_meta_set_orientation(image_meta_h image, media_content_orientation_e o
  * @pre This function requires opened connection to content service by media_content_connect().
  *
  * @see media_content_connect()
- * @see image_meta_set_orientation()
  */
-int image_meta_update_to_db(image_meta_h image);
+int image_meta_update_to_db(image_meta_h image) TIZEN_DEPRECATED_API;
 
 /**
  * @}