include_product/media_content_type.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_CONTENT_MEDIA_CONTENT_TYPE_H__
  19 #define __TIZEN_CONTENT_MEDIA_CONTENT_TYPE_H__
  20
  21 #include <time.h>
  22 #include <tizen.h>
  23
  24 #ifdef __cplusplus
  25 extern "C" {
  26 #endif /* __cplusplus */
  27
  28 /**
  29  * @file media_content_type.h
  30  * @brief This file contains API related to media-content enumerations for media data types, groups, orientations, \n
  31  *        classes of errors and definitions of media-data. \n
  32  *        Listed APIs are called when iterating over lists of album, group, bookmark and other media,  \n
  33  *        when media items are inserted completely and when notification of media DB change is subscribed.
  34  */
  35
  36 /**
  37 * @addtogroup CAPI_MEDIA_CONTENT_MODULE
  38  * @{
  39  */
  40
  41 /**
  42  * @ingroup CAPI_MEDIA_CONTENT_MODULE
  43  * @brief Enumeration for the media file format.
  44  * @since_tizen 2.3
  45  * @remarks Since 4.0, #MEDIA_CONTENT_TYPE_OTHERS is related to the following feature:\n
  46  *          %http://tizen.org/feature/content.scanning.others\n
  47  *          If this feature is not supported on the device, #MEDIA_CONTENT_TYPE_OTHERS type file is not scanned.
  48  */
  49 typedef enum {
  50         MEDIA_CONTENT_TYPE_IMAGE        = 0,    /**<The type of an image */
  51         MEDIA_CONTENT_TYPE_VIDEO        = 1,    /**<The type of a video */
  52         MEDIA_CONTENT_TYPE_SOUND        = 2,    /**<The type of sound */
  53         MEDIA_CONTENT_TYPE_MUSIC        = 3,    /**<The type of music */
  54         MEDIA_CONTENT_TYPE_OTHERS       = 4,    /**<The type of other */
  55         MEDIA_CONTENT_TYPE_BOOK         = 5,    /**<The type of book (Since 6.5)*/
  56         MEDIA_CONTENT_TYPE_PVR          = 1001, /**<The type of PVR */
  57         MEDIA_CONTENT_TYPE_UHD          = 1002, /**<The type of UHD */
  58         MEDIA_CONTENT_TYPE_SCSA         = 1003, /**<The type of SCSA */
  59         MEDIA_CONTENT_TYPE_APK      = 1004,     /**<The type of ARK*/
  60         MEDIA_CONTENT_TYPE_DOC      = 1005,     /**<The type of DOC*/
  61 } media_content_type_e;
  62
  63 /**
  64  * @ingroup CAPI_MEDIA_CONTENT_MODULE
  65  * @brief Enumeration for media content DB update items.
  66  * @since_tizen 2.3
  67  */
  68 typedef enum {
  69         MEDIA_ITEM_FILE         = 0,            /**< File type, an item updated to DB */
  70         MEDIA_ITEM_DIRECTORY    = 1,            /**< Directory type, an item updated to DB */
  71         MEDIA_ITEM_STORAGE      = 2,            /**< Storage type, an item updated to DB */
  72 } media_content_db_update_item_type_e;
  73
  74 /**
  75  * @ingroup CAPI_MEDIA_CONTENT_MODULE
  76  * @brief Enumeration for media content DB update types.
  77  * @since_tizen 2.3
  78  */
  79 typedef enum {
  80         MEDIA_CONTENT_INSERT            = 0,            /**< Insert, the type of DB update */
  81         MEDIA_CONTENT_DELETE            = 1,            /**< Delete, The type of DB update */
  82         MEDIA_CONTENT_UPDATE    = 2,            /**< Update, The type of DB update */
  83 } media_content_db_update_type_e;
  84
  85 /**
  86  * @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
  87  * @brief Enumeration for orientation types.
  88  * @since_tizen 2.3
  89  */
  90 typedef enum {
  91         MEDIA_CONTENT_ORIENTATION_NOT_AVAILABLE  = 0,       /**< Not available*/
  92         MEDIA_CONTENT_ORIENTATION_NORMAL         = 1,       /**< Normal*/
  93         MEDIA_CONTENT_ORIENTATION_HFLIP          = 2,       /**< Flip horizontal*/
  94         MEDIA_CONTENT_ORIENTATION_ROT_180        = 3,       /**< Rotate 180 degrees*/
  95         MEDIA_CONTENT_ORIENTATION_VFLIP          = 4,       /**< Flip vertical*/
  96         MEDIA_CONTENT_ORIENTATION_TRANSPOSE      = 5,       /**< Transpose*/
  97         MEDIA_CONTENT_ORIENTATION_ROT_90         = 6,       /**< Rotate 90 degrees*/
  98         MEDIA_CONTENT_ORIENTATION_TRANSVERSE     = 7,       /**< Transverse*/
  99         MEDIA_CONTENT_ORIENTATION_ROT_270        = 8,       /**< Rotate 270 degrees*/
 100 } media_content_orientation_e;
 101
 102 /**
 103  * @ingroup CAPI_MEDIA_CONTENT_MODULE
 104  * @brief Enumeration for ordering.
 105  * @since_tizen 2.3
 106  */
 107 typedef enum {
 108         MEDIA_CONTENT_ORDER_ASC   = 0,      /**< Ascending order*/
 109         MEDIA_CONTENT_ORDER_DESC  = 1,      /**< Descending order*/
 110         MEDIA_CONTENT_ORDER_OTHER = 2,          /**< order by order key**/
 111 } media_content_order_e;
 112
 113 /**
 114  * @ingroup CAPI_MEDIA_CONTENT_MODULE
 115  * @brief Enumeration for collations.
 116  * @since_tizen 2.3
 117  */
 118 typedef enum {
 119         MEDIA_CONTENT_COLLATE_DEFAULT   = 0,        /**< Default collation BINARY */
 120         MEDIA_CONTENT_COLLATE_NOCASE    = 1,        /**< Collation NOCASE, not case sensitive */
 121         MEDIA_CONTENT_COLLATE_RTRIM     = 2,        /**< Collation RTRIM, trailing space characters are ignored */
 122         MEDIA_CONTENT_COLLATE_LOCALIZED = 3,        /**< Collation LOCALIZATION, NOCASE also applied */
 123 } media_content_collation_e;
 124
 125 /**
 126 * @brief Error class.
 127 * @details Class for Media Content error
 128 * @since_tizen 2.3
 129 *
 130 */
 131 #define MEDIA_CONTENT_ERROR_CLASS                               TIZEN_ERROR_MEDIA_CONTENT
 132
 133 /**
 134  * @ingroup CAPI_MEDIA_CONTENT_MODULE
 135  * @brief Enumeration for a media content error.
 136  * @since_tizen 2.3
 137  */
 138 typedef enum {
 139         MEDIA_CONTENT_ERROR_NONE                    = TIZEN_ERROR_NONE,                    /**< Successful */
 140         MEDIA_CONTENT_ERROR_INVALID_PARAMETER       = TIZEN_ERROR_INVALID_PARAMETER,       /**< Invalid parameter */
 141         MEDIA_CONTENT_ERROR_OUT_OF_MEMORY           = TIZEN_ERROR_OUT_OF_MEMORY,           /**< Out of memory */
 142         MEDIA_CONTENT_ERROR_INVALID_OPERATION       = TIZEN_ERROR_INVALID_OPERATION,       /**< Invalid Operation */
 143         MEDIA_CONTENT_FILE_NO_SPACE_ON_DEVICE       = TIZEN_ERROR_FILE_NO_SPACE_ON_DEVICE, /**< No space left on device */
 144         MEDIA_CONTENT_ERROR_PERMISSION_DENIED             = TIZEN_ERROR_PERMISSION_DENIED,                /**< Permission denied */
 145         MEDIA_CONTENT_ERROR_DB_FAILED               = MEDIA_CONTENT_ERROR_CLASS | 0x01,    /**< DB operation failed */
 146         MEDIA_CONTENT_ERROR_DB_BUSY                 = MEDIA_CONTENT_ERROR_CLASS | 0x02,    /**< DB operation BUSY */
 147         MEDIA_CONTENT_ERROR_NETWORK                 = MEDIA_CONTENT_ERROR_CLASS | 0x03,    /**< Network Fail */
 148         MEDIA_CONTENT_ERROR_UNSUPPORTED_CONTENT     = MEDIA_CONTENT_ERROR_CLASS | 0x04,    /**< Unsupported Content */
 149         MEDIA_CONTENT_ERROR_NOT_SUPPORTED           = TIZEN_ERROR_NOT_SUPPORTED,           /**< Not supported */
 150 } media_content_error_e;
 151
 152 /**
 153  * @ingroup CAPI_MEDIA_CONTENT_MODULE
 154  * @brief Enumeration for a media group.
 155  * @since_tizen 2.3
 156  */
 157 typedef enum {
 158         MEDIA_CONTENT_GROUP_DISPLAY_NAME = 0,    /**< @deprecated Media group ID for display name. Deprecated since 9.0*/
 159         MEDIA_CONTENT_GROUP_TYPE,                /**< @deprecated Media group ID for a media type. Deprecated since 9.0*/
 160         MEDIA_CONTENT_GROUP_MIME_TYPE,           /**< @deprecated Media group ID for a mime type. Deprecated since 9.0*/
 161         MEDIA_CONTENT_GROUP_SIZE,                /**< @deprecated Media group ID for content size. Deprecated since 9.0*/
 162         MEDIA_CONTENT_GROUP_ADDED_TIME,          /**< @deprecated Media group ID for the added time. Deprecated since 9.0*/
 163         MEDIA_CONTENT_GROUP_MODIFIED_TIME,       /**< @deprecated Media group ID for the modified time. Deprecated since 9.0*/
 164         MEDIA_CONTENT_GROUP_TITLE,               /**< @deprecated Media group ID for a content title. Deprecated since 9.0*/
 165         MEDIA_CONTENT_GROUP_ARTIST,              /**< Media group ID for an artist*/
 166         MEDIA_CONTENT_GROUP_ALBUM_ARTIST,        /**< Media group ID for an album artist */
 167         MEDIA_CONTENT_GROUP_GENRE,               /**< Media group ID for a genre*/
 168         MEDIA_CONTENT_GROUP_COMPOSER,            /**< @deprecated Media group ID for a composer. Deprecated since 9.0*/
 169         MEDIA_CONTENT_GROUP_YEAR,                /**< Media group ID for a year*/
 170         MEDIA_CONTENT_GROUP_RECORDED_DATE,       /**< @deprecated Media group ID for the recorded date. Deprecated since 9.0*/
 171         MEDIA_CONTENT_GROUP_COPYRIGHT,           /**< @deprecated Media group ID for the copyright. Deprecated since 9.0*/
 172         MEDIA_CONTENT_GROUP_TRACK_NUM,           /**< @deprecated Media group ID for a track number. Deprecated since 9.0*/
 173         MEDIA_CONTENT_GROUP_DESCRIPTION,         /**< @deprecated Media group ID for a description. Deprecated since 9.0*/
 174         MEDIA_CONTENT_GROUP_LONGITUDE,           /**< @deprecated Media group ID for the longitude. Deprecated since 9.0*/
 175         MEDIA_CONTENT_GROUP_LATITUDE,            /**< @deprecated Media group ID for the latitude. Deprecated since 9.0*/
 176         MEDIA_CONTENT_GROUP_ALTITUDE,            /**< @deprecated Media group ID for the altitude. Deprecated since 9.0*/
 177         MEDIA_CONTENT_GROUP_RATING = 20,         /**< @deprecated Media group ID for a rating. Deprecated since 9.0*/
 178         MEDIA_CONTENT_GROUP_MODIFIED_DATE = 29,          /**< Media group ID for the modified date*/
 179         MEDIA_CONTENT_GROUP_ALBUM,
 180         MEDIA_CONTENT_GROUP_MAX,                /**< @deprecated Invalid media group ID. Deprecated since 9.0*/
 181         MEDIA_PVR_GROUP_DURATION,
 182         MEDIA_PVR_GROUP_TIME_ZONE,
 183         MEDIA_PVR_GROUP_PTC,
 184         MEDIA_PVR_GROUP_MAJOR,
 185         MEDIA_PVR_GROUP_MINOR,
 186         MEDIA_PVR_GROUP_CHANNEL_TYPE,
 187         MEDIA_PVR_GROUP_CHANNEL_NAME,
 188         MEDIA_PVR_GROUP_CHANNEL_NUM,
 189         MEDIA_PVR_GROUP_PROGRAM_TITLE,
 190         MEDIA_PVR_GROUP_PROGRAM_NUM,
 191         MEDIA_PVR_GROUP_PROGRAM_CRID,
 192         MEDIA_PVR_GROUP_GUIDANCE,
 193         MEDIA_PVR_GROUP_SYNOPSIS,
 194         MEDIA_PVR_GROUP_GENRE,
 195         MEDIA_PVR_GROUP_LANGUAGE,
 196         MEDIA_PVR_GROUP_EMBARGO_TIME,
 197         MEDIA_PVR_GROUP_EXPIRY_TIME,
 198         MEDIA_PVR_GROUP_START_TIME,
 199         MEDIA_PVR_GROUP_PROGRAM_START_TIME,
 200         MEDIA_PVR_GROUP_PROGRAM_END_TIME,
 201         MEDIA_PVR_GROUP_PROGRAM_DATE,
 202         MEDIA_PVR_GROUP_PARENTAL_RATING,
 203         MEDIA_PVR_GROUP_TIMER_RECORD,
 204         MEDIA_PVR_GROUP_SERIES_RECORD,
 205         MEDIA_PVR_GROUP_HD,
 206         MEDIA_PVR_GROUP_SUBTITLE,
 207         MEDIA_PVR_GROUP_TTX,
 208         MEDIA_PVR_GROUP_AD,
 209         MEDIA_PVR_GROUP_HARDOF_HEARINGRADIO,
 210         MEDIA_PVR_GROUP_DATA_SERVICE,
 211         MEDIA_PVR_GROUP_CONTENT_LOCK,
 212         MEDIA_PVR_GROUP_CONTENT_WATCH,
 213         MEDIA_PVR_GROUP_HAS_AUDIO_ONLY,
 214         MEDIA_PVR_GROUP_IS_LOCAL_RECORDED,
 215         MEDIA_PVR_GROUP_RESOLUTION,
 216         MEDIA_PVR_GROUP_ASPECTRATIO,
 217         MEDIA_PVR_GROUP_MODIFIED_MONTH,
 218         MEDIA_PVR_GROUP_MODIFIED_DATE,
 219         MEDIA_PVR_GROUP_SPORTS_TYPE,
 220         MEDIA_PVR_GROUP_GUIDANCE_LENGTH,
 221         MEDIA_PVR_GROUP_TVMODE,
 222         MEDIA_PVR_GROUP_PLAY_COUNT,
 223         MEDIA_PVR_GROUP_PRIVATE_DATA,
 224         MEDIA_PVR_GROUP_MAX,
 225         MEDIA_UHD_GROUP_CONTENT_TITLE,
 226         MEDIA_UHD_GROUP_RELEASE_DATE,
 227         MEDIA_UHD_GROUP_SUB_TYPE,
 228         MEDIA_UHD_GROUP_FILE_NAME,
 229         MEDIA_UHD_GROUP_PLAYED_COUNT,
 230         MEDIA_UHD_GROUP_MAX,
 231         MEDIA_GROUP_MAX,
 232 } media_group_e;
 233
 234 typedef struct {
 235         char *storage_id;
 236         char *storage_path;
 237 } media_storage_s;
 238
 239 /**
 240  * @ingroup CAPI_CONTENT_MEDIA_STORAGE_MODULE
 241  * @deprecated Deprecated since 5.0.
 242  * @brief The structure type for the Media storage handle.
 243  * @since_tizen 2.4
 244  */
 245 typedef void *media_storage_h;
 246
 247 /**
 248  * @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
 249  * @brief The structure type for the Media info handle.
 250  * @since_tizen 2.3
 251  */
 252 typedef struct media_info_s *media_info_h;
 253
 254 /**
 255  * @ingroup CAPI_CONTENT_MEDIA_FOLDER_MODULE
 256  * @brief The structure type for the Media folder handle.
 257  * @since_tizen 2.3
 258  */
 259 typedef struct media_folder_s *media_folder_h;
 260
 261 /**
 262  * @deprecated Deprecated since 9.0.
 263  * @ingroup CAPI_CONTENT_MEDIA_PLAYLIST_MODULE
 264  * @brief The structure type for the Media playlist handle.
 265  * @since_tizen 2.3
 266  */
 267 typedef struct media_playlist_s *media_playlist_h;
 268
 269 /**
 270  * @deprecated Deprecated since 9.0.
 271  * @ingroup CAPI_CONTENT_MEDIA_TAG_MODULE
 272  * @brief The structure type for the Media tag handle.
 273  * @since_tizen 2.3
 274  */
 275 typedef struct media_tag_s *media_tag_h;
 276
 277 /**
 278  * @deprecated Deprecated since 9.0.
 279  * @ingroup CAPI_CONTENT_MEDIA_BOOKMARK_MODULE
 280  * @brief The structure type for the Media bookmark handle.
 281  * @since_tizen 2.3
 282  */
 283 typedef struct media_bookmark_s *media_bookmark_h;
 284
 285 /**
 286  * @ingroup CAPI_CONTENT_MEDIA_ALBUM_MODULE
 287  * @brief The structure type for the Media album handle.
 288  * @since_tizen 2.3
 289  */
 290 typedef struct media_album_s *media_album_h;
 291
 292 /**
 293  * @ingroup CAPI_CONTENT_MEDIA_IMAGE_META_MODULE
 294  * @brief The structure type for the Image metadata handle.
 295  * @since_tizen 2.3
 296  */
 297 typedef struct image_meta_s *image_meta_h;
 298
 299 /**
 300  * @deprecated Deprecated since 9.0.
 301  * @ingroup CAPI_CONTENT_MEDIA_VIDEO_META_MODULE
 302  * @brief The structure type for the Video metadata handle.
 303  * @since_tizen 2.3
 304  */
 305 typedef struct video_meta_s *video_meta_h;
 306
 307 /**
 308  * @ingroup CAPI_CONTENT_MEDIA_AUDIO_META_MODULE
 309  * @brief The structure type for the Audio metadata handle.
 310  * @since_tizen 2.3
 311  */
 312 typedef struct audio_meta_s *audio_meta_h;
 313
 314 /**
 315  * @ingroup CAPI_CONTENT_MEDIA_BOOK_META_MODULE
 316  * @brief The structure type for the Book metadata handle.
 317  * @since_tizen 6.5
 318  */
 319 typedef struct book_meta_s *book_meta_h;
 320
 321 /**
 322  * @ingroup CAPI_CONTENT_MEDIA_FILTER_MODULE
 323  * @brief The structure type for the Media filter handle.
 324  * @since_tizen 2.3
 325  */
 326 typedef struct filter_s *filter_h;
 327
 328 /**
 329  * @deprecated Deprecated since 8.0.
 330  * @ingroup CAPI_CONTENT_MEDIA_FACE_MODULE
 331  * @brief The structure type for the Media face handle.
 332  * @since_tizen 3.0
 333  */
 334 typedef void *media_face_h;
 335
 336 /**
 337  * @ingroup CAPI_MEDIA_CONTENT_MODULE
 338  * @brief The structure type for the Media content noti handle.
 339  * @since_tizen 3.0
 340  */
 341 typedef void *media_content_noti_h;
 342
 343 /**
 344  * @ingroup CAPI_MEDIA_CONTENT_MODULE
 345  * @brief Called when the media scanning is finished.
 346  * @details The following error codes can be received: \n
 347  *             #MEDIA_CONTENT_ERROR_NONE : Success \n
 348  *             #MEDIA_CONTENT_ERROR_INVALID_PARAMETER : Invalid parameter \n
 349  *             #MEDIA_CONTENT_ERROR_INVALID_OPERATION : Invalid operation \n
 350  *             #MEDIA_CONTENT_ERROR_PERMISSION_DENIED : Permission denied \n
 351  *             #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY : Out of memory \n
 352  *             #MEDIA_CONTENT_ERROR_DB_FAILED : DB Operation failed \n
 353  *             #MEDIA_CONTENT_ERROR_DB_BUSY : DB Operation busy \n
 354  *             #MEDIA_CONTENT_ERROR_NETWORK : Network fail \n
 355  * @since_tizen 2.3
 356  * @remarks The callback is called in a separate thread(not in the main loop).
 357  *
 358  * @param[in] error The error code
 359  * @param[in] user_data The user data passed from the foreach function
 360  *
 361  * @pre media_content_scan_folder().
 362  * @see media_content_scan_folder()
 363  */
 364 typedef void (*media_scan_completed_cb)(media_content_error_e error, void * user_data);
 365
 366 /**
 367  * @ingroup CAPI_MEDIA_CONTENT_MODULE
 368  * @brief Called when the notification of the media DB change is subscribed.
 369  * @details The following error codes can be received: \n
 370  *             #MEDIA_CONTENT_ERROR_NONE : Success \n
 371  * @since_tizen 2.3
 372  *
 373  * @remarks The callback is called in a separate thread(not in the main loop).
 374  *
 375  * @param[in] error The error code
 376  * @param[in] pid The PID which publishes notification
 377  * @param[in] update_item The update item of notification
 378  * @param[in] update_type The update type of notification
 379  * @param[in] media_type The type of the media content (#media_content_type_e)
 380  * @param[in] id The ID of media or directory, which is updated
 381  * @param[in] path The path of the media or directory
 382  * @param[in] mime_type The MIME of the media info
 383  * @param[in] user_data The user data passed from the foreach function
 384  *
 385  * @pre media_content_add_db_updated_cb().
 386  * @see media_content_add_db_updated_cb()
 387  */
 388 typedef void (*media_content_db_update_cb)(
 389                                 media_content_error_e error,
 390                                 int pid,
 391                                 media_content_db_update_item_type_e update_item,
 392                                 media_content_db_update_type_e update_type,
 393                                 media_content_type_e media_type,
 394                                 char *id,
 395                                 char *path,
 396                                 char *mime_type,
 397                                 void *user_data);
 398
 399
 400 /**
 401  * @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
 402  * @brief Called for every available media info.
 403  * @details Iterates over a list of media info.
 404  * @since_tizen 2.3
 405  *
 406  * @remarks To use the @a media outside this function, copy the handle with media_info_clone() function. \n
 407  *                  The callback is called in the main loop.
 408  *
 409  * @param[in] media The handle to the media info
 410  * @param[in] user_data The user data passed from the foreach function
 411  *
 412  * @return @c true to continue with the next iteration of the loop,
 413  *         otherwise @c false to break out of the loop
 414  *
 415  * @pre media_info_foreach_media_from_db(), media_folder_foreach_media_from_db() will invoke this function.
 416  *
 417  * @see media_info_clone()
 418  * @see media_album_foreach_media_from_db()
 419  * @see media_info_foreach_media_from_db()
 420  * @see media_folder_foreach_media_from_db()
 421  */
 422 typedef bool (*media_info_cb)(media_info_h media, void *user_data);
 423
 424
 425 /**
 426  * @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
 427  * @brief Called when media items are inserted completely.
 428  * @details The following error codes can be received: \n
 429  *             #MEDIA_CONTENT_ERROR_NONE : Success \n
 430  *             #MEDIA_CONTENT_ERROR_INVALID_PARAMETER : Invalid parameter \n
 431  *             #MEDIA_CONTENT_ERROR_INVALID_OPERATION : Invalid operation \n
 432  *             #MEDIA_CONTENT_ERROR_PERMISSION_DENIED : Permission denied \n
 433  *             #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY : Out of memory \n
 434  *             #MEDIA_CONTENT_ERROR_DB_FAILED : DB Operation failed \n
 435  *             #MEDIA_CONTENT_ERROR_DB_BUSY : DB Operation busy \n
 436  *             #MEDIA_CONTENT_ERROR_NETWORK : Network fail \n
 437  *             #MEDIA_CONTENT_ERROR_NOT_SUPPORTED : Not supported \n
 438  * @since_tizen 2.3
 439  *
 440  * @remarks The callback is called in a separate thread(not in the main loop).
 441  *
 442  * @param[in] error The error code
 443  * @param[in] user_data The user data passed from the foreach function
 444  *
 445  * @pre media_info_insert_batch_to_db()
 446  * @see media_info_insert_batch_to_db()
 447  */
 448 typedef void (*media_insert_completed_cb)(media_content_error_e error, void * user_data);
 449
 450 /**
 451  * @deprecated Deprecated since 8.0.
 452  * @ingroup CAPI_CONTENT_MEDIA_FACE_DETECTION_MODULE
 453  * @brief Called when face detection on the image is completed.
 454  *
 455  * @details The following error codes can be delivered. \n
 456  *         #MEDIA_CONTENT_ERROR_NONE, \n
 457  *         #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY, \n
 458  *         #MEDIA_CONTENT_ERROR_INVALID_OPERATION, \n
 459  *         #MEDIA_CONTENT_ERROR_DB_FAILED, \n
 460  *         #MEDIA_CONTENT_ERROR_DB_BUSY, \n
 461  *         #MEDIA_CONTENT_ERROR_UNSUPPORTED_CONTENT
 462  *
 463  * @since_tizen 3.0
 464  *
 465  * @remarks The callback is called in a separate thread(not in the main loop).
 466  *
 467  * @param[in] error The error code
 468  * @param[in] face_count The number of all detected faces
 469  * @param[in] user_data The user data passed from the foreach function
 470  *
 471  * @pre media_info_start_face_detection()
 472  * @see media_info_start_face_detection()
 473  */
 474 typedef void (*media_face_detection_completed_cb)(media_content_error_e error, const int face_count, void *user_data);
 475
 476
 477 /**
 478  * @ingroup CAPI_CONTENT_MEDIA_FOLDER_MODULE
 479  * @brief Called for every available media folder.
 480  * @details Iterates over a list of folders.
 481  *
 482  * @since_tizen 2.3
 483  *
 484  * @remarks To use the @a folder outside this function, copy the handle with the media_folder_clone() function. \n
 485  *                  The callback is called in the main loop.
 486  *
 487  * @param[in] folder The handle to the media folder
 488  * @param[in] user_data The user data passed from the foreach function
 489  *
 490  * @return @c true to continue with the next iteration of the loop,
 491  *         otherwise @c false to break out of the loop
 492  *
 493  * @pre media_folder_foreach_folder_from_db() will invoke this function.
 494  * @see media_folder_clone()
 495  * @see media_folder_foreach_folder_from_db()
 496  */
 497 typedef bool (*media_folder_cb)(media_folder_h folder, void *user_data);
 498
 499 /**
 500  * @deprecated Deprecated since 9.0.
 501  * @ingroup CAPI_CONTENT_MEDIA_PLAYLIST_MODULE
 502  * @brief Called for every playlist in the obtained list of playlists.
 503  * @details Iterates over a playlist list.
 504  *
 505  * @since_tizen 2.3
 506  *
 507  * @remarks To use the @a playlist outside this function, copy the handle with the media_playlist_clone() function. \n
 508  *                  The callback is called in the main loop.
 509  *
 510  * @param[in] playlist The handle to the media playlist
 511  * @param[in] user_data The user data passed from the foreach function
 512  *
 513  * @return @c true to continue with the next iteration of the loop,
 514  *         otherwise @c false to break out of the loop
 515  *
 516  * @pre media_playlist_foreach_playlist_from_db() will invoke this function.
 517  *
 518  * @see media_playlist_clone()
 519  * @see media_playlist_foreach_playlist_from_db()
 520  */
 521 typedef bool (*media_playlist_cb)(media_playlist_h playlist, void *user_data);
 522
 523 /**
 524  * @deprecated Deprecated since 9.0.
 525  * @ingroup CAPI_CONTENT_MEDIA_PLAYLIST_MODULE
 526  * @brief Called for every media info with playlist member ID in the obtained list of media info.
 527  * @details Iterates over playlist members.
 528  *
 529  * @since_tizen 2.3
 530  *
 531  * @remarks To use the @a media outside this function, copy the handle with the media_info_clone() function. \n
 532  *                  The callback is called in the main loop.
 533  *
 534  * @param[in] playlist_member_id The ID of the playlist member
 535  * @param[in] media The handle to the media info
 536  * @param[in] user_data The user data passed from the foreach function
 537  *
 538  * @return @c true to continue with the next iteration of the loop,
 539  *         otherwise @c false to break out of the loop
 540  *
 541  * @pre media_playlist_foreach_media_from_db() will invoke this function.
 542  *
 543  * @see media_info_clone()
 544  * @see media_playlist_foreach_media_from_db()
 545  */
 546 typedef bool (*playlist_member_cb)(int playlist_member_id, media_info_h media, void *user_data);
 547
 548 /**
 549  * @deprecated Deprecated since 9.0.
 550  * @ingroup CAPI_CONTENT_MEDIA_TAG_MODULE
 551  * @brief Called for every tag in the obtained list of tags.
 552  * @details Iterates over a list of tags.
 553  *
 554  * @since_tizen 2.3
 555  *
 556  * @remarks To use the @a tag outside this function, copy the handle with the media_tag_clone() function. \n
 557  *                  The callback is called in the main loop.
 558  *
 559  * @param[in] tag The handle to the media tag
 560  * @param[in] user_data The user data passed from the foreach function
 561  *
 562  * @return @c true to continue with the next iteration of the loop,
 563  *         otherwise @c false to break out of the loop
 564  *
 565  * @pre media_tag_foreach_tag_from_db(), media_info_foreach_tag_from_db() will invoke this function.
 566  *
 567  * @see media_tag_clone()
 568  * @see media_tag_foreach_tag_from_db()
 569  * @see media_info_foreach_tag_from_db()
 570  */
 571 typedef bool (*media_tag_cb)(media_tag_h tag, void *user_data);
 572
 573 /**
 574  * @deprecated Deprecated since 9.0.
 575  * @ingroup CAPI_CONTENT_MEDIA_BOOKMARK_MODULE
 576  * @brief Called for every bookmark in the obtained list of bookmarks.
 577  * @details Iterates over a bookmark list.
 578  *
 579  * @since_tizen 2.3
 580  *
 581  * @remarks To use the @a bookmark outside this function, copy the handle with the media_bookmark_clone() function. \n
 582  *                  The callback is called in the main loop.
 583  *
 584  * @param[in] bookmark The handle to the media bookmark
 585  * @param[in] user_data The user data passed from the foreach function
 586  *
 587  * @return @c true to continue with the next iteration of the loop,
 588  *         otherwise @c false to break out of the loop
 589  *
 590  * @pre media_info_foreach_bookmark_from_db() will invoke this function.
 591  * @see media_info_foreach_bookmark_from_db()
 592  */
 593 typedef bool (*media_bookmark_cb)(media_bookmark_h bookmark, void *user_data);
 594
 595 /**
 596  * @ingroup CAPI_CONTENT_MEDIA_ALBUM_MODULE
 597  * @brief Called for every album in the obtained list of groups.
 598  * @details Iterates over an album list.
 599  *
 600  * @since_tizen 2.3
 601  *
 602  * @remarks To use the @a album outside this function, copy the handle with the media_album_clone() function. \n
 603  *                  The callback is called in the main loop.
 604  *
 605  * @param[in] album The handle to the media album
 606  * @param[in] user_data The user data passed from the foreach function
 607  *
 608  * @return @c true to continue with the next iteration of the loop,
 609  *         otherwise @c false to break out of the loop
 610  *
 611  * @pre media_album_foreach_album_from_db() will invoke this function.
 612  *
 613  * @see media_album_clone()
 614  * @see media_album_foreach_album_from_db()
 615  */
 616 typedef bool (*media_album_cb)(media_album_h album, void *user_data);
 617
 618 /**
 619  * @ingroup CAPI_CONTENT_MEDIA_GROUP_MODULE
 620  * @brief Called for every group in the obtained list of groups.
 621  * @details Iterates over a media group list.
 622  *
 623  * @since_tizen 2.3
 624  *
 625  * @remarks You should not free @a group_name returned by this function. \n
 626  *                  The callback is called in the main loop.
 627  *
 628  * @param[in] group_name The name of the media group
 629  * @param[in] user_data The user data passed from the foreach function
 630  *
 631  * @return @c true to continue with the next iteration of the loop,
 632  *         otherwise @c false to break out of the loop
 633  *
 634  * @pre media_group_foreach_group_from_db() will invoke this function.
 635  * @see media_group_foreach_group_from_db()
 636  */
 637 typedef bool (*media_group_cb)(const char *group_name, void *user_data);
 638
 639 /**
 640  * @ingroup CAPI_CONTENT_MEDIA_STORAGE_MODULE
 641  * @brief Called for every storage in the obtained list of storages.
 642  * @details Iterates over a media storage list.
 643  *
 644  * @since_tizen 2.4
 645  *
 646  * @remarks You should not destroy @a storage returned by this function. \n
 647  *                  The callback is called in the main loop.
 648  *
 649  * @param[in] storage The handle of the media storage
 650  * @param[in] user_data The user data passed from the foreach function
 651  *
 652  * @return @c true to continue with the next iteration of the loop,
 653  *         otherwise @c false to break out of the loop
 654  *
 655  * @pre media_storage_foreach_storage_from_db() will invoke this function.
 656  * @see media_storage_foreach_storage_from_db()
 657  */
 658 typedef bool (*media_storage_cb)(media_storage_h storage, void *user_data);
 659
 660 /**
 661  * @deprecated Deprecated since 8.0.
 662  * @ingroup CAPI_CONTENT_MEDIA_FACE_MODULE
 663  * @brief Called for every face in the obtained list of face.
 664  * @details Iterates over a media face list.
 665  *
 666  * @since_tizen 3.0
 667  *
 668  * @remarks You should not destroy @a face returned by this function. \n
 669  *                  The callback is called in the main loop.
 670  *
 671  * @param[in] face The handle of the media face
 672  * @param[in] user_data The user data passed from the foreach function
 673  *
 674  * @return @c true to continue with the next iteration of the loop,
 675  *         otherwise @c false to break out of the loop
 676  *
 677  * @pre media_info_foreach_face_from_db() will invoke this function.
 678  * @see media_info_foreach_face_from_db()
 679  */
 680 typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 681
 682 /**
 683  * @}
 684  */
 685
 686 /**
 687  * @addtogroup CAPI_CONTENT_MEDIA_FILTER_MODULE
 688  * @{
 689  */
 690
 691  /**
 692  * @brief Media ID.
 693  * @details You can use above define to set the condition of media filter and order keyword.
 694  * @since_tizen 2.3
 695  *
 696  */
 697 #define MEDIA_ID "MEDIA_ID"
 698
 699 /**
 700  * @brief Media full path.
 701  * @details You can use above define to set the condition of media filter and order keyword.
 702  * @since_tizen 2.3
 703  *
 704  */
 705 #define MEDIA_PATH "MEDIA_PATH"
 706
 707 /**
 708  * @brief The file name including the extension.
 709  * @details You can use above define to set the condition of media filter and order keyword.
 710  * @since_tizen 2.3
 711  *
 712  */
 713 #define MEDIA_DISPLAY_NAME "MEDIA_DISPLAY_NAME"
 714
 715 /**
 716  * @brief Media type.
 717  * @details There are 5 media types:\n
 718  *               0-image, 1-video, 2-sound, 3-music, 4-other\n
 719  *               You can use above define to set the condition of media filter and order keyword.
 720  * @since_tizen 2.3
 721  *
 722  */
 723 #define MEDIA_TYPE "MEDIA_TYPE"
 724
 725 /**
 726  * @brief Media MIME type.
 727  * @details You can use above define to set the condition of media filter and order keyword.
 728  * @since_tizen 2.3
 729  *
 730  */
 731 #define MEDIA_MIME_TYPE "MEDIA_MIME_TYPE"
 732
 733
 734 /**
 735  * @brief Media file size.
 736  * @details You can use above define to set the condition of media filter and order keyword.
 737  * @since_tizen 2.3
 738  *
 739  */
 740 #define MEDIA_SIZE "MEDIA_SIZE"
 741
 742 /**
 743  * @brief The time that content file was first added to media database.
 744  * @details You can use above define to set the condition of media filter and order keyword.
 745  * @since_tizen 2.3
 746  *
 747  */
 748 #define MEDIA_ADDED_TIME "MEDIA_ADDED_TIME"
 749
 750 /**
 751  * @brief The last modification time provided by the file system.
 752  * @details You can use above define to set the condition of media filter and order keyword.
 753  * @since_tizen 2.3
 754  *
 755  */
 756 #define MEDIA_MODIFIED_TIME "MEDIA_MODIFIED_TIME"
 757
 758 /**
 759  * @deprecated Deprecated since 9.0.
 760  * @brief  Media created time.
 761  * @details You can use above define to set the condition of media filter and order keyword.
 762  * @since_tizen 2.3
 763  *
 764  */
 765 #define MEDIA_TIMELINE "MEDIA_TIMELINE"
 766
 767 /**
 768  * @brief Media thumbnail path.
 769  * @details You can use above define to set the condition of media filter and order keyword.
 770  * @since_tizen 2.3
 771  *
 772  */
 773 #define MEDIA_THUMBNAIL_PATH "MEDIA_THUMBNAIL_PATH"
 774
 775 /**
 776  * @brief Media title get from tag or file name.
 777  * @details You can use above define to set the condition of media filter and order keyword.
 778  * @since_tizen 2.3
 779  *
 780  */
 781 #define MEDIA_TITLE "MEDIA_TITLE"
 782
 783 /**
 784  * @brief Media album name.
 785  * @details You can use above define to set the condition of media filter and order keyword.
 786  * @since_tizen 2.3
 787  *
 788  */
 789 #define MEDIA_ALBUM "MEDIA_ALBUM"
 790
 791 /**
 792  * @brief Media artist.
 793  * @details You can use above define to set the condition of media filter and order keyword.
 794  * @since_tizen 2.3
 795  *
 796  */
 797 #define MEDIA_ARTIST "MEDIA_ARTIST"
 798
 799 /**
 800  * @brief Media album artist.
 801  * @details You can use above define to set the condition of media filter and order keyword.
 802  * @since_tizen 2.3
 803  *
 804  */
 805 #define MEDIA_ALBUM_ARTIST "MEDIA_ALBUM_ARTIST"
 806
 807 /**
 808  * @brief Media genre.
 809  * @details You can use above define to set the condition of media filter and order keyword.
 810  * @since_tizen 2.3
 811  *
 812  */
 813 #define MEDIA_GENRE "MEDIA_GENRE"
 814
 815 /**
 816  * @deprecated Deprecated since 9.0.
 817  * @brief Media composer.
 818  * @details You can use above define to set the condition of media filter and order keyword.
 819  * @since_tizen 2.3
 820  *
 821  */
 822 #define MEDIA_COMPOSER "MEDIA_COMPOSER"
 823
 824 /**
 825  * @brief Media year.
 826  * @details You can use above define to set the condition of media filter and order keyword.
 827  * @since_tizen 2.3
 828  *
 829  */
 830 #define MEDIA_YEAR "MEDIA_YEAR"
 831
 832 /**
 833  * @deprecated Deprecated since 9.0.
 834  * @brief Media recorded date.
 835  * @details You can use above define to set the condition of media filter and order keyword.
 836  * @since_tizen 2.3
 837  *
 838  */
 839 #define MEDIA_RECORDED_DATE "MEDIA_RECORDED_DATE"
 840
 841 /**
 842  * @brief Media track number.
 843  * @details You can use above define to set the condition of media filter and order keyword.
 844  * @since_tizen 2.3
 845  *
 846  */
 847 #define MEDIA_TRACK_NUM "MEDIA_TRACK_NUM"
 848
 849 /**
 850  * @deprecated Deprecated since 9.0.
 851  * @brief Media duration.
 852  * @details You can use above define to set the condition of media filter and order keyword.
 853  * @since_tizen 2.3
 854  *
 855  */
 856 #define MEDIA_DURATION "MEDIA_DURATION"
 857
 858 /**
 859  * @deprecated Deprecated since 9.0.
 860  * @brief Media longitude.
 861  * @details You can use above define to set the condition of media filter and order keyword.
 862  * @since_tizen 2.3
 863  *
 864  */
 865 #define MEDIA_LONGITUDE "MEDIA_LONGITUDE"
 866
 867 /**
 868  * @deprecated Deprecated since 9.0.
 869  * @brief Media latitude.
 870  * @details You can use above define to set the condition of media filter and order keyword.
 871  * @since_tizen 2.3
 872  *
 873  */
 874 #define MEDIA_LATITUDE "MEDIA_LATITUDE"
 875
 876 /**
 877  * @deprecated Deprecated since 9.0.
 878  * @brief Media altitude.
 879  * @details You can use above define to set the condition of media filter and order keyword.
 880  * @since_tizen 2.3
 881  *
 882  */
 883 #define MEDIA_ALTITUDE "MEDIA_ALTITUDE"
 884
 885 /**
 886  * @brief Media width.
 887  * @details You can use above define to set the condition of media filter and order keyword.
 888  * @since_tizen 2.3
 889  *
 890  */
 891 #define MEDIA_WIDTH "MEDIA_WIDTH"
 892
 893 /**
 894  * @brief Media height.
 895  * @details You can use above define to set the condition of media filter and order keyword.
 896  * @since_tizen 2.3
 897  *
 898  */
 899 #define MEDIA_HEIGHT "MEDIA_HEIGHT"
 900
 901 /**
 902  * @brief Media datetaken.
 903  * @details You can use above define to set the condition of media filter and order keyword.
 904  * @since_tizen 2.3
 905  *
 906  */
 907 #define MEDIA_DATETAKEN "MEDIA_DATETAKEN"
 908
 909 /**
 910  * @deprecated Deprecated since 9.0.
 911  * @brief The time to register favourite.
 912  * @details You can use above define to set the condition of media filter and order keyword.
 913  * @since_tizen 2.3
 914  *
 915  */
 916 #define MEDIA_FAVOURITE "MEDIA_FAVOURITE"
 917
 918 /**
 919  * @deprecated Deprecated since 9.0.
 920  * @brief Is DRM.
 921  * @details There are 2 types:\n
 922  *               0-not drm, 1-drm\n
 923  *               You can use above define to set the condition of media filter and order keyword.
 924  * @since_tizen 2.3
 925  *
 926  */
 927 #define MEDIA_IS_DRM "MEDIA_IS_DRM"
 928
 929 /**
 930  * @deprecated Deprecated since 9.0.
 931  * @brief Virtual Reality content.
 932  * @details You can use above define to set the condition of media filter and order keyword.
 933  * @since_tizen 3.0
 934  *
 935  */
 936 #define MEDIA_360 "MEDIA_360"
 937
 938  /**
 939  * @brief Folder ID.
 940  * @details You can use above define to set the condition of folder filter and order keyword.
 941  * @since_tizen 2.3
 942  */
 943 #define FOLDER_ID "FOLDER_ID"
 944
 945 /**
 946  * @brief Folder full path.
 947  * @details You can use above define to set the condition of folder filter and order keyword.
 948  * @since_tizen 2.3
 949  */
 950 #define FOLDER_PATH "FOLDER_PATH"
 951
 952 /**
 953  * @brief Folder base name.
 954  * @details You can use above define to set the condition of folder filter and order keyword.
 955  * @since_tizen 2.3
 956  */
 957 #define FOLDER_NAME "FOLDER_NAME"
 958
 959 /**
 960  * @deprecated Deprecated since 9.0.
 961  * @brief Playlist name.
 962  * @details You can use above define to set the condition of playlist filter and order keyword.
 963  * @since_tizen 2.3
 964  */
 965 #define PLAYLIST_NAME "PLAYLIST_NAME"
 966
 967 /**
 968  * @deprecated Deprecated since 9.0.
 969  * @brief Playlist id.
 970  * @details You can use above define to set the condition of playlist filter and order keyword.
 971  * @since_tizen 4.0
 972  */
 973 #define MEDIA_PLAYLIST_ID "PLAYLIST_ID"
 974
 975 /**
 976  * @deprecated Deprecated since 9.0.
 977  * @brief Playlist member order.
 978  * @details You can use above define to set the condition of playlist filter and order keyword.
 979  * @since_tizen 2.3
 980  */
 981 #define PLAYLIST_MEMBER_ORDER "PLAYLIST_MEMBER_ORDER"
 982
 983 /**
 984  * @deprecated Deprecated since 9.0.
 985  * @brief Media count in playlist.
 986  * @details You can use above define to set the condition of playlist filter and order keyword.
 987  * @since_tizen 2.3
 988  */
 989 #define PLAYLIST_MEDIA_COUNT "PLAYLIST_MEDIA_COUNT"
 990
 991 /**
 992  * @deprecated Deprecated since 9.0.
 993  * @brief Tag name.
 994  * @details You can use above define to set the condition of tag filter and order keyword.
 995  * @since_tizen 2.3
 996  */
 997 #define TAG_NAME "TAG_NAME"
 998
 999 /**
1000  * @deprecated Deprecated since 9.0.
1001  * @brief Tag id.
1002  * @details You can use above define to set the condition of tag filter and order keyword.
1003  * @since_tizen 4.0
1004  */
1005 #define MEDIA_TAG_ID "TAG_ID"
1006
1007 /**
1008  * @deprecated Deprecated since 9.0.
1009  * @brief Media count in tag.
1010  * @details You can use above define to set the condition of tag filter and order keyword.
1011  * @since_tizen 2.3
1012  */
1013 #define TAG_MEDIA_COUNT "TAG_MEDIA_COUNT"
1014
1015 /**
1016  * @deprecated Deprecated since 9.0.
1017  * @brief Bookmark marked time.
1018  * @details You can use above define to set the condition of bookmark filter and order keyword.
1019  * @since_tizen 2.3
1020  */
1021 #define BOOKMARK_MARKED_TIME "BOOKMARK_MARKED_TIME"
1022
1023 /**
1024  * @deprecated Deprecated since 9.0.
1025  * @brief Bookmark id.
1026  * @details You can use above define to set the condition of bookmark filter and order keyword.
1027  * @since_tizen 4.0
1028  */
1029 #define MEDIA_BOOKMARK_ID "BOOKMARK_ID"
1030
1031 /**
1032  * @deprecated Deprecated since 9.0.
1033  * @brief Bookmark name.
1034  * @details You can use above define to set the condition of bookmark filter and order keyword.
1035  * @since_tizen 4.0
1036  */
1037 #define BOOKMARK_NAME "BOOKMARK_NAME"
1038
1039 /**
1040  * @deprecated Deprecated since 8.0.
1041  * @brief Face tag.
1042  * @details You can use above define to set the condition of face filter and order keyword.
1043  * @since_tizen 3.0
1044  */
1045 #define MEDIA_FACE_TAG  "MEDIA_FACE_TAG"
1046
1047 /**
1048  * @deprecated Deprecated since 8.0.
1049  * @brief Face id.
1050  * @details You can use above define to set the condition of face filter and order keyword.
1051  * @since_tizen 4.0
1052  */
1053 #define MEDIA_FACE_ID   "MEDIA_FACE_ID"
1054
1055 /**
1056  * @}
1057  */
1058
1059
1060 #ifdef __cplusplus
1061 }
1062 #endif /* __cplusplus */
1063
1064
1065 #endif /*__TIZEN_CONTENT_MEDIA_CONTENT_TYPE_H__*/