Version Up
[platform/core/api/media-content.git] / include / media_content_type.h
index 3c3da0d..204b80c 100755 (executable)
@@ -43,32 +43,20 @@ extern "C" {
  * @brief Enumeration for the media file format.
  * @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.
+ *          %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.
  */
 typedef enum {
-       MEDIA_CONTENT_TYPE_IMAGE                = 0,    /**<The type of an image */
-       MEDIA_CONTENT_TYPE_VIDEO                = 1,    /**<The type of a video */
+       MEDIA_CONTENT_TYPE_IMAGE        = 0,    /**<The type of an image */
+       MEDIA_CONTENT_TYPE_VIDEO        = 1,    /**<The type of a video */
        MEDIA_CONTENT_TYPE_SOUND        = 2,    /**<The type of sound */
-       MEDIA_CONTENT_TYPE_MUSIC                = 3,    /**<The type of music */
+       MEDIA_CONTENT_TYPE_MUSIC        = 3,    /**<The type of music */
        MEDIA_CONTENT_TYPE_OTHERS       = 4,    /**<The type of other */
+       MEDIA_CONTENT_TYPE_BOOK         = 5,    /**<The type of book (Since 6.5)*/
 } media_content_type_e;
 
 /**
  * @ingroup CAPI_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
- */
-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_e;
-
-/**
- * @ingroup CAPI_MEDIA_CONTENT_MODULE
  * @brief Enumeration for media content DB update items.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  */
@@ -248,6 +236,13 @@ typedef struct video_meta_s *video_meta_h;
 typedef struct audio_meta_s *audio_meta_h;
 
 /**
+ * @ingroup CAPI_CONTENT_MEDIA_BOOK_META_MODULE
+ * @brief The structure type for the Book metadata handle.
+ * @since_tizen 6.5
+ */
+typedef struct book_meta_s *book_meta_h;
+
+/**
  * @ingroup CAPI_CONTENT_MEDIA_FILTER_MODULE
  * @brief The structure type for the Media filter handle.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@@ -255,14 +250,7 @@ typedef struct audio_meta_s *audio_meta_h;
 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
- */
-typedef void *media_storage_h;
-
-/**
+ * @deprecated Deprecated since 8.0.
  * @ingroup CAPI_CONTENT_MEDIA_FACE_MODULE
  * @brief The structure type for the Media face handle.
  * @since_tizen 3.0
@@ -313,7 +301,7 @@ typedef void (*media_scan_completed_cb)(media_content_error_e error, void * user
  * @param[in] update_item The update item of notification
  * @param[in] update_type The update type of notification
  * @param[in] media_type The type of the media content (#media_content_type_e)
- * @param[in] uuid The UUID of media or directory, which is updated
+ * @param[in] id The ID of media or directory, which is updated
  * @param[in] path The path of the media or directory
  * @param[in] mime_type The MIME of the media info
  * @param[in] user_data The user data passed from the foreach function
@@ -327,7 +315,7 @@ typedef void (*media_content_db_update_cb)(
                                media_content_db_update_item_type_e update_item,
                                media_content_db_update_type_e update_type,
                                media_content_type_e media_type,
-                               char *uuid,
+                               char *id,
                                char *path,
                                char *mime_type,
                                void *user_data);
@@ -386,33 +374,8 @@ typedef bool (*media_info_cb)(media_info_h media, void *user_data);
  */
 typedef void (*media_insert_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.
- *         The following error codes can be delivered. \n
- *         #MEDIA_CONTENT_ERROR_NONE, \n
- *         #MEDIA_CONTENT_ERROR_INVALID_PARAMETER, \n
- *         #MEDIA_CONTENT_ERROR_INVALID_OPERATION, \n
- *         #MEDIA_CONTENT_ERROR_PERMISSION_DENIED, \n
- *         #MEDIA_CONTENT_ERROR_DB_FAILED, \n
- *         #MEDIA_CONTENT_ERROR_UNSUPPORTED_CONTENT
- * @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] path The path of the thumbnail which is generated
- * @param[in] user_data The user data passed from the foreach function
- *
- * @pre media_info_create_thumbnail()
- * @see media_info_create_thumbnail()
- */
-typedef void (*media_thumbnail_completed_cb)(media_content_error_e error, const char *path, void *user_data);
-
 /**
+ * @deprecated Deprecated since 8.0.
  * @ingroup CAPI_CONTENT_MEDIA_FACE_DETECTION_MODULE
  * @brief Called when face detection on the image is completed.
  *
@@ -597,28 +560,7 @@ typedef bool (*media_album_cb)(media_album_h album, void *user_data);
 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.
- *
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- *
- * @remarks You should not destroy @a storage returned by this function. \n
- *                  The callback is called in the main loop.
- *
- * @param[in] storage The handle of the media storage
- * @param[in] user_data The user data passed from the foreach function
- *
- * @return @c true to continue with the next iteration of the loop,
- *         otherwise @c false to break out of the loop
- *
- * @pre media_storage_foreach_storage_from_db() will invoke this function.
- * @see media_storage_foreach_storage_from_db()
- */
-typedef bool (*media_storage_cb)(media_storage_h storage, void *user_data);
-
-/**
+ * @deprecated Deprecated since 8.0.
  * @ingroup CAPI_CONTENT_MEDIA_FACE_MODULE
  * @brief Called for every face in the obtained list of face.
  * @details Iterates over a media face list.
@@ -796,15 +738,6 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_RECORDED_DATE "MEDIA_RECORDED_DATE"
 
 /**
- * @deprecated Deprecated since 5.5.
- * @brief Media copyright.
- * @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_COPYRIGHT "MEDIA_COPYRIGHT"
-
-/**
  * @brief Media track number.
  * @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
@@ -813,51 +746,6 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_TRACK_NUM "MEDIA_TRACK_NUM"
 
 /**
- * @deprecated Deprecated since 5.5.
- * @brief Media description.
- * @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_DESCRIPTION "MEDIA_DESCRIPTION"
-
-/**
- * @deprecated Deprecated since 5.5.
- * @brief Media bitrate.
- * @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_BITRATE "MEDIA_BITRATE"
-
-/**
- * @deprecated Deprecated since 5.5.
- * @brief Media bit per sample.
- * @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_BITPERSAMPLE "MEDIA_BITPERSAMPLE"
-
-/**
- * @deprecated Deprecated since 5.5.
- * @brief Media sample rate.
- * @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_SAMPLERATE "MEDIA_SAMPLERATE"
-
-/**
- * @deprecated Deprecated since 5.5.
- * @brief Media channel.
- * @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_CHANNEL "MEDIA_CHANNEL"
-
-/**
  * @brief Media duration.
  * @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
@@ -914,24 +802,6 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_DATETAKEN "MEDIA_DATETAKEN"
 
 /**
- * @deprecated Deprecated since 5.5.
- * @brief Media orientation.
- * @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_ORIENTATION "MEDIA_ORIENTATION"
-
-/**
- * @deprecated Deprecated since 5.5.
- * @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
- *
- */
-#define MEDIA_RATING "MEDIA_RATING"
-
-/**
  * @brief The time to register favourite.
  * @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
@@ -950,53 +820,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 3 types:\n
- *               0-internal storage, 1-SD card, 2-USB storage\n
- *               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_STORAGE_TYPE "MEDIA_STORAGE_TYPE"
-
-/**
- * @deprecated Deprecated since 5.5.
- * @brief Media exposure time.
- * @details You can use above define to set the condition of media filter and order keyword.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- *
- */
-#define MEDIA_EXPOSURE_TIME "MEDIA_EXPOSURE_TIME"
-
-/**
- * @deprecated Deprecated since 5.5.
- * @brief Media fnumber.
- * @details You can use above define to set the condition of media filter and order keyword.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- *
- */
-#define MEDIA_FNUMBER "MEDIA_FNUMBER"
-
-/**
- * @deprecated Deprecated since 5.5.
- * @brief Media ISO.
- * @details You can use above define to set the condition of media filter and order keyword.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- *
- */
-#define MEDIA_ISO "MEDIA_ISO"
-
-/**
- * @deprecated Deprecated since 5.5.
- * @brief Media model.
- * @details You can use above define to set the condition of media filter and order keyword.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- *
- */
-#define MEDIA_MODEL "MEDIA_MODEL"
-
-/**
+ * @deprecated Deprecated since 7.0.
  * @brief Media file 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
@@ -1008,6 +832,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_FILE_NAME_PINYIN "MEDIA_FILE_NAME_PINYIN"
 
 /**
+ * @deprecated Deprecated since 7.0.
  * @brief Media title 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
@@ -1019,6 +844,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_TITLE_PINYIN "MEDIA_TITLE_PINYIN"
 
 /**
+ * @deprecated Deprecated since 7.0.
  * @brief Media album 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
@@ -1030,6 +856,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_ALBUM_PINYIN "MEDIA_ALBUM_PINYIN"
 
 /**
+ * @deprecated Deprecated since 7.0.
  * @brief Media artist 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
@@ -1041,6 +868,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_ARTIST_PINYIN "MEDIA_ARTIST_PINYIN"
 
 /**
+ * @deprecated Deprecated since 7.0.
  * @brief Media album artist 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
@@ -1052,6 +880,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_ALBUM_ARTIST_PINYIN "MEDIA_ALBUM_ARTIST_PINYIN"
 
 /**
+ * @deprecated Deprecated since 7.0.
  * @brief Media genre 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
@@ -1063,6 +892,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_GENRE_PINYIN "MEDIA_GENRE_PINYIN"
 
 /**
+ * @deprecated Deprecated since 7.0.
  * @brief Media composer 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
@@ -1074,30 +904,6 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_COMPOSER_PINYIN "MEDIA_COMPOSER_PINYIN"
 
 /**
- * @deprecated Deprecated since 5.5.
- * @brief Media copyright 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_COPYRIGHT_PINYIN "MEDIA_COPYRIGHT_PINYIN"
-
-/**
- * @deprecated Deprecated since 5.5.
- * @brief Media description 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_DESCRIPTION_PINYIN "MEDIA_DESCRIPTION_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
@@ -1127,16 +933,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define FOLDER_NAME "FOLDER_NAME"
 
 /**
- * @deprecated Deprecated since 5.0.
- * @brief Folder storage.
- * @details There are 2 types:\n
- *               0-internal storage, 1-external storage\n
- *               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_STORAGE_TYPE "FOLDER_STORAGE_TYPE"
-
-/**
+ * @deprecated Deprecated since 7.0.
  * @brief Folder base name pinyin.
  * @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
@@ -1217,22 +1014,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
- */
-#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
- */
-#define MEDIA_STORAGE_PATH                             "STORAGE_PATH"
-
-/**
+ * @deprecated Deprecated since 8.0.
  * @brief Face tag.
  * @details You can use above define to set the condition of face filter and order keyword.
  * @since_tizen 3.0
@@ -1240,6 +1022,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 #define MEDIA_FACE_TAG "MEDIA_FACE_TAG"
 
 /**
+ * @deprecated Deprecated since 8.0.
  * @brief Face id.
  * @details You can use above define to set the condition of face filter and order keyword.
  * @since_tizen 4.0