[ACR-1820] Deprecate low usability fields
[platform/core/api/media-content.git] / doc / media_content_doc.h
index 3964554..83cb378 100755 (executable)
  *
  * @section CAPI_MEDIA_CONTENT_MODULE_OVERVIEW Overview
  * The Media Content API provides functions and enumerations used in the entire Content Service.\n
- * The information about media items i.e. image, audio and video, are managed in the content database and
+ * The information about media items i.e. image, audio, video and ebook, are managed in the content database and
  * operations that involve database requires an active connection with the media content service.\n
  * During media scanning, Media Service extract media information automatically. media information include basic file info like
  * path, size, modified time etc and some metadata like ID3tag, EXIF, thumbnail, etc. (thumbnail extracted only in Internal and SD card storage.) \n
- * Since 3.0, a thumbnail is not automatically extracted during media scanning. A thumbnail will be created only when media_info_create_thumbnail() is called by any application. \n
+ * Since 3.0, a thumbnail is not automatically extracted during media scanning. A thumbnail will be created only when media_info_generate_thumbnail() is called by any application. \n
  * Media content services do not manage hidden files. \n
  * The API provides functions for connecting (#media_content_connect()) and disconnecting (#media_content_disconnect()) from the media content service.
  *
  * </tr>
  * <tr>
  *    <td>@ref CAPI_CONTENT_MEDIA_GROUP_MODULE </td>
- *    <td> Provide information about the media group(e.g. media artist, composer, genre, year). </td>
+ *    <td> Provide information about the media group(e.g. media artist, album, genre, year). </td>
  * </tr>
  * <tr>
  *    <td>@ref CAPI_CONTENT_MEDIA_INFO_MODULE </td>
- *    <td> Provide generic information about media content items (i.e. image, audio, video and others).\n
+ *    <td> Provide generic information about media content items (i.e. image, audio, video, ebook and others).\n
  *  Provide details about audio files (e.g. name, genre etc) present in the device.\n
  *  Provide details about image files (e.g. width, height, orientation etc) present in the device.\n
- *  Provide details about video files (e.g. width, height, duration etc) present in the device .</td>
+ *  Provide details about video files (e.g. width, height, duration etc) present in the device.\n
+ *  Provide details about ebook files (e.g. subject, author etc) present in the device.</td>
  * </tr>
  * <tr>
  *    <td>@ref CAPI_CONTENT_MEDIA_PLAYLIST_MODULE </td>
  *   \#include <media_content.h>
  *
  * @section CAPI_CONTENT_MEDIA_FOLDER_MODULE_OVERVIEW Overview
- * A Folder is used to organize media content files i.e. image, audio, video files, in the physical storage of the device.
- * The Media Folder API provides functions to get basic information about existing folders e.g. folder name, path and storage type.
+ * A Folder is used to organize media content files i.e. image, audio, video, ebook files, in the physical storage of the device.
+ * The Media Folder API provides functions to get basic information about existing folders e.g. folder name, path and modified time.
  * It also provides functions to get information related to media items present in the folder.
  *
  * For getting information about folder call the respective get functions e.g. to get path and name of a given folder call #media_folder_get_path() and #media_folder_get_name() function respectively and so on.\n
 
 
 /**
- * @defgroup CAPI_CONTENT_MEDIA_TAG_MODULE Media Tag
+ * @defgroup CAPI_CONTENT_MEDIA_TAG_MODULE Media Tag (Deprecated)
  * @brief  The Media Tag API provides functions to manage media content tags.
  *
  * @ingroup CAPI_MEDIA_CONTENT_MODULE
  * </tr>
  * <tr>
  * <td>copyright</td>
- * <td>#MEDIA_COPYRIGHT</td>
+ * <td></td>
  * <td>Get from metadata if exist.</td>
  * </tr>
  * <tr>
  * </tr>
  * <tr>
  * <td>bit_rate</td>
- * <td>#MEDIA_BITRATE</td>
+ * <td></td>
  * <td>Bitrate</td>
  * </tr>
  * <tr>
  * <td>bitpersample</td>
- * <td>#MEDIA_BITPERSAMPLE</td>
+ * <td></td>
  * <td>Bit per sample</td>
  * </tr>
  * <tr>
  * <td>sample_rate</td>
- * <td>#MEDIA_SAMPLERATE</td>
+ * <td></td>
  * <td>Samplerate</td>
  * </tr>
  * <tr>
  * <td>channel</td>
- * <td>#MEDIA_CHANNEL</td>
+ * <td></td>
  * <td>Channel</td>
  * </tr>
  * <tr>
  * </tr>
  * <tr>
  * <td>rating</td>
- * <td>#MEDIA_RATING</td>
+ * <td></td>
  * <td>Get from metadata if exist.</td>
  * </tr>
  * </table>
  * </tr>
  * <tr>
  * <td>exposure_time</td>
- * <td>#MEDIA_EXPOSURE_TIME</td>
+ * <td></td>
  * <td>Get from EXIF if exist.</td>
  * </tr>
  * <tr>
  * <td>fnumber</td>
- * <td>#MEDIA_FNUMBER</td>
+ * <td></td>
  * <td>Get from EXIF if exist.</td>
  * </tr>
  * <tr>
  * <td>iso</td>
- * <td>#MEDIA_ISO</td>
+ * <td></td>
  * <td>Get from EXIF if exist.</td>
  * </tr>
  * <tr>
  * <td>model</td>
- * <td>#MEDIA_MODEL</td>
+ * <td></td>
  * <td>Get from EXIF if exist.</td>
  * </tr>
  * <tr>
  * </tr>
  * <tr>
  * <td>orientation</td>
- * <td>#MEDIA_ORIENTATION</td>
+ * <td></td>
  * <td>Get from EXIF if exist.</td>
  * </tr>
  * <tr>
 
 
 /**
- * @defgroup CAPI_CONTENT_MEDIA_VIDEO_META_MODULE Video Metadata
+ * @defgroup CAPI_CONTENT_MEDIA_VIDEO_META_MODULE Video Metadata (Deprecated)
  * @brief The Video Metadata API provides functions to get information about video files present in the device.
  *
  * @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
  *
  * @section CAPI_CONTENT_MEDIA_VIDEO_META_MODULE_OVERVIEW Overview
  * The Video Metadata API provides functions to get information about video files present in the device.
- * Following information about video content (#video_meta_h )is provided:
+ * Following information about video content (#video_meta_his provided:
  * <table>
  * <tr>
  * <th>Attribute</th>
  * </tr>
  * <tr>
  * <td>copyright</td>
- * <td>#MEDIA_COPYRIGHT</td>
+ * <td></td>
  * <td>Get from metadata if exist.</td>
  * </tr>
  * <tr>
  * </tr>
  * <tr>
  * <td>bit_rate</td>
- * <td>#MEDIA_BITRATE</td>
+ * <td></td>
  * <td>Bitrate</td>
  * </tr>
  * <tr>
  * <td>bitpersample</td>
- * <td>#MEDIA_BITPERSAMPLE</td>
+ * <td></td>
  * <td>Bit per sample</td>
  * </tr>
  * <tr>
  * <td>sample_rate</td>
- * <td>#MEDIA_SAMPLERATE</td>
+ * <td></td>
  * <td>Samplerate</td>
  * </tr>
  * <tr>
  * <td>channel</td>
- * <td>#MEDIA_CHANNEL</td>
+ * <td></td>
  * <td>Channel</td>
  * </tr>
  * <tr>
  * </tr>
  * <tr>
  * <td>rating</td>
- * <td>#MEDIA_RATING</td>
+ * <td></td>
  * <td>Get from metadata if exist.</td>
  * </tr>
  * <tr>
  * <td>rotation</td>
- * <td>#MEDIA_ORIENTATION</td>
+ * <td></td>
  * <td>Video rotation</td>
  * </tr>
  * <tr>
  *
  */
 
+
+/**
+ * @defgroup CAPI_CONTENT_MEDIA_BOOK_META_MODULE Book Metadata
+ * @brief The Book Metadata API provides functions to get information about ebook files present in the device.
+ *
+ * @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
+ *
+ * @section CAPI_CONTENT_MEDIA_BOOK_META_MODULE_HEADER Required Header
+ *   \#include <media_content.h>
+ *
+ * @section CAPI_CONTENT_MEDIA_BOOK_META_MODULE_OVERVIEW Overview
+ * The Book Metadata API provides functions to get information about book files present in the device.
+ * Following information about book content (#book_meta_h) is provided:
+ * <table>
+ * <tr>
+ * <th>Attribute</th>
+ * <th>Filter Keyword</th>
+ * <th>Comments</th>
+ * </tr>
+ * <tr>
+ * <td>subject</td>
+ * <td>#MEDIA_GENRE</td>
+ * <td>Get from metadata if exist.</td>
+ * </tr>
+ * <tr>
+ * <td>author</td>
+ * <td>#MEDIA_COMPOSER</td>
+ * <td>Get from metadata if exist.</td>
+ * </tr>
+ * <tr>
+ * <td>date</td>
+ * <td>#MEDIA_RECORDED_DATE</td>
+ * <td>Get from metadata if exist.</td>
+ * </tr>
+ * <tr>
+ * <td>publisher</td>
+ * <td></td>
+ * <td>Get from metadata if exist.</td>
+ * </tr>
+ * </table>
+ * \n
+ *<p>
+ * For getting the book handle (#book_meta_h) from the media information (#media_info_h), call the media_info_get_book() function.\n
+ * For getting the information related to book files stored in the device call the respective get functions e.g. to get author of the ebook file
+ * call #book_meta_get_author() function  and so on.\n
+ * When the book handle is no longer needed, it should be destroyed by calling #book_meta_destroy() function.
+ */
+
 /**
- * @defgroup CAPI_CONTENT_MEDIA_FACE_DETECTION_MODULE Face Detection
+ * @defgroup CAPI_CONTENT_MEDIA_FACE_DETECTION_MODULE Face Detection(Deprecated)
  * @brief The Face Detection API provides functions to detect face information about stored image files.
  *
  * @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
  *
  * To ensure your application is only running on a device with specific features, please define the features in your manifest file using the manifest editor in the SDK. \n
  *
- * More details on featuring your application can be found from <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#%3Cfeature%3E-element"><b>Feature Element</b>.</a>
+ * More details on featuring your application can be found from <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#feature-element"><b>Feature Element</b>.</a>
  *
  * @section CAPI_CONTENT_MEDIA_FACE_DETECTION_MODULE_OVERVIEW Overview
  * The Face Detection API provides functions to detect face information associated with image files. \n
  * Provide functions to get information (e.g. longitude, description, date etc) about the image files.</td>
  * </tr>
  * <tr>
- *    <td>@ref CAPI_CONTENT_MEDIA_VIDEO_META_MODULE </td>
+ *    <td>@ref CAPI_CONTENT_MEDIA_VIDEO_META_MODULE (Deprecated)</td>
  *    <td> Provides details about video items present in the device.\n
  * Provide functions to get information (e.g. duration, date etc) about the video files.</td>
  * </tr>
  * <td>Whether DRM content or not</td>
  * </tr>
  * <tr>
- * <td>storage_id</td>
- * <td>#MEDIA_STORAGE_ID</td>
- * <td>Storage UUID.</td>
- * </tr>
- * <tr>
- * <td>storage_type</td>
- * <td>#MEDIA_STORAGE_TYPE</td>
- * <td>Storage type (media_content_storage_e)</td>
- * </tr>
- * <tr>
  * <td>favorite</td>
  * <td>#MEDIA_FAVOURITE</td>
  * <td>User data. Not guarantee independence between applications.</td>
  * </tr>
  * <tr>
  * <td>description</td>
- * <td>#MEDIA_DESCRIPTION</td>
+ * <td></td>
  * <td>Get from metadata if exist.</td>
  * </tr>
  * </table>
  */
 
 /**
- * @defgroup CAPI_CONTENT_MEDIA_STORAGE_MODULE Media Storage
- * @brief The Media Storage Information API provides functions to manage storage  information on the media items.
- *
- * @ingroup CAPI_MEDIA_CONTENT_MODULE
- *
- * @section CAPI_CONTENT_MEDIA_STORAGE_MODULE_HEADER Required Header
- *   \#include <media_content.h>
- *
- * @section CAPI_CONTENT_MEDIA_STORAGE_MODULE_OVERVIEW Overview
- * A Storage allows you to manage external storage. \n
- * The system generates the storage id when the external storage is added. And the system manages the media information in each of the storage by using storage id. \n
- * So you can get the information from the storage that you want to view.
- *
- */
-
-/**
- * @defgroup CAPI_CONTENT_MEDIA_FACE_MODULE Media Face
+ * @defgroup CAPI_CONTENT_MEDIA_FACE_MODULE Media Face(Deprecated)
  * @brief The Media Face Information API provides functions to manage the face information in the image files.
  *
  * @ingroup CAPI_MEDIA_CONTENT_MODULE