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