X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=include_product%2Fmedia_image.h;h=804119356d5f9d6c2cc672c13beb21554a2477d9;hb=59af7cc1b17ec5b5d52aec4a274c4d8bd1226045;hp=0ec7bbdce859fe16d628951b1951530e7471084a;hpb=c9c51c0b68a49edbc57dc811fee1b893758afdd2;p=platform%2Fcore%2Fapi%2Fmedia-content.git diff --git a/include_product/media_image.h b/include_product/media_image.h index 0ec7bbd..8041193 100755 --- a/include_product/media_image.h +++ b/include_product/media_image.h @@ -16,8 +16,8 @@ -#ifndef __TIZEN_IMAGE_META_H__ -#define __TIZEN_IMAGE_META_H__ +#ifndef __TIZEN_CONTENT_MEDIA_IMAGE_H__ +#define __TIZEN_CONTENT_MEDIA_IMAGE_H__ #include @@ -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,12 +41,12 @@ 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 destination handle must be released with image_meta_destroy(). + * @remarks The @a dst should be released using image_meta_destroy(). * - * @param[out] dst The destination handle to the image metadata - * @param[in] src The source handle to the image metadata + * @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, * otherwise a negative error value @@ -62,12 +62,12 @@ 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 image metadata handle + * @param[in] image The handle to the image metadata * * @return @c 0 on success, * otherwise a negative error value @@ -83,10 +83,12 @@ 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 * - * @param[in] image The image metadata handle - * @param[out] media_id The ID of an image + * @remarks The @a media_id should be released using free(). + * + * @param[in] image The handle to the image metadata + * @param[out] media_id The media ID * * @return @c 0 on success, * otherwise a negative error value @@ -99,9 +101,9 @@ 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 image metadata handle + * @param[in] image The handle to the image metadata * @param[out] width The image width in pixels * * @return @c 0 on success, @@ -114,9 +116,9 @@ 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 image metadata handle + * @param[in] image The handle to the image metadata * @param[out] height The image height in pixels * * @return @c 0 on success, @@ -129,9 +131,9 @@ 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 image metadata handle + * @param[in] image The handle to the image metadata * @param[out] orientation The image orientation * * @return @c 0 on success, @@ -144,9 +146,11 @@ 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(). * - * @param[in] image The image metadata handle + * @param[in] image The handle to the image metadata * @param[out] date_taken The time, when image was taken (in seconds, since the Epoch) * * @return @c 0 on success, @@ -159,33 +163,14 @@ 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 You must release @a burst_id using free(). - * - * @param[in] image The image metadata handle - * @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, - * 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; - -/** - * @brief Gets the exposure time from exif. - * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif + * @deprecated Deprecated since 8.0. + * @brief Gets the exposure time from EXIF. + * @since_tizen 2.4 * - * @remarks @a exposure time must be released with free() by you. + * @remarks The @a exposure_time should be released using free(). * - * @param[in] image The image metadata handle - * @param[out] exposure_time The value of exposure_time, getting from exif + * @param[in] image The handle to the image metadata + * @param[out] exposure_time The value of exposure_time, getting from EXIF * * @return 0 on success, * otherwise a negative error value @@ -195,14 +180,15 @@ 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; /** - * @brief Gets the fnumber from exif. - * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif + * @deprecated Deprecated since 8.0. + * @brief Gets the fnumber from EXIF. + * @since_tizen 2.4 * - * @param[in] image The image metadata handle - * @param[out] fnumber The value of fnumber, getting from exif + * @param[in] image The handle to the image metadata + * @param[out] fnumber The value of fnumber, getting from EXIF * * @return 0 on success, * otherwise a negative error value @@ -211,14 +197,15 @@ 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; /** - * @brief Gets the iso from exif. - * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif + * @deprecated Deprecated since 8.0. + * @brief Gets the iso from EXIF. + * @since_tizen 2.4 * - * @param[in] image The image metadata handle - * @param[out] iso The value of iso, getting from exif + * @param[in] image The handle to the image metadata + * @param[out] iso The value of iso, getting from EXIF * * @return 0 on success, * otherwise a negative error value @@ -227,16 +214,17 @@ 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; /** - * @brief Gets the model from exif. - * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif + * @deprecated Deprecated since 8.0. + * @brief Gets the model from EXIF. + * @since_tizen 2.4 * - * @remarks @a model must be released with free() by you. + * @remarks The @a model should be released using free(). * - * @param[in] image The image metadata handle - * @param[out] model The value of model, getting from exif + * @param[in] image The handle to the image metadata + * @param[out] model The value of model, getting from EXIF * * @return 0 on success, * otherwise a negative error value @@ -246,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 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, - * 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 image metadata handle - * @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 - * - * @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; /** * @} @@ -324,4 +245,4 @@ int image_meta_update_to_db(image_meta_h image) TIZEN_DEPRECATED_API; } #endif /* __cplusplus */ -#endif /*__TIZEN_IMAGE_META_H__*/ +#endif /*__TIZEN_CONTENT_MEDIA_IMAGE_H__*/