Remove alias related function
[platform/core/api/media-content.git] / include / media_content_type.h
index 2f20453..bd6702c 100755 (executable)
@@ -30,7 +30,7 @@ extern "C" {
  * @brief This file contains API related to media-content enumerations for media data types, groups, orientations, \n
  *        classes of errors and definitions of media-data. \n
  *        Listed APIs are called when iterating over lists of album, group, bookmark and other media,  \n
- *        when media items and burst shot are inserted completely and when notification of media DB change is subscribed.
+ *        when media items are inserted completely and when notification of media DB change is subscribed.
  */
 
 /**
@@ -44,7 +44,7 @@ extern "C" {
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @remarks Since 4.0, #MEDIA_CONTENT_TYPE_OTHERS is related to the following feature:\n
  *              %http://tizen.org/feature/content.scanning.others\n
- *              If this feature is not supported on the device, MEDIA_CONTENT_TYPE_OTHERS type file is not scanned.
+ *              If this feature is not supported on the device, #MEDIA_CONTENT_TYPE_OTHERS type file is not scanned.
  */
 typedef enum {
        MEDIA_CONTENT_TYPE_IMAGE                = 0,    /**<The type of an image */
@@ -56,6 +56,7 @@ typedef enum {
 
 /**
  * @ingroup CAPI_CONTENT_MEDIA_CONTENT_MODULE
+ * @deprecated Deprecated since 5.0.
  * @brief Enumeration for the storage type.
  * @details This information is used to establish where the folder is.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@@ -64,7 +65,6 @@ typedef enum {
        MEDIA_CONTENT_STORAGE_INTERNAL  = 0,    /**< The device's internal storage */
        MEDIA_CONTENT_STORAGE_EXTERNAL  = 1,    /**< The device's external storage like sd card*/
        MEDIA_CONTENT_STORAGE_EXTERNAL_USB = 2, /**< The external USB storage (Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif) */
-       MEDIA_CONTENT_STORAGE_CLOUD     = 100,  /**< The Cloud storage (Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, Deprecated since 4.0) */
 } media_content_storage_e;
 
 /**
@@ -180,17 +180,8 @@ typedef enum {
        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_BURST_IMAGE,         /**< Media group ID for the burst shot (Deprecated since 4.0)*/
-       MEDIA_CONTENT_GROUP_RATING,              /**< Media group ID for a rating*/
-       MEDIA_CONTENT_GROUP_AUTHOR,              /**< Media group ID for an author (Deprecated since 4.0)*/
-       MEDIA_CONTENT_GROUP_PROVIDER,            /**< Media group ID for a provider (Deprecated since 4.0)*/
-       MEDIA_CONTENT_GROUP_CONTENT_NAME,        /**< Media group ID for the content name (Deprecated since 4.0)*/
-       MEDIA_CONTENT_GROUP_CATEGORY,            /**< Media group ID for a category (Deprecated since 4.0)*/
-       MEDIA_CONTENT_GROUP_LOCATION_TAG,        /**< Media group ID for a location tag (Deprecated since 4.0)*/
-       MEDIA_CONTENT_GROUP_AGE_RATING,          /**< Media group ID for an age rating (Deprecated since 4.0)*/
-       MEDIA_CONTENT_GROUP_KEYWORD,             /**< Media group ID for a keyword (Deprecated since 4.0)*/
-       MEDIA_CONTENT_GROUP_WEATHER,             /**< Media group ID for the weather (Deprecated since 4.0)*/
-       MEDIA_CONTENT_GROUP_MAX                  /**< Invalid media group ID*/
+       MEDIA_CONTENT_GROUP_RATING = 20,         /**< Media group ID for a rating*/
+       MEDIA_CONTENT_GROUP_MAX = 29             /**< Invalid media group ID*/
 } media_group_e;
 
 /**
@@ -265,6 +256,7 @@ typedef struct filter_s *filter_h;
 
 /**
  * @ingroup CAPI_CONTENT_MEDIA_STORAGE_MODULE
+ * @deprecated Deprecated since 5.0.
  * @brief The structure type for the Media storage handle.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
@@ -396,33 +388,7 @@ typedef void (*media_insert_completed_cb)(media_content_error_e error, void * us
 
 
 /**
- * @deprecated Deprecated since 4.0.
- * @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
- * @brief Called when the burst shot is inserted completely.
- * @details The following error codes can be received: \n
- *             #MEDIA_CONTENT_ERROR_NONE : Success \n
- *             #MEDIA_CONTENT_ERROR_INVALID_PARAMETER : Invalid parameter \n
- *             #MEDIA_CONTENT_ERROR_INVALID_OPERATION : Invalid operation \n
- *             #MEDIA_CONTENT_ERROR_PERMISSION_DENIED : Permission denied \n
- *             #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY : Out of memory \n
- *             #MEDIA_CONTENT_ERROR_DB_FAILED : DB Operation failed \n
- *             #MEDIA_CONTENT_ERROR_DB_BUSY : DB Operation busy \n
- *             #MEDIA_CONTENT_ERROR_NETWORK : Network fail \n
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- * @remarks The callback is called in a separate thread(not in the main loop).
- *
- * @param[in] error The error code
- * @param[in] user_data The user data passed from the foreach function
- *
- * @pre media_info_insert_burst_shot_to_db()
- * @see media_info_insert_burst_shot_to_db()
- *
- */
-typedef void (*media_insert_burst_shot_completed_cb)(media_content_error_e error, void * user_data);
-
-
-/**
+ * @deprecated Deprecated since 5.0.
  * @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
  * @brief Called when creating a thumbnail image.
  * @details This callback is called for completion of generating the thumbnail image.
@@ -632,6 +598,7 @@ typedef bool (*media_group_cb)(const char *group_name, void *user_data);
 
 /**
  * @ingroup CAPI_CONTENT_MEDIA_STORAGE_MODULE
+ * @deprecated Deprecated since 5.0.
  * @brief Called for every storage in the obtained list of storages.
  * @details Iterates over a media storage list.
  *
@@ -949,42 +916,6 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_ORIENTATION "MEDIA_ORIENTATION"
 
 /**
- * @deprecated Deprecated since 4.0.
- * @brief Media burst ID.
- * @details You can use above define to set the condition of media filter and order keyword.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- */
-#define MEDIA_BURST_ID "BURST_ID"
-
-/**
- * @deprecated Deprecated since 4.0.
- * @brief Media playedcount.
- * @details You can use above define to set the condition of media filter and order keyword.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- */
-#define MEDIA_PLAYED_COUNT "MEDIA_PLAYED_COUNT"
-
-/**
- * @deprecated Deprecated since 4.0.
- * @brief Media last played time.
- * @details You can use above define to set the condition of media filter and order keyword.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- */
-#define MEDIA_LAST_PLAYED_TIME "MEDIA_LAST_PLAYED_TIME"
-
-/**
- * @deprecated Deprecated since 4.0.
- * @brief Media last played position of file.
- * @details You can use above define to set the condition of media filter and order keyword.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- */
-#define MEDIA_LAST_PLAYED_POSITION "MEDIA_LAST_PLAYED_POSITION"
-
-/**
  * @brief Media rating.
  * @details You can use above define to set the condition of media filter and order keyword.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@@ -1001,78 +932,6 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_FAVOURITE "MEDIA_FAVOURITE"
 
 /**
- * @deprecated Deprecated since 4.0.
- * @brief Media author.
- * @details You can use above define to set the condition of media filter and order keyword.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- */
-#define MEDIA_AUTHOR "MEDIA_AUTHOR"
-
-/**
- * @deprecated Deprecated since 4.0.
- * @brief Media provider.
- * @details You can use above define to set the condition of media filter and order keyword.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- */
-#define MEDIA_PROVIDER "MEDIA_PROVIDER"
-
-/**
- * @deprecated Deprecated since 4.0.
- * @brief Media content name.
- * @details You can use above define to set the condition of media filter and order keyword.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- */
-#define MEDIA_CONTENT_NAME "MEDIA_CONTENT_NAME"
-
-/**
- * @deprecated Deprecated since 4.0.
- * @brief Media category.
- * @details You can use above define to set the condition of media filter and order keyword.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- */
-#define MEDIA_CATEGORY "MEDIA_CATEGORY"
-
-/**
- * @deprecated Deprecated since 4.0.
- * @brief Media location tag.
- * @details You can use above define to set the condition of media filter and order keyword.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- */
-#define MEDIA_LOCATION_TAG "MEDIA_LOCATION_TAG"
-
-/**
- * @deprecated Deprecated since 4.0.
- * @brief Media age rating.
- * @details You can use above define to set the condition of media filter and order keyword.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- */
-#define MEDIA_AGE_RATING "MEDIA_AGE_RATING"
-
-/**
- * @deprecated Deprecated since 4.0.
- * @brief Media keyword.
- * @details You can use above define to set the condition of media filter and order keyword.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- */
-#define MEDIA_KEYWORD "MEDIA_KEYWORD"
-
-/**
- * @deprecated Deprecated since 4.0.
- * @brief Media weather.
- * @details You can use above define to set the condition of media filter and order keyword.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- */
-#define MEDIA_WEATHER "MEDIA_WEATHER"
-
-/**
  * @brief Is DRM.
  * @details There are 2 types:\n
  *               0-not drm, 1-drm\n
@@ -1083,6 +942,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_IS_DRM "MEDIA_IS_DRM"
 
 /**
+ * @deprecated Deprecated since 5.0.
  * @brief Media storage.
  * @details There are 2 types:\n
  *               0-internal storage, 1-external storage\n
@@ -1224,90 +1084,6 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_DESCRIPTION_PINYIN "MEDIA_DESCRIPTION_PINYIN"
 
 /**
- * @deprecated Deprecated since 4.0.
- * @brief Media author pinyin.
- * @details You can use above define to set the condition of media filter and order keyword.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @remarks Since 4.0, this keyword is related to the following feature:\n
- *          - %http://tizen.org/feature/content.filter.pinyin\n
- *            If this feature is not supported on the device, PINYIN search does not work.
- *
- */
-#define MEDIA_AUTHOR_PINYIN "MEDIA_AUTHOR_PINYIN"
-
-/**
- * @deprecated Deprecated since 4.0.
- * @brief Media provider pinyin.
- * @details You can use above define to set the condition of media filter and order keyword.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @remarks Since 4.0, this keyword is related to the following feature:\n
- *          - %http://tizen.org/feature/content.filter.pinyin\n
- *            If this feature is not supported on the device, PINYIN search does not work.
- *
- */
-#define MEDIA_PROVIDER_PINYIN "MEDIA_PROVIDER_PINYIN"
-
-/**
- * @deprecated Deprecated since 4.0.
- * @brief Media content name pinyin.
- * @details You can use above define to set the condition of media filter and order keyword.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @remarks Since 4.0, this keyword is related to the following feature:\n
- *          - %http://tizen.org/feature/content.filter.pinyin\n
- *            If this feature is not supported on the device, PINYIN search does not work.
- *
- */
-#define MEDIA_CONTENT_NAME_PINYIN "MEDIA_CONTENT_NAME_PINYIN"
-
-/**
- * @deprecated Deprecated since 4.0.
- * @brief Media category pinyin.
- * @details You can use above define to set the condition of media filter and order keyword.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @remarks Since 4.0, this keyword is related to the following feature:\n
- *          - %http://tizen.org/feature/content.filter.pinyin\n
- *            If this feature is not supported on the device, PINYIN search does not work.
- *
- */
-#define MEDIA_CATEGORY_PINYIN "MEDIA_CATEGORY_PINYIN"
-
-/**
- * @deprecated Deprecated since 4.0.
- * @brief Media location tag pinyin.
- * @details You can use above define to set the condition of media filter and order keyword.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @remarks Since 4.0, this keyword is related to the following feature:\n
- *          - %http://tizen.org/feature/content.filter.pinyin\n
- *            If this feature is not supported on the device, PINYIN search does not work.
- *
- */
-#define MEDIA_LOCATION_TAG_PINYIN "MEDIA_LOCATION_TAG_PINYIN"
-
-/**
- * @deprecated Deprecated since 4.0.
- * @brief Media age rating pinyin.
- * @details You can use above define to set the condition of media filter and order keyword.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @remarks Since 4.0, this keyword is related to the following feature:\n
- *          - %http://tizen.org/feature/content.filter.pinyin\n
- *            If this feature is not supported on the device, PINYIN search does not work.
- *
- */
-#define MEDIA_AGE_RATING_PINYIN "MEDIA_AGE_RATING_PINYIN"
-
-/**
- * @deprecated Deprecated since 4.0.
- * @brief Media keyword pinyin.
- * @details You can use above define to set the condition of media filter and order keyword.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @remarks Since 4.0, this keyword is related to the following feature:\n
- *          - %http://tizen.org/feature/content.filter.pinyin\n
- *            If this feature is not supported on the device, PINYIN search does not work.
- *
- */
-#define MEDIA_KEYWORD_PINYIN "MEDIA_KEYWORD_PINYIN"
-
-/**
  * @brief Virtual Reality content.
  * @details You can use above define to set the condition of media filter and order keyword.
  * @since_tizen 3.0
@@ -1337,14 +1113,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define FOLDER_NAME "FOLDER_NAME"
 
 /**
- * @deprecated Deprecated since 4.0.
- * @brief Folder modified time.
- * @details You can use above define to set the condition of folder filter and order keyword.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- */
-#define FOLDER_MODIFIED_TIME "FOLDER_MODIFIED_TIME"
-
-/**
+ * @deprecated Deprecated since 5.0.
  * @brief Folder storage.
  * @details There are 2 types:\n
  *               0-internal storage, 1-external storage\n
@@ -1364,22 +1133,6 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define FOLDER_NAME_PINYIN "FOLDER_NAME_PINYIN"
 
 /**
- * @deprecated Deprecated since 4.0.
- * @brief Folder order info.
- * @details You can use above define to set the condition of folder filter and order keyword.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- */
-#define FOLDER_ORDER "FOLDER_ORDER"
-
-/**
- * @deprecated Deprecated since 4.0.
- * @brief Parent folder id.
- * @details You can use above define to set the condition of folder filter and order keyword.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- */
-#define FOLDER_PARENT_FOLDER_ID "FOLDER_PARENT_FOLDER_ID"
-
-/**
  * @brief Playlist name.
  * @details You can use above define to set the condition of playlist filter and order keyword.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@@ -1450,6 +1203,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define BOOKMARK_NAME "BOOKMARK_NAME"
 
 /**
+ * @deprecated Deprecated since 5.0.
  * @brief Storage ID.
  * @details You can use above define to set the condition of storage filter and order keyword.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
@@ -1457,6 +1211,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_STORAGE_ID                                       "STORAGE_ID"
 
 /**
+ * @deprecated Deprecated since 5.0.
  * @brief Storage path.
  * @details You can use above define to set the condition of storage filter and order keyword.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif