doc/media_content_doc.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17
  18 #ifndef __TIZEN_MEDIA_CONTENT_DOC_H__
  19 #define __TIZEN_MEDIA_CONTENT_DOC_H__
  20
  21 /**
  22  * @defgroup CAPI_MEDIA_CONTENT_MODULE Media Content
  23  * @brief The Media Content API provides functions, enumerations used in the entire Content Service.
  24  *
  25  * @ingroup CAPI_CONTENT_FRAMEWORK
  26  *
  27  * @section CAPI_MEDIA_CONTENT_MODULE_HEADER Required Header
  28  *   \#include <media_content.h>
  29  *
  30  * @section CAPI_MEDIA_CONTENT_MODULE_OVERVIEW Overview
  31  * The Media Content API provides functions and enumerations used in the entire Content Service.\n
  32  * The information about media items i.e. image, audio and video, are managed in the content database and
  33  * operations that involve database requires an active connection with the media content service.\n
  34  * During media scanning, Media Service extract media information automatically. media information include basic file info like
  35  * path, size, modified time etc and some metadata like ID3tag, EXIF, thumbnail, etc. (thumbnail extracted only in Internal and SD card storage.) \n
  36  * 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
  37  * Media content services do not manage hidden files. \n
  38  * The API provides functions for connecting (#media_content_connect()) and disconnecting (#media_content_disconnect()) from the media content service.
  39  *
  40  * The API consists of @ref CAPI_CONTENT_MEDIA_ALBUM_MODULE, @ref CAPI_CONTENT_MEDIA_BOOKMARK_MODULE, @ref CAPI_CONTENT_MEDIA_FACE_MODULE,
  41  * @ref CAPI_CONTENT_MEDIA_FILTER_MODULE, @ref CAPI_CONTENT_MEDIA_FOLDER_MODULE, @ref CAPI_CONTENT_MEDIA_GROUP_MODULE,
  42  * @ref CAPI_CONTENT_MEDIA_INFO_MODULE, @ref CAPI_CONTENT_MEDIA_PLAYLIST_MODULE, @ref CAPI_CONTENT_MEDIA_TAG_MODULE API.
  43  *
  44  * <table>
  45  * <tr>
  46  *    <th>API</th>
  47  *    <th>Description</th>
  48  * </tr>
  49  * <tr>
  50  *    <td>@ref CAPI_CONTENT_MEDIA_ALBUM_MODULE </td>
  51  *    <td> Provide information about the media album. </td>
  52  * </tr>
  53  * <tr>
  54  *    <td>@ref CAPI_CONTENT_MEDIA_BOOKMARK_MODULE </td>
  55  *    <td> Provide information about the media bookmark. </td>
  56  * </tr>
  57  * <tr>
  58  *    <td>@ref CAPI_CONTENT_MEDIA_FACE_MODULE </td>
  59  *    <td> Provide information about the detected faces from image. </td>
  60  * </tr>
  61  * <tr>
  62  *    <td>@ref CAPI_CONTENT_MEDIA_FILTER_MODULE </td>
  63  *    <td> Provide functions for creating and destroying media filters.\n
  64  * Provide functions to get filter properties</td>
  65  * </tr>
  66  * <tr>
  67  *    <td>@ref CAPI_CONTENT_MEDIA_FOLDER_MODULE </td>
  68  *    <td> Provide information about folders (e.g. path, name, modification date) stored on the device.\n
  69  * Provide information about the media items present in the folders.</td>
  70  * </tr>
  71  * <tr>
  72  *    <td>@ref CAPI_CONTENT_MEDIA_GROUP_MODULE </td>
  73  *    <td> Provide information about the media group(e.g. media artist, composer, genre, year). </td>
  74  * </tr>
  75  * <tr>
  76  *    <td>@ref CAPI_CONTENT_MEDIA_INFO_MODULE </td>
  77  *    <td> Provide generic information about media content items (i.e. image, audio, video and others).\n
  78  *  Provide details about audio files (e.g. name, genre etc) present in the device.\n
  79  *  Provide details about image files (e.g. width, height, orientation etc) present in the device.\n
  80  *  Provide details about video files (e.g. width, height, duration etc) present in the device .</td>
  81  * </tr>
  82  * <tr>
  83  *    <td>@ref CAPI_CONTENT_MEDIA_PLAYLIST_MODULE </td>
  84  *    <td> Provide information about the media playlist. </td>
  85  * </tr>
  86  * <tr>
  87  *    <td>@ref CAPI_CONTENT_MEDIA_TAG_MODULE </td>
  88  *    <td> Provide information about media tags.\n
  89  * Provide functions to insert or delete tag from database.\n
  90  * Provide functions to add and remove media item from tags in the database. </td>
  91  * </tr>
  92  * </table>
  93  *
  94  */
  95
  96 /**
  97  * @defgroup CAPI_CONTENT_MEDIA_FOLDER_MODULE Media Folder
  98  * @brief The Media folder API provides functions to get information about folders.
  99  *
 100  * @ingroup CAPI_MEDIA_CONTENT_MODULE
 101  *
 102  * @section CAPI_CONTENT_MEDIA_FOLDER_MODULE_HEADER Required Header
 103  *   \#include <media_content.h>
 104  *
 105  * @section CAPI_CONTENT_MEDIA_FOLDER_MODULE_OVERVIEW Overview
 106  * A Folder is used to organize media content files i.e. image, audio, video files, in the physical storage of the device.
 107  * The Media Folder API provides functions to get basic information about existing folders e.g. folder name, path and storage type.
 108  * It also provides functions to get information related to media items present in the folder.
 109  *
 110  * 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
 111  * Similarly call media_folder_get_media_count_from_db() to get count of media items present in a given folder.
 112  * @subsection CAPI_CONTENT_MEDIA_FOLDER_FOREACH_OPERATIONS Foreach Operations
 113  * <div><table class="doxtable">
 114  *     <tr>
 115  *        <th><b>FOREACH</b></th>
 116  *        <th><b>CALLBACK</b></th>
 117  *        <th><b>DESCRIPTION</b></th>
 118  *     </tr>
 119  *     <tr>
 120  *        <td>media_folder_foreach_folder_from_db()</td>
 121  *        <td>media_folder_cb()</td>
 122  *        <td>Iterates over a folder information list</td>
 123  *     </tr>
 124  *     <tr>
 125  *        <td>media_folder_foreach_media_from_db()</td>
 126  *        <td>media_info_cb()</td>
 127  *        <td>Iterates media information trough the folder</td>
 128  *     </tr>
 129  * </table></div>
 130  *
 131  *
 132  */
 133
 134
 135 /**
 136  * @defgroup CAPI_CONTENT_MEDIA_TAG_MODULE Media Tag
 137  * @brief  The Media Tag API provides functions to manage media content tags.
 138  *
 139  * @ingroup CAPI_MEDIA_CONTENT_MODULE
 140  *
 141  * @section CAPI_CONTENT_MEDIA_TAG_MODULE_HEADER Required Header
 142  *   \#include <media_content.h>
 143  *
 144  * @section CAPI_CONTENT_MEDIA_TAG_MODULE_OVERVIEW Overview
 145  * A Tag is a special piece of information that may be associated with media content items.
 146  * Tagging allows a user to organize large number of items into logical groups providing a simplified
 147  * and faster way of accessing media content items.\n\n
 148  * Media Tag API provides functions to get basic information about existing tags and manage tags
 149  * associated with Media Information (#media_info_h).
 150  * For inserting a new tag to the database call #media_tag_insert_to_db() function and for deleting existing tag from database
 151  * call media_tag_delete_from_db() function.\n
 152  * A Media item can be associated and dissociated from tags by calling #media_tag_add_media() and #media_tag_remove_media() function respectively.
 153  * Finally, #media_tag_update_to_db function should be called so as to update the given item in the media database.
 154  *
 155  * @subsection CAPI_CONTENT_MEDIA_TAG_FOREACH_OPERATIONS Foreach Operations
 156  * <div><table class="doxtable">
 157  *     <tr>
 158  *        <th><b>FOREACH</b></th>
 159  *        <th><b>CALLBACK</b></th>
 160  *        <th><b>DESCRIPTION</b></th>
 161  *     </tr>
 162  *     <tr>
 163  *        <td>media_tag_foreach_tag_from_db()</td>
 164  *        <td> media_tag_cb()</td>
 165  *        <td>Iterates through tags</td>
 166  *     </tr>
 167  *     <tr>
 168  *        <td>media_tag_foreach_media_from_db()</td>
 169  *        <td>media_info_cb()</td>
 170  *        <td> Iterates through the media items for a given tag
 171  </td>
 172  *     </tr>
 173  * </table></div>
 174  *
 175  *
 176  *
 177  */
 178
 179
 180 /**
 181  * @defgroup CAPI_CONTENT_MEDIA_FILTER_MODULE Media Filter
 182  * @brief The Media Filter API provides functions to manage media filters.
 183  *
 184  * @ingroup CAPI_MEDIA_CONTENT_MODULE
 185  *
 186  * @section CAPI_CONTENT_MEDIA_FILTER_MODULE_HEADER Required Header
 187  *   \#include <media_content.h>
 188  *
 189  * @section CAPI_CONTENT_MEDIA_FILTER_MODULE_OVERVIEW Overview
 190  * A Media filter is required for filtering information associated with media Folder, Tag, Audio, Bookmark and Media Information on basis of details like offset, count, order and condition for searching.\n
 191  * @ref CAPI_CONTENT_MEDIA_FILTER_MODULE API provides functions for creating and destroying media filters. \n
 192  * It provide functions to set properties and also provide functions for getting filter properties associated with a given media filter.
 193  *
 194  *\n
 195  * Setting media filter properties helps to limit the number of filtered items as following:
 196  * - Offset - Used to set starting position of the filter's search
 197  * - Count - Used to set number of items to be searched from offset
 198  * - Condition - Used to set keyword which user want to search
 199  * - Order - Used to set type of media to be ordered by the filter
 200  *
 201  *\n
 202  * The Media Filter API provides functions for creating and destroying media filters.\n
 203  * It provide functions to set and get properties of the filter associated with a given media filter. \n
 204  * For creating a media filter (@ref filter_h), call #media_filter_create() function and call #media_filter_destroy() function for destroying an existing filter. \n
 205  * For setting filter properties call the respective set functions e.g. to set offset position, call #media_filter_set_offset() function and
 206  * call #media_filter_set_condition() function to set the condition like an sql "where" clause. \n
 207  * Searchable expression can use one of the following forms:
 208  *
 209  *
 210  * - column = value
 211  * - column > value
 212  * - column >= value
 213  * - column < value
 214  * - column <= value
 215  * - value = column
 216  * -  * - value > column
 217  * - value >= column
 218  * - value < column
 219  * - value <= column
 220  * - column IN (value)
 221  * - column IN (value-list)
 222  * - column NOT IN (value)
 223  * - column NOT IN (value-list)
 224  * - column LIKE value
 225  * - expression1 AND expression2 OR expression3
 226  *
 227  *\n
 228  *
 229  * Note that if you want to set qoutation(" ' " or " " ") as value of LIKE operator, you should use two times.(" '' " or " "" ") \n
 230  * And the optional ESCAPE clause is supported. Both percent symbol("%") and underscore symbol("_") are used in the LIKE pattern.\n
 231  * If these characters are used as value of LIKE operation, then the expression following the ESCAPE clause of sqlite will be ignored. \n
 232  *
 233  * For example,
 234  * - column LIKE ('#%') ESCAPE('#') - "#" is escape character, it will be ignored.
 235  *\n
 236  *
 237  *
 238  * Similarly, call respective get function to get filter properties e.g. call #media_filter_get_condition() function
 239  * to get condition of the media filter and call #media_filter_get_order() function to get order (#media_content_order_e) of the filtered items and so on.
 240  *
 241  * @section CAPI_CONTENT_MEDIA_FILTER_MODULE_EXAMPLE Example
 242  * You can set the filter as follows.
 243  * @code
 244  *
 245  * #include <stdio.h>
 246  * #include <string.h>
 247  * #include <media_content.h>
 248  *
 249  * #define MAX_QUERY_LEN 512
 250  * #define DLOG_TAG "media-content-test"
 251  *
 252  * filter_h g_filter = NULL;
 253  *
 254  * int create_filter()
 255  * {
 256  *     int ret = MEDIA_CONTENT_ERROR_NONE;
 257  *     char condition[MAX_QUERY_LEN] = {0,};
 258  *
 259  *     snprintf(condition,sizeof(condition),"%s = 0",MEDIA_TYPE);
 260  *
 261  *     ret = media_filter_create(&g_filter);
 262  *     ret = media_filter_set_condition(g_filter, condition, MEDIA_CONTENT_COLLATE_DEFAULT);
 263  *     ret = media_filter_set_order(g_filter, MEDIA_CONTENT_ORDER_DESC, MEDIA_ARTIST, MEDIA_CONTENT_COLLATE_DEFAULT);
 264  *
 265  *     return ret;
 266  * }
 267  *
 268  * @endcode
 269  * And you can use the created filter as follows.
 270  * @code
 271  *
 272  * int get_media_count()
 273  * {
 274  *     int ret = MEDIA_CONTENT_ERROR_NONE;
 275  *     int media_cnt = 0;
 276  *
 277  *     ret = media_info_get_media_count_from_db(g_filter, &media_cnt);
 278  *     dlog_print(DLOG_DEBUG, DLOG_TAG, "media count [%d]\n", media_cnt);
 279  *
 280  *     return ret;
 281  * }
 282  *
 283  * @endcode
 284  */
 285
 286
 287 /**
 288  * @defgroup CAPI_CONTENT_MEDIA_AUDIO_META_MODULE Audio Metadata
 289  * @brief The Audio Metadata API provides functions to get information about audio items.
 290  *
 291  * @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
 292  *
 293  * @section CAPI_CONTENT_MEDIA_AUDIO_META_MODULE_HEADER Required Header
 294  *   \#include <media_content.h>
 295  *
 296  * @section CAPI_CONTENT_MEDIA_AUDIO_META_MODULE_OVERVIEW Overview
 297  * The Audio Metadata API provides functions to get information about stored audio files.
 298  * Its purpose is twofold:
 299  * - to provide information about audio content
 300  * - to organize audio content logically (grouping)
 301  *
 302  * API provides functions that allow to check attributes of audio files. Following information about audio content is provided:
 303  *
 304  * <table>
 305  * <tr>
 306  * <th>Attribute</th>
 307  * <th>Filter Keyword</th>
 308  * <th>Comments</th>
 309  * </tr>
 310  * <tr>
 311  * <td>album</td>
 312  * <td>#MEDIA_ALBUM</td>
 313  * <td>Get from metadata if exist.</td>
 314  * </tr>
 315  * <tr>
 316  * <td>artist</td>
 317  * <td>#MEDIA_ARTIST</td>
 318  * <td>Get from metadata if exist.</td>
 319  * </tr>
 320  * <tr>
 321  * <td>album_artist</td>
 322  * <td>#MEDIA_ALBUM_ARTIST</td>
 323  * <td>Get from metadata if exist.</td>
 324  * </tr>
 325  * <tr>
 326  * <td>genre</td>
 327  * <td>#MEDIA_GENRE</td>
 328  * <td>Get from metadata if exist.</td>
 329  * </tr>
 330  * <tr>
 331  * <td>composer</td>
 332  * <td>#MEDIA_COMPOSER</td>
 333  * <td>Get from metadata if exist.</td>
 334  * </tr>
 335  * <tr>
 336  * <td>year</td>
 337  * <td>#MEDIA_YEAR</td>
 338  * <td>Get from metadata if exist.</td>
 339  * </tr>
 340  * <tr>
 341  * <td>recorded_date</td>
 342  * <td>#MEDIA_RECORDED_DATE</td>
 343  * <td>Get from metadata if exist. if not, same as modified time.</td>
 344  * </tr>
 345  * <tr>
 346  * <td>copyright</td>
 347  * <td>#MEDIA_COPYRIGHT</td>
 348  * <td>Get from metadata if exist.</td>
 349  * </tr>
 350  * <tr>
 351  * <td>track_num</td>
 352  * <td>#MEDIA_TRACK_NUM</td>
 353  * <td>Get from metadata if exist.</td>
 354  * </tr>
 355  * <tr>
 356  * <td>bit_rate</td>
 357  * <td>#MEDIA_BITRATE</td>
 358  * <td>Bitrate</td>
 359  * </tr>
 360  * <tr>
 361  * <td>bitpersample</td>
 362  * <td>#MEDIA_BITPERSAMPLE</td>
 363  * <td>Bit per sample</td>
 364  * </tr>
 365  * <tr>
 366  * <td>sample_rate</td>
 367  * <td>#MEDIA_SAMPLERATE</td>
 368  * <td>Samplerate</td>
 369  * </tr>
 370  * <tr>
 371  * <td>channel</td>
 372  * <td>#MEDIA_CHANNEL</td>
 373  * <td>Channel</td>
 374  * </tr>
 375  * <tr>
 376  * <td>duration</td>
 377  * <td>#MEDIA_DURATION</td>
 378  * <td>Duration</td>
 379  * </tr>
 380  * <tr>
 381  * <td>rating</td>
 382  * <td>#MEDIA_RATING</td>
 383  * <td>Get from metadata if exist.</td>
 384  * </tr>
 385  * </table>
 386  * \n
 387  *
 388  * <p>
 389  * For getting the audio handle (#audio_meta_h) from the media information (#media_info_h), call #media_info_get_audio() function.\n
 390  * For getting the information related to audio files stored in the device, call the respective get functions e.g. to get the artist of a audio, call #audio_meta_get_artist() function and
 391  * to get bitrate of a audio, call #audio_meta_get_bit_rate() function and so on.\n
 392  * When the audio handle is no longer needed, it should be destroyed by calling #audio_meta_destroy() function.\n
 393  *
 394  *
 395  *
 396  */
 397
 398
 399 /**
 400  * @defgroup CAPI_CONTENT_MEDIA_PLAYLIST_MODULE Media Playlist
 401  * @brief The Media Playlist API provides functions to manage media playlists.
 402  *
 403  * @ingroup CAPI_MEDIA_CONTENT_MODULE
 404  *
 405  * @section CAPI_CONTENT_MEDIA_PLAYLIST_MODULE_HEADER Required Header
 406  *   \#include <media_content.h>
 407  *
 408  * @section CAPI_CONTENT_MEDIA_PLAYLIST_MODULE_OVERVIEW Overview
 409  * A Playlist is a list of songs which can be played in some sequence i.e. sequential or shuffled order.
 410  * The Media Playlist API provides functions to insert, delete or updates a media playlist in the database.
 411  *
 412  * For inserting new playlist (#media_playlist_h) in the database, call  #media_playlist_insert_to_db() function and call #media_playlist_delete_from_db() function
 413  * to delete a playlist from the database.\n
 414  * For adding a media item to the playlist, call #media_playlist_add_media() function, for removing a media item from the playlist, call
 415  * #media_playlist_remove_media() function.\n
 416  * Finally, #media_playlist_update_to_db() function should be called so as to update the given item in the media database.
 417  *
 418  * @subsection CAPI_CONTENT_MEDIA_PLAYLIST_FOREACH_OPERATIONS Foreach Operations
 419  * <div><table class="doxtable">
 420  *     <tr>
 421  *        <th><b>FOREACH</b></th>
 422  *        <th><b>CALLBACK</b></th>
 423  *        <th><b>DESCRIPTION</b></th>
 424  *     </tr>
 425  *     <tr>
 426  *        <td>media_playlist_foreach_playlist_from_db()</td>
 427  *        <td>media_playlist_cb()</td>
 428  *        <td>Iterates through playlist</td>
 429  *     </tr>
 430  *     <tr>
 431  *        <td>media_playlist_foreach_media_from_db()</td>
 432  *        <td>media_info_cb()</td>
 433  *        <td>Iterates through playlist's items</td>
 434  *     </tr>
 435  * </table></div>
 436  *
 437  *
 438  */
 439
 440
 441 /**
 442  * @defgroup CAPI_CONTENT_MEDIA_ALBUM_MODULE Media Album
 443  * @brief The Media Album API provides information related to album of media items.
 444  *
 445  * @ingroup CAPI_MEDIA_CONTENT_MODULE
 446  *
 447  * @section CAPI_CONTENT_MEDIA_ALBUM_MODULE_HEADER Required Header
 448  *   \#include <media_content.h>
 449  *
 450  * @section CAPI_CONTENT_MEDIA_ALBUM_MODULE_OVERVIEW Overview
 451  * An album is a logical collection or grouping of related audio files. It is also used for filtering media items.\n
 452  * The Media Album API allows to manage media albums which contains all video and audio items from
 453  * the same album.
 454  *
 455  * The API provides functions to get and search media items in album group.
 456  * For getting the count of media items associated with a given album, call #media_album_get_media_count_from_db() function.
 457  *
 458  * @subsection CAPI_CONTENT_MEDIA_ALBUM_FOREACH_OPERATIONS Foreach Operations
 459  * <div><table class="doxtable">
 460  *     <tr>
 461  *        <th><b>FOREACH</b></th>
 462  *        <th><b>CALLBACK</b></th>
 463  *        <th><b>DESCRIPTION</b></th>
 464  *     </tr>
 465  *     <tr>
 466  *        <td>media_album_foreach_album_from_db()</td>
 467  *        <td>media_album_cb()</td>
 468  *        <td>Iterates through albums</td>
 469  *     </tr>
 470  *     <tr>
 471  *        <td>media_album_foreach_media_from_db()</td>
 472  *        <td>media_info_cb()</td>
 473  *        <td>Iterates through album's items</td>
 474  *     </tr>
 475  * </table></div>
 476  *
 477  *
 478  */
 479
 480
 481 /**
 482  * @defgroup CAPI_CONTENT_MEDIA_GROUP_MODULE Media Group
 483  * @brief The Media Group API provides information related to artist of media group.
 484  *
 485  * @ingroup CAPI_MEDIA_CONTENT_MODULE
 486  *
 487  * @section CAPI_CONTENT_MEDIA_GROUP_MODULE_HEADER Required Header
 488  *   \#include <media_content.h>
 489  *
 490  * @section CAPI_CONTENT_MEDIA_GROUP_MODULE_OVERVIEW Overview
 491  * A Media Group represents logical grouping of media files with respect to their group name. It is also used for filtering media items.\n
 492  *
 493  * The API provides functions to get and search image, video and audio items in media group.
 494  * For getting the count of media items associated with a given group, call #media_group_get_media_count_from_db() function.
 495  *
 496  *
 497  * @subsection CAPI_CONTENT_MEDIA_GROUP_FOREACH_OPERATIONS Foreach Operations
 498  * <div><table class="doxtable">
 499  *      <tr>
 500  *         <th><b>FOREACH</b></th>
 501  *         <th><b>CALLBACK</b></th>
 502  *         <th><b>DESCRIPTION</b></th>
 503  *      </tr>
 504  *      <tr>
 505  *         <td>media_group_foreach_group_from_db()</td>
 506  *         <td> media_group_cb()</td>
 507  *         <td>Iterates through group</td>
 508  *      </tr>
 509  *      <tr>
 510  *         <td>media_group_foreach_media_from_db()</td>
 511  *         <td>media_info_cb()</td>
 512  *         <td>Iterates through group's items</td>
 513  *      </tr>
 514  * </table></div>
 515  *
 516  *
 517  */
 518
 519
 520 /**
 521  * @defgroup CAPI_CONTENT_MEDIA_IMAGE_META_MODULE Image Metadata
 522  * @brief The Image Metadata API provides functions that allow to get information about
 523  * stored image files.
 524  *
 525  * @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
 526  *
 527  * @section CAPI_CONTENT_MEDIA_IMAGE_META_MODULE_HEADER Required Header
 528  *   \#include <media_content.h>
 529  *
 530  * @section CAPI_CONTENT_MEDIA_IMAGE_META_MODULE_OVERVIEW Overview
 531  * The Image Metadata API provides functions to get basic information associated with image files:
 532  * <table>
 533  * <tr>
 534  * <th>Attribute</th>
 535  * <th>Filter Keyword</th>
 536  * <th>Comments</th>
 537  * </tr>
 538  * <tr>
 539  * <td>width</td>
 540  * <td>#MEDIA_WIDTH</td>
 541  * <td>Width</td>
 542  * </tr>
 543  * <tr>
 544  * <td>height</td>
 545  * <td>#MEDIA_HEIGHT</td>
 546  * <td>Height</td>
 547  * </tr>
 548  * <tr>
 549  * <td>longitude</td>
 550  * <td>#MEDIA_LONGITUDE</td>
 551  * <td>Get from metadata if exist.</td>
 552  * </tr>
 553  * <tr>
 554  * <td>latitude</td>
 555  * <td>#MEDIA_LATITUDE</td>
 556  * <td>Get from metadata if exist.</td>
 557  * </tr>
 558  * <tr>
 559  * <td>altitude</td>
 560  * <td>#MEDIA_ALTITUDE</td>
 561  * <td>Get from metadata if exist.</td>
 562  * </tr>
 563  * <tr>
 564  * <td>exposure_time</td>
 565  * <td>#MEDIA_EXPOSURE_TIME</td>
 566  * <td>Get from EXIF if exist.</td>
 567  * </tr>
 568  * <tr>
 569  * <td>fnumber</td>
 570  * <td>#MEDIA_FNUMBER</td>
 571  * <td>Get from EXIF if exist.</td>
 572  * </tr>
 573  * <tr>
 574  * <td>iso</td>
 575  * <td>#MEDIA_ISO</td>
 576  * <td>Get from EXIF if exist.</td>
 577  * </tr>
 578  * <tr>
 579  * <td>model</td>
 580  * <td>#MEDIA_MODEL</td>
 581  * <td>Get from EXIF if exist.</td>
 582  * </tr>
 583  * <tr>
 584  * <td>date_taken</td>
 585  * <td>#MEDIA_DATETAKEN</td>
 586  * <td>Get from EXIF if exist.</td>
 587  * </tr>
 588  * <tr>
 589  * <td>orientation</td>
 590  * <td>#MEDIA_ORIENTATION</td>
 591  * <td>Get from EXIF if exist.</td>
 592  * </tr>
 593  * <tr>
 594  * <td>is_360_content</td>
 595  * <td>#MEDIA_360</td>
 596  * <td>Whether 360 content or not.</td>
 597  * </tr>
 598  * </table>
 599  *
 600  * \n
 601  *
 602  *<p>
 603  * For getting the image handle (#image_meta_h) from the media information (#media_info_h), call #media_info_get_image() function.\n
 604  * For getting the information related to image files stored in the device call the respective get functions e.g. to get the width of a image, call #image_meta_get_width() function and
 605  * to get orientation (#media_content_orientation_e) of a image, call #image_meta_get_orientation() function and so on.\n
 606  * When the image handle is no longer needed, it should be destroyed by calling #image_meta_destroy() function.\n
 607  *
 608  */
 609
 610
 611
 612
 613 /**
 614  * @defgroup CAPI_CONTENT_MEDIA_VIDEO_META_MODULE Video Metadata
 615  * @brief The Video Metadata API provides functions to get information about video files present in the device.
 616  *
 617  * @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
 618  *
 619  * @section CAPI_CONTENT_MEDIA_VIDEO_META_MODULE_HEADER Required Header
 620  *   \#include <media_content.h>
 621  *
 622  * @section CAPI_CONTENT_MEDIA_VIDEO_META_MODULE_OVERVIEW Overview
 623  * The Video Metadata API provides functions to get information about video files present in the device.
 624  * Following information about video content (#video_meta_h )is provided:
 625  * <table>
 626  * <tr>
 627  * <th>Attribute</th>
 628  * <th>Filter Keyword</th>
 629  * <th>Comments</th>
 630  * </tr>
 631  * <tr>
 632  * <td>album</td>
 633  * <td>#MEDIA_ALBUM</td>
 634  * <td>Get from metadata if exist.</td>
 635  * </tr>
 636  * <tr>
 637  * <td>artist</td>
 638  * <td>#MEDIA_ARTIST</td>
 639  * <td>Get from metadata if exist.</td>
 640  * </tr>
 641  * <tr>
 642  * <td>album_artist</td>
 643  * <td>#MEDIA_ALBUM_ARTIST</td>
 644  * <td>Get from metadata if exist.</td>
 645  * </tr>
 646  * <tr>
 647  * <td>genre</td>
 648  * <td>#MEDIA_GENRE</td>
 649  * <td>Get from metadata if exist.</td>
 650  * </tr>
 651  * <tr>
 652  * <td>composer</td>
 653  * <td>#MEDIA_COMPOSER</td>
 654  * <td>Get from metadata if exist.</td>
 655  * </tr>
 656  * <tr>
 657  * <td>year</td>
 658  * <td>#MEDIA_YEAR</td>
 659  * <td>Get from metadata if exist.</td>
 660  * </tr>
 661  * <tr>
 662  * <td>recorded_date</td>
 663  * <td>#MEDIA_RECORDED_DATE</td>
 664  * <td>Get from metadata if exist. if not, same as modified time.</td>
 665  * </tr>
 666  * <tr>
 667  * <td>copyright</td>
 668  * <td>#MEDIA_COPYRIGHT</td>
 669  * <td>Get from metadata if exist.</td>
 670  * </tr>
 671  * <tr>
 672  * <td>track_num</td>
 673  * <td>#MEDIA_TRACK_NUM</td>
 674  * <td>Get from metadata if exist.</td>
 675  * </tr>
 676  * <tr>
 677  * <td>bit_rate</td>
 678  * <td>#MEDIA_BITRATE</td>
 679  * <td>Bitrate</td>
 680  * </tr>
 681  * <tr>
 682  * <td>bitpersample</td>
 683  * <td>#MEDIA_BITPERSAMPLE</td>
 684  * <td>Bit per sample</td>
 685  * </tr>
 686  * <tr>
 687  * <td>sample_rate</td>
 688  * <td>#MEDIA_SAMPLERATE</td>
 689  * <td>Samplerate</td>
 690  * </tr>
 691  * <tr>
 692  * <td>channel</td>
 693  * <td>#MEDIA_CHANNEL</td>
 694  * <td>Channel</td>
 695  * </tr>
 696  * <tr>
 697  * <td>duration</td>
 698  * <td>#MEDIA_DURATION</td>
 699  * <td>Duration</td>
 700  * </tr>
 701  * <tr>
 702  * <td>rating</td>
 703  * <td>#MEDIA_RATING</td>
 704  * <td>Get from metadata if exist.</td>
 705  * </tr>
 706  * <tr>
 707  * <td>rotation</td>
 708  * <td>#MEDIA_ORIENTATION</td>
 709  * <td>Video rotation</td>
 710  * </tr>
 711  * <tr>
 712  * <td>width</td>
 713  * <td>#MEDIA_WIDTH</td>
 714  * <td>Width</td>
 715  * </tr>
 716  * <tr>
 717  * <td>height</td>
 718  * <td>#MEDIA_HEIGHT</td>
 719  * <td>Height</td>
 720  * </tr>
 721  * <tr>
 722  * <td>longitude</td>
 723  * <td>#MEDIA_LONGITUDE</td>
 724  * <td>Get from metadata if exist.</td>
 725  * </tr>
 726  * <tr>
 727  * <td>latitude</td>
 728  * <td>#MEDIA_LATITUDE</td>
 729  * <td>Get from metadata if exist.</td>
 730  * </tr>
 731  * <tr>
 732  * <td>altitude</td>
 733  * <td>#MEDIA_ALTITUDE</td>
 734  * <td>Get from metadata if exist.</td>
 735  * </tr>
 736  * <tr>
 737  * <td>is_360_content</td>
 738  * <td>#MEDIA_360</td>
 739  * <td>Whether 360 content or not.</td>
 740  * </tr>
 741  * </table>
 742  * \n
 743  *<p>
 744  * For getting the video handle (#video_meta_h) from the media information (#media_info_h), call the media_info_get_video() function.\n
 745  * For getting the information related to video files stored in the device call the respective get functions e.g. to get duration of the video file
 746  * call #video_meta_get_duration() function  and so on.\n
 747  * When the video handle is no longer needed, it should be destroyed by calling #video_meta_destroy() function.
 748  *
 749  *
 750  *
 751  */
 752
 753 /**
 754  * @defgroup CAPI_CONTENT_MEDIA_FACE_DETECTION_MODULE Face Detection
 755  * @brief The Face Detection API provides functions to detect face information about stored image files.
 756  *
 757  * @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
 758  *
 759  * @section CAPI_CONTENT_MEDIA_FACE_DETECTION_MODULE_HEADER Required Header
 760  *   \#include <media_content.h>
 761  *
 762  * @section CAPI_CONTENT_MEDIA_FACE_DETECTION_MODULE_FEATURE Related Features
 763  * This API is related with the following feature: \n
 764  * - %http://tizen.org/feature/vision.face_recognition
 765  * It is recommended to create applications with regard to features, to increase reliability. \n
 766  *
 767  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application. \n
 768  *
 769  * 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
 770  *
 771  * 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>
 772  *
 773  * @section CAPI_CONTENT_MEDIA_FACE_DETECTION_MODULE_OVERVIEW Overview
 774  * The Face Detection API provides functions to detect face information associated with image files. \n
 775  * Face information detected by mediavision API. To detect faces, you should use media_info_start_face_detection() API. \n
 776  *
 777  * API allows to:
 778  * - start and cancel face detection with image files
 779  *
 780  *<p>
 781  * To start face detection, call the #media_info_start_face_detection() function.\n
 782  * To cancel face detection after it's been started, call the #media_info_cancel_face_detection() function.\n
 783  *
 784  */
 785
 786 /**
 787  * @defgroup CAPI_CONTENT_MEDIA_BOOKMARK_MODULE Media Bookmark
 788  * @brief The Media Bookmark Information API provides functions to manage bookmark information on the media items.
 789  *
 790  * @ingroup CAPI_MEDIA_CONTENT_MODULE
 791  *
 792  * @section CAPI_CONTENT_MEDIA_BOOKMARKINFO_MODULE_HEADER Required Header
 793  *   \#include <media_content.h>
 794  *
 795  * @section CAPI_CONTENT_MEDIA_BOOKMARKINFO_MODULE_OVERVIEW Overview
 796  * A Bookmark allows you to mark interesting moment in a media(video and audio) to enable fast searching.
 797  * The Bookmark Information API  provides functions to get information about bookmarks associated with video and audio items.
 798  *
 799  * API allows to:
 800  * - get and filter existing bookmarks
 801  * - insert new bookmarks
 802  * - delete bookmarks
 803  *
 804  * For inserting a bookmark to media item, call media_bookmark_insert_to_db() function and for deleting already set bookmark from a media, call
 805  * #media_bookmark_delete_from_db() function.
 806  * For retrieving time where the bookmark is placed on the media, call #media_bookmark_get_marked_time() function.
 807  *
 808  * @subsection CAPI_CONTENT_MEDIA_BOOKMARKINFO_FOREACH_OPERATIONS Foreach Operations
 809  * <div><table class="doxtable" >
 810  *     <tr>
 811  *        <th><b>FOREACH</b></th>
 812  *        <th><b>CALLBACK</b></th>
 813  *        <th><b>DESCRIPTION</b></th>
 814  *     </tr>
 815  *     <tr>
 816  *        <td>media_info_foreach_bookmark_from_db()</td>
 817  *        <td>media_bookmark_cb()</td>
 818  *        <td>Iterates through bookmarks</td>
 819  *     </tr>
 820  *</table></div>
 821  *
 822  *
 823  */
 824
 825 /**
 826  * @defgroup CAPI_CONTENT_MEDIA_INFO_MODULE Media Information
 827  * @brief The Media Information API provides functions to get information about media items
 828  * stored on an internal and external storage.
 829  *
 830  * @ingroup CAPI_MEDIA_CONTENT_MODULE
 831  *
 832  * @section CAPI_CONTENT_MEDIA_INFO_MODULE_HEADER Required Header
 833  *   \#include <media_content.h>
 834  *
 835  * @section CAPI_CONTENT_MEDIA_INFO_MODULE_OVERVIEW Overview
 836  *
 837  * The Media Information API provides functions to get basic information e.g. path, date, type etc about media items (#media_info_h) present in the device.
 838  * Media Information (#media_info_h) is a generalization of media content of any type (audio, image, video and others).
 839  *
 840  * Received information about media items can be the processed using dedicated APIs:
 841  * <table>
 842  * <tr>
 843  *    <th>API</th>
 844  *    <th>Description</th>
 845  * </tr>
 846  * <tr>
 847  *    <td>@ref CAPI_CONTENT_MEDIA_INFO_MODULE </td>
 848  *    <td> Provides details about all items present in the device.\n
 849  * Provide functions to get information (e.g. title, size, mime type etc) about the files.</td>
 850  * </tr>
 851  * <tr>
 852  *    <td>@ref CAPI_CONTENT_MEDIA_AUDIO_META_MODULE </td>
 853  *    <td> Provides details about audio items present in the device.\n
 854  * Provide functions to get information (e.g. genre, album, year, bitrate etc) about the audio files.</td>
 855  * </tr>
 856  * <tr>
 857  *    <td>@ref CAPI_CONTENT_MEDIA_FACE_DETECTION_MODULE </td>
 858  *    <td> Provide functions to detect faces from image. </td>
 859  * </tr>
 860  * <tr>
 861  *    <td>@ref CAPI_CONTENT_MEDIA_IMAGE_META_MODULE </td>
 862  *    <td> Provides details about image items present in the device.\n
 863  * Provide functions to get information (e.g. longitude, description, date etc) about the image files.</td>
 864  * </tr>
 865  * <tr>
 866  *    <td>@ref CAPI_CONTENT_MEDIA_VIDEO_META_MODULE </td>
 867  *    <td> Provides details about video items present in the device.\n
 868  * Provide functions to get information (e.g. duration, date etc) about the video files.</td>
 869  * </tr>
 870  * </table>
 871  * \n
 872  * The media information API provides the following information. Regarding the information of each media type (audio, video, or image), please refer to the type-specific metadata page.
 873  *
 874  * <table>
 875  * <tr>
 876  * <th>Attribute</th>
 877  * <th>Filter Keyword</th>
 878  * <th>Comments</th>
 879  * </tr>
 880  * <tr>
 881  * <td>media_id</td>
 882  * <td>#MEDIA_ID</td>
 883  * <td>UUID</td>
 884  * </tr>
 885  * <tr>
 886  * <td>file_path</td>
 887  * <td>#MEDIA_PATH</td>
 888  * <td>Full path of the file</td>
 889  * </tr>
 890  * <tr>
 891  * <td>display_name</td>
 892  * <td>#MEDIA_DISPLAY_NAME</td>
 893  * <td>Base name of the file</td>
 894  * </tr>
 895  * <tr>
 896  * <td>media_type</td>
 897  * <td>#MEDIA_TYPE</td>
 898  * <td>Type (media_content_type_e)</td>
 899  * </tr>
 900  * <tr>
 901  * <td>mime_type</td>
 902  * <td>#MEDIA_MIME_TYPE</td>
 903  * <td>MIME type</td>
 904  * </tr>
 905  * <tr>
 906  * <td>size</td>
 907  * <td>#MEDIA_SIZE</td>
 908  * <td>File size</td>
 909  * </tr>
 910  * <tr>
 911  * <td>added_time</td>
 912  * <td>#MEDIA_ADDED_TIME</td>
 913  * <td>Added time to Media DB</td>
 914  * </tr>
 915  * <tr>
 916  * <td>modified_time</td>
 917  * <td>#MEDIA_MODIFIED_TIME</td>
 918  * <td>Time of last modification</td>
 919  * </tr>
 920  * <tr>
 921  * <td>timeline</td>
 922  * <td>#MEDIA_TIMELINE</td>
 923  * <td>Same as date taken time(for image) or recorded time(for Audio/Video) if exit. if not, same as modified time.</td>
 924  * </tr>
 925  * <tr>
 926  * <td>is_drm</td>
 927  * <td>#MEDIA_IS_DRM</td>
 928  * <td>Whether DRM content or not</td>
 929  * </tr>
 930  * <tr>
 931  * <td>storage_id</td>
 932  * <td>#MEDIA_STORAGE_ID</td>
 933  * <td>Storage UUID.</td>
 934  * </tr>
 935  * <tr>
 936  * <td>storage_type</td>
 937  * <td>#MEDIA_STORAGE_TYPE</td>
 938  * <td>Storage type (media_content_storage_e)</td>
 939  * </tr>
 940  * <tr>
 941  * <td>favorite</td>
 942  * <td>#MEDIA_FAVOURITE</td>
 943  * <td>User data. Not guarantee independence between applications.</td>
 944  * </tr>
 945  * <tr>
 946  * <td>thumbnail_path</td>
 947  * <td>#MEDIA_THUMBNAIL_PATH</td>
 948  * <td>Thumbnail path(album art for Audio) if exist.</td>
 949  * </tr>
 950  * <tr>
 951  * <td>description</td>
 952  * <td>#MEDIA_DESCRIPTION</td>
 953  * <td>Get from metadata if exist.</td>
 954  * </tr>
 955  * </table>
 956  * \n
 957  *
 958  * Video and Audio information can be further processed with respect to its properties i.e. playlist, album, using their respective APIs.
 959  * - @ref CAPI_CONTENT_MEDIA_PLAYLIST_MODULE
 960  * - @ref CAPI_CONTENT_MEDIA_ALBUM_MODULE
 961  * - @ref CAPI_CONTENT_MEDIA_BOOKMARK_MODULE
 962  *
 963  *
 964  * @subsection CAPI_CONTENT_MEDIA_INFO_FOREACH_OPERATIONS Foreach Operations
 965  * <div><table class="doxtable">
 966  *     <tr>
 967  *        <th><b>FOREACH</b></th>
 968  *        <th><b>CALLBACK</b></th>
 969  *        <th><b>DESCRIPTION</b></th>
 970  *     </tr>
 971  *     <tr>
 972  *        <td>media_info_foreach_media_from_db()</td>
 973  *        <td>media_info_cb()</td>
 974  *        <td>Iterates through items</td>
 975  *     </tr>
 976  *     <tr>
 977  *        <td>media_info_foreach_tag_from_db()</td>
 978  *        <td>media_tag_cb()</td>
 979  *        <td>Iterate through tags</td>
 980  *     </tr>
 981  *     <tr>
 982  *        <td>media_info_foreach_bookmark_from_db()</td>
 983  *        <td>media_bookmark_cb()</td>
 984  *        <td>Iterate through bookmark</td>
 985  *     </tr>
 986  * </table></div>
 987  *
 988  *
 989  *
 990  */
 991
 992 /**
 993  * @defgroup CAPI_CONTENT_MEDIA_STORAGE_MODULE Media Storage
 994  * @brief The Media Storage Information API provides functions to manage storage  information on the media items.
 995  *
 996  * @ingroup CAPI_MEDIA_CONTENT_MODULE
 997  *
 998  * @section CAPI_CONTENT_MEDIA_STORAGE_MODULE_HEADER Required Header
 999  *   \#include <media_content.h>
1000  *
1001  * @section CAPI_CONTENT_MEDIA_STORAGE_MODULE_OVERVIEW Overview
1002  * A Storage allows you to manage external storage. \n
1003  * 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
1004  * So you can get the information from the storage that you want to view.
1005  *
1006  */
1007
1008 /**
1009  * @defgroup CAPI_CONTENT_MEDIA_FACE_MODULE Media Face
1010  * @brief The Media Face Information API provides functions to manage the face information in the image files.
1011  *
1012  * @ingroup CAPI_MEDIA_CONTENT_MODULE
1013  *
1014  * @section CAPI_CONTENT_MEDIA_FACE_MODULE_HEADER Required Header
1015  *   \#include <media_content.h>
1016  *
1017  * @section CAPI_CONTENT_MEDIA_FACE_MODULE_OVERVIEW Overview
1018  * The Face Information API provides functions to manage the face information such as face id, face coordinates in the image files.\n
1019  *
1020  *
1021  */
1022
1023
1024 #endif /* __TIZEN_MEDIA_CONTENT_DOC_H__ */