include_product/media_info.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_INFORMATION_H__
  19 #define __TIZEN_MEDIA_INFORMATION_H__
  20
  21 #include <media_content_type.h>
  22
  23
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif /* __cplusplus */
  28
  29 /**
  30  * @file media_info.h
  31  * @brief This file contains the media info API and related functions to proceed with it. \n
  32  *        You can use the functions to insert, delete, count and get list of content files from media database. \n
  33  *        You can get properties of content file such as size, mime_type, modified_time etc. And you can set properties such as provider, favorite etc. \n
  34  *        And you can get bookmark, face, tag info related the content file.
  35  */
  36
  37
  38 /**
  39  * @addtogroup CAPI_CONTENT_MEDIA_INFO_MODULE
  40  * @{
  41  */
  42
  43 /**
  44  * @brief  Inserts the content file into the media database.
  45  * @details In general, you can use this API to insert content files into the media database. \n
  46  *                You can use media_content_scan_file()/media_content_scan_folder() API instead of this API.
  47  *
  48  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  49  *
  50  * @privlevel public
  51  * @privilege %http://tizen.org/privilege/content.write \n
  52  *                   %http://tizen.org/privilege/mediastorage \n
  53  *                   %http://tizen.org/privilege/externalstorage
  54  *
  55  * @remarks You must release the handle using media_info_destroy(). \n
  56  *                   You must add privilege http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path. \n
  57  *                   If you want to access only internal storage by using  this API, you should add privilege http://tizen.org/privilege/mediastorage. \n
  58  *                   Or if you want to access only external storage by using  this API, you should add privilege http://tizen.org/privilege/externalstorage. \n
  59  *                   If you can access both storage, you must add all privilege.
  60  *
  61  * @param[in]  path The path of the content file to add
  62  * @param[out] info The handle of the inserted content file
  63  *
  64  * @return @c 0 on success,
  65  *         otherwise a negative error value
  66  *
  67  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  68  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  69  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
  70  * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
  71  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
  72  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
  73  * @retval #MEDIA_CONTENT_ERROR_NETWORK           Network fail
  74  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  75  *
  76  * @pre This function requires opened connection to content service by media_content_connect().
  77  *
  78  * @see media_content_connect()
  79  * @see media_content_scan_file()
  80  * @see media_content_scan_folder()
  81  */
  82 int media_info_insert_to_db(const char *path, media_info_h *info);
  83
  84 /**
  85  * @brief Inserts content files into the media database, asynchronously.
  86  * @details This function can insert multiple content files into the media database.
  87  *
  88  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  89  *
  90  * @privlevel public
  91  * @privilege %http://tizen.org/privilege/content.write \n
  92  *                   %http://tizen.org/privilege/mediastorage \n
  93  *                   %http://tizen.org/privilege/externalstorage
  94  *
  95  * @remarks You must add privilege http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path. \n
  96  *                   If you want to access only internal storage by using  this API, you should add privilege http://tizen.org/privilege/mediastorage. \n
  97  *                   Or if you want to access only external storage by using  this API, you should add privilege http://tizen.org/privilege/externalstorage. \n
  98  *                   If you can access both storage, you must add all privilege.
  99  *
 100  * @param[in] path_array   The path array of the content files to add
 101  * @param[in] array_length The length of the array
 102  * @param[in] callback     The callback to be invoked when media items inserted completely
 103  * @param[in] user_data    The user data to be passed to the callback function
 104  *
 105  * @return @c 0 on success,
 106  *         otherwise a negative error value
 107  *
 108  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 109  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 110  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 111  * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
 112  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
 113  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
 114  * @retval #MEDIA_CONTENT_ERROR_NETWORK           Network fail
 115  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 116  *
 117  * @pre This function requires opened connection to content service by media_content_connect().
 118  *
 119  * @see media_content_connect()
 120  * @see media_insert_completed_cb()
 121  */
 122 int media_info_insert_batch_to_db(const char **path_array, unsigned int array_length, media_insert_completed_cb callback, void *user_data);
 123
 124 /**
 125  * @brief Inserts the burst shot images into the media database, asynchronously.
 126  * @details This function inserts burst images into the media database.
 127  *          media_insert_burst_shot_completed_cb() will be called when insertion to media database is finished.
 128  *
 129  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 130  *
 131  * @privlevel public
 132  * @privilege %http://tizen.org/privilege/content.write \n
 133  *                   %http://tizen.org/privilege/mediastorage \n
 134  *                   %http://tizen.org/privilege/externalstorage
 135  *
 136  * @remarks You must add privilege http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path. \n
 137  *                   If you want to access only internal storage with this API, you should add privilege http://tizen.org/privilege/mediastorage. \n
 138  *                   Or if you want to access only external storage with this API, you should add privilege http://tizen.org/privilege/externalstorage. \n
 139  *                   If you can access both storage, you must add all privilege.
 140  *
 141  * @param[in] path_array   The path array of the burst shot images to add
 142  * @param[in] array_length The length of the array
 143  * @param[in] callback     The callback to be invoked when the images are inserted completely
 144  * @param[in] user_data    The user data to be passed to the callback function
 145  *
 146  * @return @c 0 on success,
 147  *         otherwise a negative error value
 148  *
 149  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 150  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 151  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 152  * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
 153  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
 154  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
 155  * @retval #MEDIA_CONTENT_ERROR_NETWORK           Network fail
 156  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 157  *
 158  * @pre This function requires opened connection to content service by media_content_connect().
 159  *
 160  * @see media_content_connect()
 161  * @see media_insert_burst_shot_completed_cb()
 162  */
 163 int media_info_insert_burst_shot_to_db(const char **path_array, unsigned int array_length, media_insert_burst_shot_completed_cb callback, void *user_data);
 164
 165 /**
 166  * @brief Deletes the media information from the media database.
 167  * @details This function only remove media information in the media database. \n
 168  *               You can use media_content_scan_file()/media_content_scan_folder() API instead of this API if file is removed from the file system.
 169  *
 170  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 171  *
 172  * @privlevel public
 173  * @privilege %http://tizen.org/privilege/content.write
 174  *
 175  * @param[in] media_id  The media ID. It can get from media info handle.
 176  *
 177  * @return @c 0 on success,
 178  *         otherwise a negative error value
 179  *
 180  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 181  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 182  * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
 183  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
 184  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
 185  * @retval #MEDIA_CONTENT_ERROR_NETWORK           Network fail
 186  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 187  *
 188  * @pre This function requires opened connection to content service by media_content_connect().
 189  *
 190  * @see media_content_connect()
 191  * @see media_content_scan_file()
 192  * @see media_content_scan_folder()
 193  */
 194 int media_info_delete_from_db(const char *media_id);
 195
 196 /**
 197  * @brief Deletes media information that meets the conditions of the filter from the media database.
 198  * @details This function can delete multiple media information from the media database.
 199  *
 200  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 201  *
 202  * @privlevel public
 203  * @privilege %http://tizen.org/privilege/content.write
 204  *
 205  * @param[in] filter  The filter handle
 206  *
 207  * @return @c 0 on success,
 208  *         otherwise a negative error value
 209  *
 210  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 211  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 212  * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
 213  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
 214  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
 215  * @retval #MEDIA_CONTENT_ERROR_NETWORK           Network fail
 216  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 217  *
 218  * @pre This function requires opened connection to content service by media_content_connect().
 219  *
 220  * @see media_content_connect()
 221  * @see media_filter_create()
 222  */
 223 int media_info_delete_batch_from_db(filter_h filter);
 224
 225
 226 /**
 227  * @brief Destroys media info.
 228  * @details The function frees all resources related to the media info handle. This handle
 229  *          can no longer be used to perform any operation. New media info handle has to
 230  *          be created before the next usage.
 231  *
 232  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 233  *
 234  * @param[in]  media  The media info handle
 235  *
 236  * @return @c 0 on success,
 237  *         otherwise a negative error value
 238  *
 239  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 240  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 241  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 242  *
 243  * @pre Get copy of media_info handle by calling media_info_clone().
 244  *
 245  * @see media_info_clone()
 246  */
 247 int media_info_destroy(media_info_h media);
 248
 249 /**
 250  * @brief Clones the media info handle.
 251  *
 252  * @details This function copies the media info handle from a source to the destination.
 253  *          There is no media_info_create() function. The media_info_h is created internally and
 254  *          available through media info foreach function such as media_info_foreach_media_from_db() or media_info_insert_to_db().
 255  *          To use this handle outside of these foreach functions, use this function.
 256  *
 257  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 258  *
 259  * @remarks You must release the destination handle using media_info_destroy().
 260  *
 261  * @param[out] dst  The destination handle to the media info
 262  * @param[in]  src  The source handle to media info
 263  *
 264  * @return @c 0 on success,
 265  *         otherwise a negative error value
 266  *
 267  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 268  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 269  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 270  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 271  *
 272  * @see media_info_destroy()
 273  * @see media_album_foreach_media_from_db()
 274  * @see media_playlist_foreach_media_from_db()
 275  * @see media_group_foreach_media_from_db()
 276  * @see media_tag_foreach_media_from_db()
 277  * @see media_info_foreach_media_from_db()
 278  * @see media_info_insert_to_db()
 279  * @see media_folder_foreach_media_from_db()
 280  */
 281 int media_info_clone(media_info_h *dst, media_info_h src);
 282
 283 /**
 284  * @brief Gets the count of media info for the passed @a filter from the media database.
 285  * @details If @c NULL is passed to the @a filter, then no filtering is applied.
 286  *
 287  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 288  *
 289  *
 290  * @param[in]  filter      The handle to filter
 291  * @param[out] media_count The count of media
 292  *
 293  * @return @c 0 on success,
 294  *         otherwise a negative error value
 295  *
 296  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 297  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 298  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
 299  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
 300  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 301  *
 302  * @pre This function requires opened connection to content service by media_content_connect().
 303  *
 304  * @see media_content_connect()
 305  * @see media_filter_create()
 306  */
 307 int media_info_get_media_count_from_db(filter_h filter, int *media_count);
 308
 309 /**
 310  * @brief Iterates through media info from the media database.
 311  * @details This function gets all media info handles meeting the given @a filter.
 312  *          The @a callback function will be invoked for every retrieved media info.
 313  *          If @c NULL is passed to the @a filter, then no filtering is applied.
 314  *
 315  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 316  *
 317  * @remarks Do not call updating DB function like media_info_update_to_db(), media_info_refresh_metadata_to_db(), audio_meta_update_to_db(), image_meta_update_to_db() and video_meta_update_to_db()  in your callback function,
 318  *                   your callback function is invoked as inline function.
 319  *                   So, your callback function is in read state in SQLite. When you are in read state, sometimes you do not update DB.
 320  *                   We do not recommend you call updating DB function in callback of foreach function.
 321  *
 322  * @param[in] filter    The media info handle filter
 323  * @param[in] callback  The callback function to be invoked
 324  * @param[in] user_data The user data to be passed to the callback function
 325  *
 326  * @return @c 0 on success,
 327  *         otherwise a negative error value
 328  *
 329  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 330  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 331  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 332  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
 333  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
 334  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 335  *
 336  * @pre  This function requires opened connection to content service by media_content_connect().
 337  * @post This function invokes media_info_cb().
 338  *
 339  * @see media_content_connect()
 340  * @see #media_info_cb
 341  * @see media_info_filter_create()
 342  */
 343 int media_info_foreach_media_from_db(filter_h filter, media_info_cb callback, void *user_data);
 344
 345 /**
 346  * @brief Gets the count of media tags for the passed @a filter in the given @a media_id from the media database.
 347  * @details If @c NULL is passed to the @a filter, then no filtering is applied.
 348  *
 349  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 350  *
 351  * @param[in]  media_id  The ID of the media info
 352  * @param[in]  filter    The handle to the media filter
 353  * @param[out] tag_count The count of the media tag
 354  *
 355  * @return @c 0 on success,
 356  *         otherwise a negative error value
 357  *
 358  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 359  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 360  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
 361  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
 362  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 363  *
 364  * @pre This function requires opened connection to content service by media_content_connect().
 365  *
 366  * @see media_content_connect()
 367  * @see media_filter_create()
 368  */
 369 int media_info_get_tag_count_from_db(const char *media_id, filter_h filter, int *tag_count);
 370
 371 /**
 372  * @brief Iterates through the media tag in the given media info from the media database.
 373  * @details This function gets all the media tags associated with the given @a media_id and calls registered callback function for every retrieved media tag. \n
 374  *               If @c NULL is passed to the @a filter, then no filtering is applied.
 375  *
 376  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 377  *
 378  * @param[in] media_id  The ID of the media info
 379  * @param[in] filter    The handle to the media filter
 380  * @param[in] callback  The callback function to be invoked
 381  * @param[in] user_data The user data to be passed to the callback function
 382  *
 383  * @return @c 0 on success,
 384  *         otherwise a negative error value
 385  *
 386  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 387  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 388  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 389  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
 390  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
 391  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 392  *
 393  * @pre  This function requires opened connection to content service by media_content_connect().
 394  * @post This function invokes media_tag_cb().
 395  *
 396  * @see media_content_connect()
 397  * @see #media_tag_cb
 398  * @see media_filter_create()
 399  */
 400 int media_info_foreach_tag_from_db(const char *media_id, filter_h filter, media_tag_cb callback, void *user_data);
 401
 402 /**
 403  * @brief Gets the number of bookmarks for the passed @a filter in the given media ID from the media database.
 404  * @details If @c NULL is passed to the @a filter, then no filtering is applied.
 405  *
 406  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 407  *
 408  * @param[in]  media_id        The ID of the media info
 409  * @param[in]  filter          The handle to the media filter
 410  * @param[out] bookmark_count  The count of the media tag
 411  *
 412  * @return @c 0 on success,
 413  *         otherwise a negative error value
 414  *
 415  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 416  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 417  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
 418  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
 419  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 420  *
 421  * @pre This function requires opened connection to content service by media_content_connect().
 422  *
 423  * @see media_content_connect()
 424  * @see media_filter_create()
 425  */
 426 int media_info_get_bookmark_count_from_db(const char *media_id, filter_h filter, int *bookmark_count);
 427
 428 /**
 429  * @brief Iterates through the media bookmark in the given media info from the media database.
 430  * @details This function gets all media bookmarks associated with the given media and calls registered callback function for every retrieved media bookmark.
 431  *                If @c NULL is passed to the @a filter, then no filtering is applied.
 432  *
 433  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 434  *
 435  * @param[in] media_id  The ID of the media info
 436  * @param[in] filter    The handle to the media filter
 437  * @param[in] callback  The callback function to be invoked
 438  * @param[in] user_data The user data to be passed to the callback function
 439  *
 440  * @return @c 0 on success,
 441  *         otherwise a negative error value
 442  *
 443  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 444  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 445  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 446  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
 447  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
 448  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 449  *
 450  * @pre  This function requires opened connection to content service by media_content_connect().
 451  * @post This function invokes media_bookmark_cb().
 452  *
 453  * @see media_content_connect()
 454  * @see media_bookmark_cb()
 455  * @see media_filter_create()
 456  */
 457 int media_info_foreach_bookmark_from_db(const char *media_id, filter_h filter, media_bookmark_cb callback, void *user_data);
 458
 459 /**
 460  * @brief Gets the number of face for the passed @a media_id from the media database.
 461  * @details If @c NULL is passed to the @a filter, then no filtering is applied.
 462  *
 463  * @since_tizen 3.0
 464  *
 465  * @param[in] media_id media id
 466  * @param[in]  filter          The handle to the media filter
 467  * @param[out] face_count The count of media face
 468  *
 469  * @return 0 on success, otherwise a negative error value.
 470  *
 471  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 472  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 473  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB operation failed
 474  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 475  *
 476  * @pre This function requires opened connection to content service by media_content_connect().
 477  * @see media_content_connect()
 478  * @see media_filter_create()
 479  *
 480  */
 481 int media_info_get_face_count_from_db(const char *media_id, filter_h filter, int *face_count);
 482
 483 /**
 484  * @brief Iterates through the media files with optional @a media_id in the given @a face @a face from the media database.
 485  * @details This function gets all media face info associated with the given media id and
 486  * meeting desired filter option and calls registered callback function for
 487  * every retrieved media face info. If NULL is passed to the @a filter, no filtering is applied.
 488  *
 489  * @since_tizen 3.0
 490  *
 491  * @param [in] media_id media id
 492  * @param[in]  filter          The handle to the media filter
 493  * @param [in] callback The callback function to invoke
 494  * @param [in] user_data The user data to be passed to the callback function
 495  *
 496  * @return 0 on success, otherwise a negative error value.
 497  *
 498  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
 499  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 500  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
 501  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 502  *
 503  * @pre This function requires opened connection to content service by media_content_connect().
 504  * @see media_content_connect()
 505  * @see media_filter_create()
 506  *
 507  */
 508 int media_info_foreach_face_from_db(const char *media_id, filter_h filter, media_face_cb callback, void *user_data);
 509
 510 /**
 511  * @brief Gets the image metadata handle for a given media info
 512  * @details This function returns an image metadata handle retrieved from the media info.
 513  *
 514  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 515  *
 516  * @remarks You must release the @a image handle using image_meta_destroy().
 517  *
 518  * @param[in]  media  The media info handle
 519  * @param[out] image  A handle to image metadata
 520  *
 521  * @return @c 0 on success,
 522  *         otherwise a negative error value
 523  *
 524  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 525  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 526  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 527  *
 528  * @see image_meta_destroy()
 529  */
 530 int media_info_get_image(media_info_h media, image_meta_h *image);
 531
 532 /**
 533  * @brief Gets a video metadata handle for a given media info.
 534  * @details This function returns a video metadata handle retrieved from the media info handle.
 535  *
 536  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 537  *
 538  * @remarks You must release the @a video handle using video_meta_destroy().
 539  *
 540  * @param[in]  media The media info handle
 541  * @param[out] video A handle to the video meta
 542  *
 543  * @return @c 0 on success,
 544  *         otherwise a negative error value
 545  *
 546  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 547  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 548  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 549  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 550  *
 551  * @see video_meta_destroy()
 552  */
 553 int media_info_get_video(media_info_h media, video_meta_h *video);
 554
 555 /**
 556  * @brief Gets an audio metadata handle for a given media info.
 557  * @details This function returns an audio metadata handle retrieved from the media info handle.
 558  *
 559  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 560  *
 561  * @remarks You must release the @a audio handle using audio_meta_destroy().
 562  *
 563  * @param[in]  media The media info handle
 564  * @param[out] audio A handle to the audio meta
 565  *
 566  * @return @c 0 on success,
 567  *         otherwise a negative error value
 568  *
 569  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 570  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 571  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 572  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 573  *
 574  * @see audio_meta_destroy()
 575  */
 576 int media_info_get_audio(media_info_h media, audio_meta_h *audio);
 577
 578 /**
 579  * @brief Gets the media ID
 580  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 581  *
 582  * @param[in]  media The media info handle
 583  * @param[out] media_id     The media ID
 584  *
 585  * @return @c 0 on success,
 586  *         otherwise a negative error value
 587  *
 588  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 589  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 590  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 591  */
 592 int media_info_get_media_id(media_info_h media, char **media_id);
 593
 594 /**
 595  * @brief Gets the full path of the content file.
 596  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 597  *
 598  * @remarks You must release @a path using free().
 599  *
 600  * @param[in]  media The media info handle
 601  * @param[out] path  The full path of the content file
 602  *
 603  * @return @c 0 on success,
 604  *         otherwise a negative error value
 605  *
 606  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 607  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 608  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 609  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 610  *
 611  */
 612 int media_info_get_file_path(media_info_h media, char **path);
 613
 614 /**
 615  * @brief Gets the file name including the extension of the content file.
 616  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 617  *
 618  * @remarks You must release @a name using free().
 619  *
 620  * @param[in]  media The media info handle
 621  * @param[out] name  The file name including the extension of the content file
 622  *
 623  * @return @c 0 on success,
 624  *         otherwise a negative error value
 625  *
 626  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 627  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 628  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 629  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 630  */
 631 int media_info_get_display_name(media_info_h media, char **name);
 632
 633 /**
 634  * @brief Gets the content type of the content file.
 635  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 636  *
 637  * @param[in]  media The media info handle
 638  * @param[out] type  The content type of the content file (#media_content_type_e)
 639  *
 640  * @return @c 0 on success,
 641  *         otherwise a negative error value
 642  *
 643  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 644  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 645  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 646  *
 647  * @see #media_content_type_e
 648  */
 649 int media_info_get_media_type(media_info_h media, media_content_type_e *type);
 650
 651 /**
 652  * @brief Gets the MIME type of the content file.
 653  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 654  *
 655  * @remarks You must release @a mime_type using free().
 656  *
 657  * @param[in]  media     The media info handle
 658  * @param[out] mime_type The MIME type of the content file
 659  *
 660  * @return @c 0 on success,
 661  *         otherwise a negative error value
 662  *
 663  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 664  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 665  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 666  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 667  */
 668 int media_info_get_mime_type(media_info_h media, char **mime_type);
 669
 670 /**
 671  * @brief Gets the content file size.
 672  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 673  *
 674  * @param[in]  media The media info handle
 675  * @param[out] size  The content file size
 676  *
 677  * @return @c 0 on success,
 678  *         otherwise a negative error value
 679  *
 680  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 681  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 682  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 683  */
 684 int media_info_get_size(media_info_h media, unsigned long long *size);
 685
 686 /**
 687  * @brief Gets the added time of the content file.
 688  * @details The added time refers to the time that content file was first added to media database.
 689  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 690  *
 691  * @param[in]  media      The media info handle
 692  * @param[out] added_time The added time to the media database
 693  *
 694  * @return @c 0 on success,
 695  *         otherwise a negative error value
 696  *
 697  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 698  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 699  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 700  */
 701 int media_info_get_added_time(media_info_h media, time_t *added_time);
 702
 703 /**
 704  * @brief Gets the modified time of the content file.
 705  * @details The modified time refers to the last modification time provided by the file system.
 706  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 707  *
 708  * @param[in]  media The media info handle
 709  * @param[out] time  The last modification time of the content file
 710  *
 711  * @return @c 0 on success,
 712  *         otherwise a negative error value
 713  *
 714  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 715  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 716  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 717  */
 718 int media_info_get_modified_time(media_info_h media, time_t *time);
 719
 720 /**
 721  * @brief Gets the timeline of content file.
 722  * @details If the content file has the creation time information (like Content recored date or Image creation date), that value is timeline. \n
 723  *               Otherwise, timeline value is the same as modified time.
 724  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 725  *
 726  * @param[in]  media The media info handle
 727  * @param[out] time  The timeline of content file
 728  *
 729  * @return @c 0 on success,
 730  *         otherwise a negative error value
 731  *
 732  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 733  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 734  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 735  */
 736 int media_info_get_timeline(media_info_h media, time_t *time);
 737
 738 /**
 739  * @brief Gets the thumbnail path of content file.
 740  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 741  *
 742  * @remarks You must release @a path using free(). \n
 743  *                   If the thumbnail extraction for the given media has not been requested yet, this API returns NULL. To create a thumbnail, you should use media_info_create_thumbnail() API. \n
 744  *                   Since 3.0, this function returns an empty string if media_info_create_thumbnail() has failed to create a thumbnail for the given media.
 745  *
 746  * @param[in]  media The media info handle
 747  * @param[out] path  The thumbnail path
 748  *
 749  * @return @c 0 on success,
 750  *         otherwise a negative error value
 751  *
 752  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 753  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 754  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 755  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 756  */
 757 int media_info_get_thumbnail_path(media_info_h media, char **path);
 758
 759 /**
 760  * @brief Gets the description of content file.
 761  * @details If the value is an empty string, the method returns "Unknown". \n
 762  *                Since 3.0, if the media info has no description, the method returns empty string.
 763  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 764  *
 765  * @remarks You must release @a description using free().
 766  *
 767  * @param[in]  media       The media info handle
 768  * @param[out] description The description of the content file
 769  *
 770  * @return @c 0 on success,
 771  *         otherwise a negative error value
 772  *
 773  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 774  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 775  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 776  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 777  */
 778 int media_info_get_description(media_info_h media, char **description);
 779
 780 /**
 781  * @brief Gets the longitude of content file.
 782  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 783  *
 784  * @param[in]  media     The media info handle
 785  * @param[out] longitude The longitude of the content file
 786  *
 787  * @return @c 0 on success,
 788  *         otherwise a negative error value
 789  *
 790  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 791  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 792  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 793  */
 794 int media_info_get_longitude(media_info_h media, double* longitude);
 795
 796 /**
 797  * @brief Gets the latitude of content file.
 798  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 799  *
 800  * @param[in]  media    The media info handle
 801  * @param[out] latitude The latitude of the content file
 802  *
 803  * @return @c 0 on success,
 804  *         otherwise a negative error value
 805  *
 806  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 807  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 808  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 809  *
 810  */
 811 int media_info_get_latitude(media_info_h media, double* latitude);
 812
 813 /**
 814  * @brief Gets the altitude of content file.
 815  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 816  *
 817  * @param[in]  media    The media info handle
 818  * @param[out] altitude The altitude of the content file
 819  *
 820  * @return @c 0 on success,
 821  *         otherwise a negative error value
 822  *
 823  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 824  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 825  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 826  */
 827 int media_info_get_altitude(media_info_h media, double* altitude);
 828
 829 /**
 830  * @brief Gets the weather of content file.
 831  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 832  *
 833  * @param[in]  media   The media info handle
 834  * @param[out] weather The weather of the content file
 835  *
 836  * @return @c 0 on success,
 837  *         otherwise a negative error value
 838  *
 839  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 840  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 841  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 842  */
 843 int media_info_get_weather(media_info_h media, char **weather);
 844
 845 /**
 846  * @brief Gets the rating of content file.
 847  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 848  *
 849  * @param[in]  media  The media info handle
 850  * @param[out] rating The rating of the content file
 851  *
 852  * @return @c 0 on success,
 853  *         otherwise a negative error value
 854  *
 855  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 856  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 857  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 858  */
 859 int media_info_get_rating(media_info_h media, int *rating);
 860
 861 /**
 862  * @brief Gets the favorite status of content file which User set.
 863  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 864  *
 865  * @param[in]  media     The media info handle
 866  * @param[out] favorite  @c true if content file is set as favorite,
 867  *                       otherwise @c false if content file is not set as favorite
 868  *
 869  * @return @c 0 on success,
 870  *         otherwise a negative error value
 871  *
 872  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 873  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 874  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 875  *
 876  * @see media_info_set_favorite()
 877  */
 878 int media_info_get_favorite(media_info_h media, bool* favorite);
 879
 880 /**
 881  * @brief Gets the author of content file.
 882  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 883  *
 884  * @remarks You must release @a author using free().
 885  *
 886  * @param[in]  media  The media info handle
 887  * @param[out] author The author of the content file
 888  *
 889  * @return @c 0 on success,
 890  *         otherwise a negative error value
 891  *
 892  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 893  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 894  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 895  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 896  */
 897 int media_info_get_author(media_info_h media, char **author);
 898
 899 /**
 900  * @brief Gets the provider of content file which User set.
 901  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 902  *
 903  * @remarks You must release @a provider using free().
 904  *
 905  * @param[in]  media    The media info handle
 906  * @param[out] provider The provider of the content file
 907  *
 908  * @return @c 0 on success,
 909  *         otherwise a negative error value
 910  *
 911  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 912  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 913  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 914  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 915  *
 916  * @see media_info_set_provider()
 917  */
 918 int media_info_get_provider(media_info_h media, char **provider);
 919
 920 /**
 921  * @brief Gets the content name of content file which User set.
 922  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 923  *
 924  * @remarks You must release @a content_name using free().
 925  *
 926  * @param[in]  media        The media info handle
 927  * @param[out] content_name The content name of the content file
 928  *
 929  * @return @c 0 on success,
 930  *         otherwise a negative error value
 931  *
 932  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 933  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 934  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 935  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 936  *
 937  * @see media_info_set_content_name()
 938  */
 939 int media_info_get_content_name(media_info_h media, char **content_name);
 940
 941 /**
 942  * @brief Gets the title of content file.
 943  * @details If the value is an empty string, the method returns "Unknown". \n
 944  *                Since 3.0, if the content file has no title, the method returns empty string.
 945  *
 946  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 947  *
 948  * @remarks You must release @a title using free().
 949  *
 950  * @param[in]  media  The media info handle
 951  * @param[out] title  The title of the content file
 952  *
 953  * @return @c 0 on success,
 954  *         otherwise a negative error value
 955  *
 956  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 957  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 958  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 959  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 960  */
 961 int media_info_get_title(media_info_h media, char **title);
 962
 963 /**
 964  * @brief Gets the category of content file which User set.
 965  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 966  *
 967  * @remarks You must release @a category using free().
 968  *
 969  * @param[in]  media    The media info handle
 970  * @param[out] category The category of the content file
 971  *
 972  * @return @c 0 on success,
 973  *         otherwise a negative error value
 974  *
 975  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 976  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 977  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 978  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
 979  *
 980  * @see media_info_set_category()
 981  */
 982 int media_info_get_category(media_info_h media, char **category);
 983
 984 /**
 985  * @brief Gets the location tag of content file which User set.
 986  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
 987  *
 988  * @remarks You must release @a location_tag using free().
 989  *
 990  * @param[in]  media        The media info handle
 991  * @param[out] location_tag The location of the content file
 992  *
 993  * @return @c 0 on success,
 994  *         otherwise a negative error value
 995  *
 996  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
 997  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
 998  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
 999  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1000  *
1001  * @see media_info_set_location_tag()
1002  */
1003 int media_info_get_location_tag(media_info_h media, char **location_tag);
1004
1005 /**
1006  * @brief Gets the age_rating of content file which User set.
1007  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1008  *
1009  * @remarks You must release @a age_rating using free().
1010  *
1011  * @param[in]  media      The media info handle
1012  * @param[out] age_rating The age rating of the content file
1013  *
1014  * @return @c 0 on success,
1015  *         otherwise a negative error value
1016  *
1017  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1018  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
1019  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1020  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1021  *
1022  * @see media_info_set_age_rating()
1023  */
1024 int media_info_get_age_rating(media_info_h media, char **age_rating);
1025
1026 /**
1027  * @brief Gets the keyword of content file which User set.
1028  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1029  *
1030  * @remarks You must release @a keyword using free().
1031  *
1032  * @param[in]  media   The media info handle
1033  * @param[out] keyword The keyword of the content file
1034  *
1035  * @return @c 0 on success,
1036  *         otherwise a negative error value
1037  *
1038  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1039  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
1040  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1041  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1042  *
1043  * @see media_info_set_keyword()
1044  */
1045 int media_info_get_keyword(media_info_h media, char **keyword);
1046
1047 /**
1048  * @brief Gets the storage id of content file.
1049  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
1050  *
1051  * @remarks You must release @a storage_id using free().
1052  *
1053  * @param[in]  media   The media info handle
1054  * @param[out] storage_id The storage id of the content file
1055  *
1056  * @return @c 0 on success,
1057  *         otherwise a negative error value
1058  *
1059  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1060  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
1061  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1062  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1063  */
1064 int media_info_get_storage_id(media_info_h media, char **storage_id);
1065
1066 /**
1067  * @brief Checks whether the media is protected via DRM.
1068  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1069  *
1070  * @param[in]  media  The media info handle
1071  * @param[out] is_drm @c true if media is DRM media,
1072  *                    otherwise @c false if media is not DRM media
1073  *
1074  * @return @c 0 on success,
1075  *         otherwise a negative error value
1076  *
1077  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1078  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1079  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1080  */
1081 int media_info_is_drm(media_info_h media, bool *is_drm);
1082
1083 /**
1084  * @brief Checks whether the content file is 360 content.
1085  * @since_tizen 3.0
1086  *
1087  * @param[in]  media  The media info handle
1088  * @param[out] is_360 @c true if media is 360 content,
1089  *                    otherwise @c false if media is not 360 content
1090  *
1091  * @return @c 0 on success,
1092  *         otherwise a negative error value
1093  *
1094  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1095  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1096  */
1097 int media_info_is_360_content(media_info_h media, bool *is_360);
1098
1099 /**
1100  * @brief Gets the storage type of content file.
1101  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1102  *
1103  * @param[in]  media        The media info handle
1104  * @param[out] storage_type The storage type of the content file
1105  *
1106  * @return @c 0 on success,
1107  *         otherwise a negative error value
1108  *
1109  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1110  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1111  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1112  */
1113 int media_info_get_storage_type(media_info_h media, media_content_storage_e *storage_type);
1114
1115 /**
1116  * @brief Gets number which represents how many times given content has been played.
1117  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
1118  *
1119  * @param [in] media The handle to media info
1120  * @param [out] played_count The counter of content played
1121  *
1122  * @return 0 on success,
1123  *         otherwise a negative error value
1124  *
1125  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
1126  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1127  */
1128 int media_info_get_played_count(media_info_h media, int *played_count);
1129
1130 /**
1131  * @brief Gets the content's played time parameter.
1132  * @details Function returns content's elapsed playback time parameter as period
1133  *          starting from the beginning of the track.
1134  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
1135  *
1136  * @param [in] media The handle to media info
1137  * @param [out] played_time The elapsed time of the content
1138  *
1139  * @return 0 on success,
1140  *         otherwise a negative error value
1141  *
1142  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
1143  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1144  */
1145 int media_info_get_played_time(media_info_h media, time_t *played_time);
1146
1147 /**
1148  * @brief Gets the media info from the media database.
1149  *
1150  * @details This function creates a new media handle from the media database by the given @a media_id.
1151  *          Media info will be created and filled with information.
1152  *
1153  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1154  *
1155  * @remarks You must release @a media using media_tag_destroy().
1156  *
1157  * @param[in]  media_id The ID of media info
1158  * @param[out] media    The media handle associated with the media ID
1159  *
1160  * @return @c 0 on success,
1161  *         otherwise a negative error value
1162  *
1163  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1164  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1165  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1166  *
1167  * @pre This function requires opened connection to content service by media_content_connect().
1168  *
1169  * @see media_content_connect()
1170  * @see media_info_destroy()
1171  */
1172 int media_info_get_media_from_db(const char *media_id, media_info_h *media);
1173
1174 /**
1175  * @brief Increments the played count to content meta handle.
1176  * @details You can increase the played(opened) count of the content file.
1177  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
1178  *
1179  * @param [in] media The handle to media info
1180  *
1181  * @return 0 on success,
1182  *         otherwise a negative error value
1183  *
1184  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
1185  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1186  *
1187  * @post media_info_update_to_db()
1188  */
1189 int media_info_increase_played_count(media_info_h media);
1190
1191 /**
1192  * @brief Sets the played time to content meta handle.
1193  * @details You can set the latest played(opened) time of the content file. the latest played time to be set the current time on the system.
1194  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
1195  *
1196  * @param [in] media The handle to media info
1197  *
1198  * @return 0 on success,
1199  *         otherwise a negative error value
1200  *
1201  * @retval #MEDIA_CONTENT_ERROR_NONE Successful
1202  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1203  *
1204  * @post media_info_update_to_db()
1205  */
1206 int media_info_set_played_time(media_info_h media);
1207
1208 /**
1209  * @brief Sets the file name including the extension of the content file.
1210  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1211  *
1212  * @param[in] media        The media info handle
1213  * @param[in] display_name The file name including the extension of the content file.
1214  *
1215  * @return @c 0 on success,
1216  *         otherwise a negative error value
1217  *
1218  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1219  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
1220  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1221  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1222  *
1223  * @post media_info_update_to_db().
1224  *
1225  */
1226 int media_info_set_display_name(media_info_h media, const char *display_name);
1227
1228 /**
1229  * @brief Sets the description of media info.
1230  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1231  *
1232  * @param[in] media       The media info handle
1233  * @param[in] description The description of the media info
1234  *
1235  * @return @c 0 on success,
1236  *         otherwise a negative error value
1237  *
1238  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1239  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
1240  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1241  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1242  *
1243  * @post media_info_update_to_db().
1244  *
1245  */
1246 int media_info_set_description(media_info_h media, const char *description);
1247
1248 /**
1249  * @brief Sets the longitude of media info.
1250  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1251  *
1252  * @param[in] media     The media info handle
1253  * @param[in] longitude The longitude of the media info
1254  *
1255  * @return @c 0 on success,
1256  *         otherwise a negative error value
1257  *
1258  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1259  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
1260  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1261  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1262  *
1263  * @post media_info_update_to_db().
1264  */
1265 int media_info_set_longitude(media_info_h media, double longitude);
1266
1267 /**
1268  * @brief Sets the latitude of media info.
1269  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1270  *
1271  * @param[in] media    The media info handle
1272  * @param[in] latitude The latitude of the media info
1273  *
1274  * @return @c 0 on success,
1275  *         otherwise a negative error value
1276  *
1277  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1278  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
1279  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1280  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1281  *
1282  * @post media_info_update_to_db().
1283  */
1284 int media_info_set_latitude(media_info_h media, double latitude);
1285
1286 /**
1287  * @brief Sets the altitude of media info.
1288  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1289  *
1290  * @param[in] media    The media info handle
1291  * @param[in] altitude The altitude of the media info
1292  *
1293  * @return @c 0 on success,
1294  *         otherwise a negative error value
1295  *
1296  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1297  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
1298  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1299  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1300  *
1301  * @post media_info_update_to_db().
1302  */
1303 int media_info_set_altitude(media_info_h media, double altitude);
1304
1305 /**
1306  * @brief Sets the weather of media info.
1307  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1308  *
1309  * @param[in] media   The media info handle
1310  * @param[in] weather The weather of the media info
1311  *
1312  * @return @c 0 on success,
1313  *         otherwise a negative error value
1314  *
1315  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1316  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
1317  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1318  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1319  *
1320  * @post media_info_update_to_db().
1321  *
1322  */
1323 int media_info_set_weather(media_info_h media, const char *weather);
1324
1325 /**
1326  * @brief Sets the rating of media info.
1327  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1328  *
1329  * @param[in] media  The media info handle
1330  * @param[in] rating The rating of the media info
1331  *
1332  * @return @c 0 on success,
1333  *         otherwise a negative error value
1334  *
1335  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1336  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
1337  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1338  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1339  *
1340  * @post media_info_update_to_db().
1341  */
1342 int media_info_set_rating(media_info_h media, int rating);
1343
1344 /**
1345  * @brief Sets the favorite of media info.
1346  * @details This function can mark favorite of the media. If set to @c true, this fuction record the time of the change moment. \n
1347  *                So, If you use it in order parameter, you can sort the order of the time was a favorite. \n
1348  *                Or, if you use it in condition parameter, you can get the result of the favorite media.
1349  *
1350  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1351  *
1352  * @param[in] media    The media info handle
1353  * @param[in] favorite Set @c true to set the media info as favorite,
1354  *                     otherwise set @c false to not set the media info as favorite
1355  *
1356  * @return @c 0 on success,
1357  *         otherwise a negative error value
1358  *
1359  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1360  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
1361  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1362  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1363  */
1364 int media_info_set_favorite(media_info_h media, bool favorite);
1365
1366 /**
1367  * @brief Sets the author of media info.
1368  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1369  *
1370  * @param[in] media  The media info handle
1371  * @param[in] author The author of the media info
1372  *
1373  * @return @c 0 on success,
1374  *         otherwise a negative error value
1375  *
1376  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1377  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
1378  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1379  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1380  */
1381 int media_info_set_author(media_info_h media, const char *author);
1382
1383 /**
1384  * @brief Sets the provider of media info.
1385  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1386  *
1387  * @param[in] media    The media info handle
1388  * @param[in] provider The provider of the media info
1389  *
1390  * @return @c 0 on success,
1391  *         otherwise a negative error value
1392  *
1393  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1394  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
1395  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1396  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1397  */
1398 int media_info_set_provider(media_info_h media, const char *provider);
1399
1400 /**
1401  * @brief Sets the content name of media info.
1402  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1403  *
1404  * @param[in] media        The media info handle
1405  * @param[in] content_name The content name of the media info
1406  *
1407  * @return @c 0 on success,
1408  *         otherwise a negative error value
1409  *
1410  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1411  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
1412  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1413  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1414  *
1415  * @post media_info_update_to_db()
1416  */
1417 int media_info_set_content_name(media_info_h media, const char *content_name);
1418
1419 /**
1420  * @brief Sets the category of media info.
1421  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1422  *
1423  * @param[in] media    The media info handle
1424  * @param[in] category The category of the media info
1425  *
1426  * @return @c 0 on success,
1427  *         otherwise a negative error value
1428  *
1429  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1430  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
1431  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1432  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1433  *
1434  * @post media_info_update_to_db()
1435  */
1436 int media_info_set_category(media_info_h media, const char *category);
1437
1438 /**
1439  * @brief Sets the location tag of media info.
1440  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1441  *
1442  * @param[in] media        The media info handle
1443  * @param[in] location_tag The location of the media info
1444  *
1445  * @return @c 0 on success,
1446  *         otherwise a negative error value
1447  *
1448  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1449  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
1450  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1451  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1452  *
1453  * @post media_info_update_to_db()
1454  */
1455 int media_info_set_location_tag(media_info_h media, const char *location_tag);
1456
1457 /**
1458  * @brief Sets the age rating of media info.
1459  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1460  *
1461  * @param[in] media      The media info handle
1462  * @param[in] age_rating The age rating of the media info
1463  *
1464  * @return @c 0 on success,
1465  *         otherwise a negative error value
1466  *
1467  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1468  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
1469  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1470  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1471  *
1472  * @post media_info_update_to_db()
1473  */
1474 int media_info_set_age_rating(media_info_h media, const char *age_rating);
1475
1476 /**
1477  * @brief Sets the keyword of media info.
1478  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1479  *
1480  * @param[in] media   The media info handle
1481  * @param[in] keyword The keyword of the media info
1482  *
1483  * @return @c 0 on success,
1484  *         otherwise a negative error value
1485  *
1486  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1487  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
1488  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1489  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1490  *
1491  * @post media_info_update_to_db()
1492  */
1493 int media_info_set_keyword(media_info_h media, const char *keyword);
1494
1495 /**
1496  * @brief Updates the media info to the media database.
1497  *
1498  * @details The function updates the given media info in the media database.
1499  *
1500  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1501  * @privlevel public
1502  * @privilege %http://tizen.org/privilege/content.write
1503  *
1504  * @remarks The function should be called after any change in media, to be updated to the media
1505  *          database. For example, after using media_info_set_display_name()
1506  *          for setting the name of the media, the media_info_update_to_db() function should be called so as to update
1507  *          the given media info attributes in the media database.
1508  *
1509  * @param[in] media The media info handle
1510  *
1511  * @return @c 0 on success,
1512  *         otherwise a negative error value
1513  *
1514  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1515  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1516  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
1517  * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
1518  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
1519  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
1520  * @retval #MEDIA_CONTENT_ERROR_NETWORK           Network fail
1521  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1522  *
1523  * @pre This function requires opened connection to content service by media_content_connect().
1524  *
1525  * @see media_content_connect()
1526  * @see media_info_set_display_name()
1527  * @see media_info_set_description()
1528  * @see media_info_set_longitude()
1529  * @see media_info_set_latitude()
1530  * @see media_info_set_altitude()
1531  * @see media_info_set_rating()
1532  * @see media_info_set_favorite()
1533  * @see media_info_set_author()
1534  * @see media_info_set_provider()
1535  * @see media_info_set_content_name()
1536  * @see media_info_set_category()
1537  * @see media_info_set_location_tag()
1538  * @see media_info_set_age_rating()
1539  */
1540 int media_info_update_to_db(media_info_h media);
1541
1542 /**
1543  * @brief Refreshes the media metadata to the media database.
1544  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1545  *
1546  * @privlevel public
1547  * @privilege %http://tizen.org/privilege/content.write \n
1548  *                   %http://tizen.org/privilege/mediastorage \n
1549  *                   %http://tizen.org/privilege/externalstorage
1550  *
1551  * @remarks You must add privilege http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path. \n
1552  *                   If you want to access only internal storage by using  this API, you should add privilege http://tizen.org/privilege/mediastorage. \n
1553  *                   Or if you want to access only external storage by using  this API, you should add privilege http://tizen.org/privilege/externalstorage. \n
1554  *                   If you can access both storage, you should add all privilege.
1555  *
1556  * @param[in] media_id The ID of the media info
1557  *
1558  * @return @c 0 on success,
1559  *         otherwise a negative error value
1560  *
1561  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1562  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1563  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
1564  * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
1565  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
1566  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
1567  * @retval #MEDIA_CONTENT_ERROR_NETWORK           Network fail
1568  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1569  *
1570  * @pre This function requires opened connection to content service by media_content_connect().
1571  *
1572  * @see media_content_connect()
1573  */
1574 int media_info_refresh_metadata_to_db(const char *media_id);
1575
1576 /**
1577  * @brief Sets the added time of media info.
1578  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1579  *
1580  * @param[in] media      The media info handle
1581  * @param[in] added_time The added time of the media info
1582  *
1583  * @return @c 0 on success,
1584  *         otherwise a negative error value
1585  *
1586  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1587  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
1588  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1589  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1590  *
1591  * @post media_info_update_to_db()
1592  */
1593 int media_info_set_added_time(media_info_h media, time_t added_time);
1594
1595 /**
1596  * @brief Moves the media info to the given destination path in the media database.
1597  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1598  *
1599  * @privlevel public
1600  * @privilege %http://tizen.org/privilege/content.write \n
1601  *                   %http://tizen.org/privilege/mediastorage \n
1602  *                   %http://tizen.org/privilege/externalstorage
1603  *
1604  * @remarks You must add privilege http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path. \n
1605  *                   If you want to access only internal storage by using  this API, you should add privilege http://tizen.org/privilege/mediastorage. \n
1606  *                   Or if you want to access only external storage by using this API, you should add privilege http://tizen.org/privilege/externalstorage. \n
1607  *                   If you can access both storage, you should add all privilege.
1608  *
1609  * @param[in] media    The media info handle
1610  * @param[in] dst_path The path of destination
1611  *
1612  * @return @c 0 on success,
1613  *         otherwise a negative error value
1614  *
1615  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1616  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter (Especially, if the request is duplicated, this error returns.)
1617  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
1618  * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
1619  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
1620  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
1621  * @retval #MEDIA_CONTENT_ERROR_NETWORK           Network fail
1622  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1623  *
1624  * @pre This function requires opened connection to content service by media_content_connect().
1625  *
1626  * @see media_content_connect()
1627  */
1628 int media_info_move_to_db(media_info_h media, const char* dst_path);
1629
1630 /**
1631  * @brief Creates a thumbnail file for the given media, asynchronously.
1632  * @details This function creates an thumbnail file for given media item and calls registered callback function for completion of creating the thumbnail.
1633  *          If a thumbnail already exists for the given media, then the path of thumbnail will be returned in callback function. \n
1634  *          Since 3.0, a thumbnail is not automatically extracted during media scanning. \n
1635  *          Therefore, if there exists no thumbnail for the given media, you MUST call this function to create a thumbnail.
1636  *
1637  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1638  *
1639  * @privlevel public
1640  * @privilege %http://tizen.org/privilege/content.write
1641  *
1642  * @remarks If you want to destroy media handle before callback invoked, you must cancel thumbnail request by using media_info_cancel_thumbnail() \n
1643  *          Since 3.0, if creation of a thumbnail is failed, empty string will be passed through media_thumbnail_completed_cb().
1644  *          Items in external storage except MMC not supported.
1645  *
1646  * @param[in] media     The media info handle
1647  * @param[in] callback  The callback function to be invoked
1648  * @param[in] user_data The user data to be passed to the callback function
1649  *
1650  * @return @c 0 on success,
1651  *         otherwise a negative error value
1652  *
1653  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1654  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1655  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
1656  * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
1657  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
1658  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
1659  * @retval #MEDIA_CONTENT_ERROR_NETWORK           Network fail
1660  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1661  *
1662  * @pre This function requires opened connection to content service by media_content_connect().
1663  *
1664  * @see media_content_connect()
1665  */
1666 int media_info_create_thumbnail(media_info_h media, media_thumbnail_completed_cb callback, void *user_data);
1667
1668 /**
1669  * @brief Cancels the creation of thumbnail file for the given media.
1670  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
1671  *
1672  * @privlevel public
1673  * @privilege %http://tizen.org/privilege/content.write
1674  *
1675  * @remarks If you request cancel for the already thumbnail created media, this API return MEDIA_CONTENT_ERROR_INVALID_OPERATION
1676  *
1677  * @param[in] media The media info handle
1678  *
1679  * @return @c 0 on success,
1680  *         otherwise a negative error value
1681  *
1682  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1683  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1684  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1685  * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
1686  *
1687  * @pre This function requires opened connection to content service by media_content_connect().
1688  * @see media_content_connect()
1689  */
1690 int media_info_cancel_thumbnail(media_info_h media);
1691
1692 /**
1693  * @ingroup CAPI_CONTENT_MEDIA_FACE_DETECTION_MODULE
1694  * @brief Starts face detection for the given image, asynchronously.
1695  * @details This function detects faces for given image item and calls the given callback function when the detection is completed. \n
1696  *          The given callback function is called when the detection is completed. \n
1697  *          To obtain the detected faces, call the media_info_foreach_face_from_db() function.
1698  *
1699  * @since_tizen 3.0
1700  *
1701  * @privlevel public
1702  * @privilege %http://tizen.org/privilege/content.write \n
1703  *                   %http://tizen.org/privilege/mediastorage
1704  *
1705  * @remarks If you want to destroy the media handle before callback invoked, you must cancel the face detection request by using media_info_cancel_face_detection(). \n
1706  *          If face detection fails, the @a face_count argument in media_face_detection_completed_cb() will be set to 0.
1707  *          Media items in external storage are not supported, with the exception of MMC items.
1708  *
1709  * @param[in] media     The media info handle
1710  * @param[in] callback  The callback function to be invoked when detection is completed
1711  * @param[in] user_data The user data to be passed to the callback function
1712  *
1713  * @return @c 0 on success,
1714  *         otherwise a negative error value
1715  *
1716  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1717  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1718  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
1719  * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
1720  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
1721  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
1722  * @retval #MEDIA_CONTENT_ERROR_NETWORK           Network fail
1723  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1724  * @retval #MEDIA_CONTENT_ERROR_NOT_SUPPORTED     Not supported
1725  *
1726  * @pre This function requires opened connection to content service by media_content_connect().
1727  *
1728  * @see media_content_connect()
1729  * @see media_info_cancel_face_detection()
1730  */
1731 int media_info_start_face_detection(media_info_h media, media_face_detection_completed_cb callback, void *user_data);
1732
1733 /**
1734  * @ingroup CAPI_CONTENT_MEDIA_FACE_DETECTION_MODULE
1735  * @brief Cancels face detection of image for the given media.
1736  * @details This function cancels face detection for given media item. \n
1737  *          If you cancel face detection request before callback is invoked, the callback registered by media_info_start_face_detection() API will not be invoked.
1738  *
1739  * @since_tizen 3.0
1740  *
1741  * @privlevel public
1742  * @privilege %http://tizen.org/privilege/content.write
1743  *
1744  * @remarks If face detection is already done when you request the cancellation, this API return MEDIA_CONTENT_ERROR_INVALID_OPERATION
1745  *
1746  * @param[in] media The media info handle
1747  *
1748  * @return @c 0 on success,
1749  *         otherwise a negative error value
1750  *
1751  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
1752  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1753  * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1754  * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
1755  *
1756  * @pre This function requires opened connection to content service by media_content_connect().
1757  *
1758  * @see media_content_connect()
1759  * @see media_info_start_face_detection()
1760  */
1761 int media_info_cancel_face_detection(media_info_h media);
1762
1763 /**
1764 * @deprecated Deprecated since 4.0. Use media_info_insert_to_db() instead.
1765 * @brief Creates the media info handle.
1766 * @details If the information about the file that is already known, you can use this API to generate empty handler.
1767 *          And you can add the information to the generated handler using media_info_set_XXX() API.
1768 *          After filling the information to the handler, you can insert into database using media_info_insert_to_db_with_data() API.
1769 * @since_tizen 3.0
1770 *
1771 *
1772 * @privilege %http://tizen.org/privilege/mediastorage \n
1773 *                       %http://tizen.org/privilege/externalstorage
1774 *
1775 * @remarks If you want to access only internal storage with this API, you should add privilege http://tizen.org/privilege/mediastorage. \n
1776 *                   Or if you want to access only external storage with this API, you should add privilege http://tizen.org/privilege/externalstorage. \n
1777 *                   If you can access both storage, you must add all privilege.
1778 *
1779 * @param[in] path The path to create the media info handle
1780 * @param[out] media The media info handle
1781 *
1782 * @return @c 0 on success,
1783 *           otherwise a negative error value
1784 *
1785 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
1786 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1787 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED                 DB operation failed
1788 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1789 *
1790 * @see media_info_insert_to_db_with_data()
1791 * @see media_info_destroy()
1792 */
1793 int media_info_create(const char *path, media_info_h *media) TIZEN_DEPRECATED_API;
1794
1795 /**
1796 * @deprecated Deprecated since 4.0. Use media_info_insert_to_db() instead.
1797 * @brief Inserts media info to database with media info data.
1798 * @details After filling the information to the generated handler using media_info_create() API, you can insert into database using this API.
1799 * @since_tizen 3.0
1800 *
1801 * @remarks You must create media handle using media_info_create(),
1802 *               and release @a info using media_info_destroy().
1803 *
1804 * @privlevel public
1805 * @privilege %http://tizen.org/privilege/content.write
1806 *
1807 * @param[in] media The media info handle to be inserted
1808 *
1809 * @return @c 0 on success,
1810 *           otherwise a negative error value
1811 *
1812 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
1813 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1814 * @retval #MEDIA_CONTENT_ERROR_DB_FAILED                 DB operation failed
1815 * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
1816 *
1817 * @see media_info_create()
1818 */
1819 int media_info_insert_to_db_with_data(media_info_h media) TIZEN_DEPRECATED_API;
1820
1821 /**
1822 * @deprecated Deprecated since 4.0.
1823 * @brief Sets the title of media info handle.
1824 * @since_tizen 3.0
1825 *
1826 * @param[in] media The media info handle
1827 * @param[in] title The title of media info handle
1828 *
1829 * @return @c 0 on success,
1830 *           otherwise a negative error value
1831 *
1832 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
1833 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1834 *
1835 * @post media_info_insert_to_db_with_data()
1836 */
1837 int media_info_set_title(media_info_h media, const char *title) TIZEN_DEPRECATED_API;
1838
1839 /**
1840 * @deprecated Deprecated since 4.0.
1841 * @brief Sets the album of media info handle.
1842 * @since_tizen 3.0
1843 *
1844 * @param[in] media The media info handle
1845 * @param[in] album The album of media info handle
1846 *
1847 * @return @c 0 on success,
1848 *           otherwise a negative error value
1849 *
1850 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
1851 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1852 *
1853 * @post media_info_insert_to_db_with_data()
1854 */
1855 int media_info_set_album(media_info_h media, const char *album) TIZEN_DEPRECATED_API;
1856
1857 /**
1858 * @deprecated Deprecated since 4.0.
1859 * @brief Sets the artist of media info handle.
1860 * @since_tizen 3.0
1861 *
1862 * @param[in] media The media info handle
1863 * @param[in] artist The artist of media info handle
1864 *
1865 * @return @c 0 on success,
1866 *           otherwise a negative error value
1867 *
1868 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
1869 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1870 *
1871 * @post media_info_insert_to_db_with_data()
1872 */
1873 int media_info_set_artist(media_info_h media, const char *artist) TIZEN_DEPRECATED_API;
1874
1875 /**
1876 * @deprecated Deprecated since 4.0.
1877 * @brief Sets the genre of media info handle.
1878 * @since_tizen 3.0
1879 *
1880 * @param[in] media The media info handle
1881 * @param[in] genre The genre of media info handle
1882 *
1883 * @return @c 0 on success,
1884 *           otherwise a negative error value
1885 *
1886 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
1887 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1888 *
1889 * @post media_info_insert_to_db_with_data()
1890 */
1891 int media_info_set_genre(media_info_h media, const char *genre) TIZEN_DEPRECATED_API;
1892
1893 /**
1894 * @deprecated Deprecated since 4.0.
1895 * @brief Sets the recorded date of media info handle.
1896 * @since_tizen 3.0
1897 *
1898 * @param[in] media The media info handle
1899 * @param[in] recorded_date The recorded date of media info handle
1900 *
1901 * @return @c 0 on success,
1902 *           otherwise a negative error value
1903 *
1904 * @retval #MEDIA_CONTENT_ERROR_NONE Successful
1905 * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
1906 *
1907 * @post media_info_insert_to_db_with_data()
1908 */
1909 int media_info_set_recorded_date(media_info_h media, const char *recorded_date) TIZEN_DEPRECATED_API;
1910
1911
1912 /**
1913  * @}
1914  */
1915
1916
1917 #ifdef __cplusplus
1918 }
1919 #endif /* __cplusplus */
1920
1921 #endif /* __TIZEN_MEDIA_INFORMATION_H__ */