[ACR-1838] Deprecate all bookmark and playlist funtions

[platform/core/api/media-content.git] / include / media_content_type.h

diff --git a/include/media_content_type.h b/include/media_content_type.h
index c9e25e5..f2969a1 100755 (executable)
--- a/include/media_content_type.h
+++ b/include/media_content_type.h
@@ -149,27 +149,27 @@ typedef enum {
  * @since_tizen 2.3
  */
 typedef enum {
-       MEDIA_CONTENT_GROUP_DISPLAY_NAME = 0,    /**< Media group ID for display name */
-       MEDIA_CONTENT_GROUP_TYPE,                /**< Media group ID for a media type */
-       MEDIA_CONTENT_GROUP_MIME_TYPE,           /**< Media group ID for a mime type */
-       MEDIA_CONTENT_GROUP_SIZE,                /**< Media group ID for content size */
-       MEDIA_CONTENT_GROUP_ADDED_TIME,          /**< Media group ID for the added time */
-       MEDIA_CONTENT_GROUP_MODIFIED_TIME,       /**< Media group ID for the modified time */
-       MEDIA_CONTENT_GROUP_TITLE,               /**< Media group ID for a content title */
+       MEDIA_CONTENT_GROUP_DISPLAY_NAME = 0,    /**< @deprecated Media group ID for display name. Deprecated since 9.0*/
+       MEDIA_CONTENT_GROUP_TYPE,                /**< @deprecated Media group ID for a media type. Deprecated since 9.0*/
+       MEDIA_CONTENT_GROUP_MIME_TYPE,           /**< @deprecated Media group ID for a mime type. Deprecated since 9.0*/
+       MEDIA_CONTENT_GROUP_SIZE,                /**< @deprecated Media group ID for content size. Deprecated since 9.0*/
+       MEDIA_CONTENT_GROUP_ADDED_TIME,          /**< @deprecated Media group ID for the added time. Deprecated since 9.0*/
+       MEDIA_CONTENT_GROUP_MODIFIED_TIME,       /**< @deprecated Media group ID for the modified time. Deprecated since 9.0*/
+       MEDIA_CONTENT_GROUP_TITLE,               /**< @deprecated Media group ID for a content title. Deprecated since 9.0*/
        MEDIA_CONTENT_GROUP_ARTIST,              /**< Media group ID for an artist*/
        MEDIA_CONTENT_GROUP_ALBUM_ARTIST,        /**< Media group ID for an album artist */
        MEDIA_CONTENT_GROUP_GENRE,               /**< Media group ID for a genre*/
-       MEDIA_CONTENT_GROUP_COMPOSER,            /**< Media group ID for a composer*/
+       MEDIA_CONTENT_GROUP_COMPOSER,            /**< @deprecated Media group ID for a composer. Deprecated since 9.0*/
        MEDIA_CONTENT_GROUP_YEAR,                /**< Media group ID for a year*/
-       MEDIA_CONTENT_GROUP_RECORDED_DATE,       /**< Media group ID for the recorded date*/
-       MEDIA_CONTENT_GROUP_COPYRIGHT,           /**< Media group ID for the copyright*/
-       MEDIA_CONTENT_GROUP_TRACK_NUM,           /**< Media group ID for a track number*/
-       MEDIA_CONTENT_GROUP_DESCRIPTION,         /**< Media group ID for a description */
-       MEDIA_CONTENT_GROUP_LONGITUDE,           /**< Media group ID for the longitude*/
-       MEDIA_CONTENT_GROUP_LATITUDE,            /**< Media group ID for the latitude*/
-       MEDIA_CONTENT_GROUP_ALTITUDE,            /**< Media group ID for the altitude*/
-       MEDIA_CONTENT_GROUP_RATING = 20,         /**< Media group ID for a rating*/
-       MEDIA_CONTENT_GROUP_MAX = 29             /**< Invalid media group ID*/
+       MEDIA_CONTENT_GROUP_RECORDED_DATE,       /**< @deprecated Media group ID for the recorded date. Deprecated since 9.0*/
+       MEDIA_CONTENT_GROUP_COPYRIGHT,           /**< @deprecated Media group ID for the copyright. Deprecated since 9.0*/
+       MEDIA_CONTENT_GROUP_TRACK_NUM,           /**< @deprecated Media group ID for a track number. Deprecated since 9.0*/
+       MEDIA_CONTENT_GROUP_DESCRIPTION,         /**< @deprecated Media group ID for a description. Deprecated since 9.0*/
+       MEDIA_CONTENT_GROUP_LONGITUDE,           /**< @deprecated Media group ID for the longitude. Deprecated since 9.0*/
+       MEDIA_CONTENT_GROUP_LATITUDE,            /**< @deprecated Media group ID for the latitude. Deprecated since 9.0*/
+       MEDIA_CONTENT_GROUP_ALTITUDE,            /**< @deprecated Media group ID for the altitude. Deprecated since 9.0*/
+       MEDIA_CONTENT_GROUP_RATING = 20,         /**< @deprecated Media group ID for a rating. Deprecated since 9.0*/
+       MEDIA_CONTENT_GROUP_MAX = 29             /**< @deprecated Invalid media group ID. Deprecated since 9.0*/
 } media_group_e;
 
 /**
@@ -187,6 +187,7 @@ typedef struct media_info_s *media_info_h;
 typedef struct media_folder_s *media_folder_h;
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @ingroup CAPI_CONTENT_MEDIA_PLAYLIST_MODULE
  * @brief The structure type for the Media playlist handle.
  * @since_tizen 2.3
@@ -194,6 +195,7 @@ typedef struct media_folder_s *media_folder_h;
 typedef struct media_playlist_s *media_playlist_h;
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @ingroup CAPI_CONTENT_MEDIA_TAG_MODULE
  * @brief The structure type for the Media tag handle.
  * @since_tizen 2.3
@@ -201,6 +203,7 @@ typedef struct media_playlist_s *media_playlist_h;
 typedef struct media_tag_s *media_tag_h;
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @ingroup CAPI_CONTENT_MEDIA_BOOKMARK_MODULE
  * @brief The structure type for the Media bookmark handle.
  * @since_tizen 2.3
@@ -222,6 +225,7 @@ typedef struct media_album_s *media_album_h;
 typedef struct image_meta_s *image_meta_h;
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @ingroup CAPI_CONTENT_MEDIA_VIDEO_META_MODULE
  * @brief The structure type for the Video metadata handle.
  * @since_tizen 2.3
@@ -336,13 +340,10 @@ typedef void (*media_content_db_update_cb)(
  * @return @c true to continue with the next iteration of the loop,
  *         otherwise @c false to break out of the loop
  *
- * @pre media_tag_foreach_media_from_db(), media_playlist_foreach_media_from_db(), media_genre_foreach_media_from_db(),
- *      media_info_foreach_media_from_db(), media_folder_foreach_media_from_db() will invoke this function.
+ * @pre media_info_foreach_media_from_db(), media_folder_foreach_media_from_db() will invoke this function.
  *
  * @see media_info_clone()
  * @see media_album_foreach_media_from_db()
- * @see media_playlist_foreach_media_from_db()
- * @see media_tag_foreach_media_from_db()
  * @see media_info_foreach_media_from_db()
  * @see media_folder_foreach_media_from_db()
  */
@@ -424,6 +425,7 @@ typedef void (*media_face_detection_completed_cb)(media_content_error_e error, c
 typedef bool (*media_folder_cb)(media_folder_h folder, void *user_data);
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @ingroup CAPI_CONTENT_MEDIA_PLAYLIST_MODULE
  * @brief Called for every playlist in the obtained list of playlists.
  * @details Iterates over a playlist list.
@@ -447,6 +449,7 @@ typedef bool (*media_folder_cb)(media_folder_h folder, void *user_data);
 typedef bool (*media_playlist_cb)(media_playlist_h playlist, void *user_data);
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @ingroup CAPI_CONTENT_MEDIA_PLAYLIST_MODULE
  * @brief Called for every media info with playlist member ID in the obtained list of media info.
  * @details Iterates over playlist members.
@@ -471,6 +474,7 @@ typedef bool (*media_playlist_cb)(media_playlist_h playlist, void *user_data);
 typedef bool (*playlist_member_cb)(int playlist_member_id, media_info_h media, void *user_data);
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @ingroup CAPI_CONTENT_MEDIA_TAG_MODULE
  * @brief Called for every tag in the obtained list of tags.
  * @details Iterates over a list of tags.
@@ -495,6 +499,7 @@ typedef bool (*playlist_member_cb)(int playlist_member_id, media_info_h media, v
 typedef bool (*media_tag_cb)(media_tag_h tag, void *user_data);
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @ingroup CAPI_CONTENT_MEDIA_BOOKMARK_MODULE
  * @brief Called for every bookmark in the obtained list of bookmarks.
  * @details Iterates over a bookmark list.
@@ -658,6 +663,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_MODIFIED_TIME "MEDIA_MODIFIED_TIME"
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief  Media created time.
  * @details You can use above define to set the condition of media filter and order keyword.
  * @since_tizen 2.3
@@ -714,6 +720,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_GENRE "MEDIA_GENRE"
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Media composer.
  * @details You can use above define to set the condition of media filter and order keyword.
  * @since_tizen 2.3
@@ -730,6 +737,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_YEAR "MEDIA_YEAR"
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Media recorded date.
  * @details You can use above define to set the condition of media filter and order keyword.
  * @since_tizen 2.3
@@ -746,6 +754,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_TRACK_NUM "MEDIA_TRACK_NUM"
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Media duration.
  * @details You can use above define to set the condition of media filter and order keyword.
  * @since_tizen 2.3
@@ -754,6 +763,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_DURATION "MEDIA_DURATION"
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Media longitude.
  * @details You can use above define to set the condition of media filter and order keyword.
  * @since_tizen 2.3
@@ -762,6 +772,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_LONGITUDE "MEDIA_LONGITUDE"
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Media latitude.
  * @details You can use above define to set the condition of media filter and order keyword.
  * @since_tizen 2.3
@@ -770,6 +781,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_LATITUDE "MEDIA_LATITUDE"
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Media altitude.
  * @details You can use above define to set the condition of media filter and order keyword.
  * @since_tizen 2.3
@@ -802,6 +814,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_DATETAKEN "MEDIA_DATETAKEN"
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief The time to register favourite.
  * @details You can use above define to set the condition of media filter and order keyword.
  * @since_tizen 2.3
@@ -810,6 +823,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_FAVOURITE "MEDIA_FAVOURITE"
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Is DRM.
  * @details There are 2 types:\n
  *               0-not drm, 1-drm\n
@@ -820,6 +834,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_IS_DRM "MEDIA_IS_DRM"
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Virtual Reality content.
  * @details You can use above define to set the condition of media filter and order keyword.
  * @since_tizen 3.0
@@ -849,6 +864,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define FOLDER_NAME "FOLDER_NAME"
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Playlist name.
  * @details You can use above define to set the condition of playlist filter and order keyword.
  * @since_tizen 2.3
@@ -856,6 +872,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define PLAYLIST_NAME "PLAYLIST_NAME"
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Playlist id.
  * @details You can use above define to set the condition of playlist filter and order keyword.
  * @since_tizen 4.0
@@ -863,6 +880,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_PLAYLIST_ID "PLAYLIST_ID"
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Playlist member order.
  * @details You can use above define to set the condition of playlist filter and order keyword.
  * @since_tizen 2.3
@@ -870,6 +888,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define PLAYLIST_MEMBER_ORDER "PLAYLIST_MEMBER_ORDER"
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Media count in playlist.
  * @details You can use above define to set the condition of playlist filter and order keyword.
  * @since_tizen 2.3
@@ -877,6 +896,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define PLAYLIST_MEDIA_COUNT "PLAYLIST_MEDIA_COUNT"
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Tag name.
  * @details You can use above define to set the condition of tag filter and order keyword.
  * @since_tizen 2.3
@@ -884,6 +904,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define TAG_NAME "TAG_NAME"
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Tag id.
  * @details You can use above define to set the condition of tag filter and order keyword.
  * @since_tizen 4.0
@@ -891,6 +912,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_TAG_ID "TAG_ID"
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Media count in tag.
  * @details You can use above define to set the condition of tag filter and order keyword.
  * @since_tizen 2.3
@@ -898,6 +920,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define TAG_MEDIA_COUNT "TAG_MEDIA_COUNT"
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Bookmark marked time.
  * @details You can use above define to set the condition of bookmark filter and order keyword.
  * @since_tizen 2.3
@@ -905,6 +928,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define BOOKMARK_MARKED_TIME "BOOKMARK_MARKED_TIME"
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Bookmark id.
  * @details You can use above define to set the condition of bookmark filter and order keyword.
  * @since_tizen 4.0
@@ -912,6 +936,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_BOOKMARK_ID "BOOKMARK_ID"
 
 /**
+ * @deprecated Deprecated since 9.0.
  * @brief Bookmark name.
  * @details You can use above define to set the condition of bookmark filter and order keyword.
  * @since_tizen 4.0