[ACR-1819] Deprecate meaningless media group enum
[platform/core/api/media-content.git] / include_product / media_tag.h
index 31cdabc..f489062 100755 (executable)
@@ -40,8 +40,9 @@ extern "C" {
  */
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Inserts a new tag in the media database.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @privlevel public
  * @privilege %http://tizen.org/privilege/content.write
@@ -69,11 +70,12 @@ extern "C" {
  * @see media_tag_delete_from_db()
  * @see media_tag_destroy()
  */
-int media_tag_insert_to_db(const char *tag_name, media_tag_h *tag);
+int media_tag_insert_to_db(const char *tag_name, media_tag_h *tag) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Deletes a given tag from the media database.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @privlevel public
  * @privilege %http://tizen.org/privilege/content.write
@@ -96,11 +98,12 @@ int media_tag_insert_to_db(const char *tag_name, media_tag_h *tag);
  * @see media_content_connect()
  * @see media_tag_insert_to_db()
  */
-int media_tag_delete_from_db(int tag_id);
+int media_tag_delete_from_db(int tag_id) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Gets the count of the tag for the passed @a filter from the media database.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] filter The handle to the media filter
  * @param[out] tag_count The count of the media tag
@@ -112,21 +115,21 @@ int media_tag_delete_from_db(int tag_id);
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
- * @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 media_tag_get_tag_count_from_db(filter_h filter, int *tag_count);
+int media_tag_get_tag_count_from_db(filter_h filter, int *tag_count) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Iterates through tags from the media database.
  * @details This function gets all tags meeting a desired @a filter
  *          and calls a registered callback function for every retrieved tag.
  *          If @c NULL is passed to the @a filter, no filtering is applied.
  *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] filter The handle to the media filter
  * @param[in] callback The callback function to be invoked
@@ -140,7 +143,6 @@ int media_tag_get_tag_count_from_db(filter_h filter, int *tag_count);
  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  *
  * @pre  This function requires opened connection to content service by media_content_connect().
  * @post This function invokes media_tag_cb().
@@ -149,11 +151,12 @@ int media_tag_get_tag_count_from_db(filter_h filter, int *tag_count);
  * @see #media_tag_cb
  * @see media_filter_create()
  */
-int media_tag_foreach_tag_from_db(filter_h filter, media_tag_cb callback, void *user_data);
+int media_tag_foreach_tag_from_db(filter_h filter, media_tag_cb callback, void *user_data) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Gets the number of media files for the passed @a filter in the given @a tag_id from the media database.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] tag_id The ID of the media tag
  * @param[in] filter The handle to the media filter
@@ -166,21 +169,21 @@ int media_tag_foreach_tag_from_db(filter_h filter, media_tag_cb callback, void *
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
- * @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 media_tag_get_media_count_from_db(int tag_id, filter_h filter, int *media_count);
+int media_tag_get_media_count_from_db(int tag_id, filter_h filter, int *media_count) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Iterates through media items for a given tag from the media database.
  * @details This function gets all media items associated with a given tag and
  *          meeting a desired @a filter and calls a registered callback function for
  *          every retrieved media item. If @c NULL is passed to the @a filter, no filtering is applied.
  *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] tag_id The ID of the media tag
  * @param[in] filter The handle to the media filter
@@ -195,7 +198,6 @@ int media_tag_get_media_count_from_db(int tag_id, filter_h filter, int *media_co
  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  *
  * @pre  This function requires opened connection to content service by media_content_connect().
  * @post This function invokes media_info_cb().
@@ -204,16 +206,17 @@ int media_tag_get_media_count_from_db(int tag_id, filter_h filter, int *media_co
  * @see media_info_cb()
  * @see media_filter_create()
  */
-int media_tag_foreach_media_from_db(int tag_id, filter_h filter, media_info_cb callback, void *user_data);
+int media_tag_foreach_media_from_db(int tag_id, filter_h filter, media_info_cb callback, void *user_data) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Clones the media tag.
  * @details This function copies the media tag handle from a source to destination.
- *          There is no media_tag_create() function. The media_tag_h is created internally and available through media tag foreach function
+ *          There is no media_tag_create() function. The #media_tag_h is created internally and available through media tag foreach function
  *          such as media_tag_foreach_tag_from_db().
  *          To use this handle outside of these foreach functions, use this function.
  *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @remarks The @a dst should be released using media_tag_destroy().
  *
@@ -229,14 +232,15 @@ int media_tag_foreach_media_from_db(int tag_id, filter_h filter, media_info_cb c
  *
  * @see media_tag_destroy()
  */
-int media_tag_clone(media_tag_h *dst, media_tag_h src);
+int media_tag_clone(media_tag_h *dst, media_tag_h src) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Destroys the media tag.
  * @details This function frees all resources related to the tag handle. The tag handle can no longer
- *          be used for any operation. A new tag handle has to be created before next usage.
+ *          be used for any operations. A new tag 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] tag The handle to the media tag
  *
@@ -251,11 +255,12 @@ int media_tag_clone(media_tag_h *dst, media_tag_h src);
  * @see media_tag_clone()
  * @see media_tag_insert_to_db()
  */
-int media_tag_destroy(media_tag_h tag);
+int media_tag_destroy(media_tag_h tag) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Gets the media tag ID.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] tag The handle to the media tag
  * @param[out] tag_id The ID of the media tag
@@ -266,11 +271,12 @@ int media_tag_destroy(media_tag_h tag);
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  */
-int media_tag_get_tag_id(media_tag_h tag, int *tag_id);
+int media_tag_get_tag_id(media_tag_h tag, int *tag_id) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Gets the tag name.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @remarks The @a tag_name should be released using free().
  *
@@ -284,17 +290,18 @@ int media_tag_get_tag_id(media_tag_h tag, int *tag_id);
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
  */
-int media_tag_get_name(media_tag_h tag, char **tag_name);
+int media_tag_get_name(media_tag_h tag, char **tag_name) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Gets the media tag from the media database.
  *
  * @details This function creates a new media tag handle from the media database by the given @a tag_id.
  *          Media tag will be created and will be filled with tag information.
  *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
- * @remarksThe @a tag should be released using media_tag_destroy().
+ * @remarks The @a tag should be released using media_tag_destroy().
  *
  * @param[in] tag_id The ID of the media tag
  * @param[out] tag The handle to the media tag
@@ -307,18 +314,18 @@ int media_tag_get_name(media_tag_h tag, char **tag_name);
  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
- * @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()
  * @see media_tag_destroy()
  */
-int media_tag_get_tag_from_db(int tag_id, media_tag_h *tag);
+int media_tag_get_tag_from_db(int tag_id, media_tag_h *tag) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Adds a new media info to the tag.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] tag The handle to the media tag
  * @param[in] media_id The media ID
@@ -336,11 +343,12 @@ int media_tag_get_tag_from_db(int tag_id, media_tag_h *tag);
  * @see media_content_connect()
  * @see media_tag_remove_media()
  */
-int media_tag_add_media(media_tag_h tag, const char *media_id);
+int media_tag_add_media(media_tag_h tag, const char *media_id) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Removes the media info from the given tag.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] tag The handle to the media tag
  * @param[in] media_id The media ID
@@ -358,11 +366,12 @@ int media_tag_add_media(media_tag_h tag, const char *media_id);
  * @see media_content_connect()
  * @see media_tag_add_media()
  */
-int media_tag_remove_media(media_tag_h tag, const char *media_id);
+int media_tag_remove_media(media_tag_h tag, const char *media_id) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Sets the name of the tag.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] tag The handle to the media tag
  * @param[in] tag_name The name of the media tag
@@ -376,16 +385,17 @@ int media_tag_remove_media(media_tag_h tag, const char *media_id);
  *
  * @post media_tag_update_to_db()
  */
-int media_tag_set_name(media_tag_h tag, const char *tag_name);
+int media_tag_set_name(media_tag_h tag, const char *tag_name) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Updates the media tag to the media database.
  *
  * @details The function updates the given media tag in the media database. The function should be called after any change in tag attributes, to be updated to the media
  *          database. For example, after using media_tag_set_name() for setting the name of the tag, the media_tag_update_to_db() function should be called so as to update
  *          the given tag attributes in the media database.
  *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @privlevel public
  * @privilege %http://tizen.org/privilege/content.write
@@ -412,7 +422,7 @@ int media_tag_set_name(media_tag_h tag, const char *tag_name);
  * @see media_tag_remove_media()
  * @see media_tag_set_name()
  */
-int media_tag_update_to_db(media_tag_h tag);
+int media_tag_update_to_db(media_tag_h tag) TIZEN_DEPRECATED_API;
 
 /**
  * @}