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