[ACR-1635] Support ebook format

[platform/core/api/media-content.git] / doc / media_content_doc.h

diff --git a/doc/media_content_doc.h b/doc/media_content_doc.h
index d9a0678..d46c6bb 100755 (executable)
--- a/doc/media_content_doc.h
+++ b/doc/media_content_doc.h
@@ -29,7 +29,7 @@
  *
  * @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
@@ -74,10 +74,11 @@
  * </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>
@@ -103,7 +104,7 @@
  *   \#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.
+ * 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 storage type.
  * It also provides functions to get information related to media items present in the folder.
  *
@@ -621,7 +622,7 @@
  *
  * @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_h) is provided:
  * <table>
  * <tr>
  * <th>Attribute</th>
@@ -750,6 +751,54 @@
  *
  */
 
+
+/**
+ * @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>#MEDIA_COPYRIGHT</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
  * @brief The Face Detection API provides functions to detect face information about stored image files.
@@ -768,7 +817,7 @@
  *
  * 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://developer.tizen.org/development/tizen-studio/native-tools/configuring-your-app/manifest-text-editor#feature"><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