*/
-#ifndef __TIZEN_MEDIA_INFORMATION_H__
-#define __TIZEN_MEDIA_INFORMATION_H__
+#ifndef __TIZEN_CONTENT_MEDIA_INFO_H__
+#define __TIZEN_CONTENT_MEDIA_INFO_H__
#include <media_content_type.h>
extern "C" {
#endif /* __cplusplus */
+/**
+ * @file media_info.h
+ * @brief This file contains the media info function and related functions to proceed with it. \n
+ * You can use the functions to insert, delete, count and get list of content files from media database. \n
+ * You can get properties of content file such as size, mime_type, modified_time etc. And you can set properties such as favorite etc. \n
+ * And you can get bookmark, face, tag info related the content file.
+ */
+
/**
* @addtogroup CAPI_CONTENT_MEDIA_INFO_MODULE
*/
/**
- * @brief Inserts media file into the media database.
- * @details This function inserts an media item into the content storage.
- * Normally, inserting a media file in database is done automatically by media server, without calling this function.
- * This function is only called when media server is busy and user needs to get quick result of inserting
- * e.g. Taking a photo while media server is busy and user want to see the quick snapshot of the photo taken.
- * @remark The handle must be released with media_info_destroy() by you.
+ * @brief Inserts the content file into the media database.
+ * @details In general, you can use this function to insert content files into the media database. \n
+ * You can use media_content_scan_file()/media_content_scan_folder() function instead of this function. \n
+ * If media information exists in the media database, this function returns information stored in the database.\n
+ * Since 5.5, if media information already exists in the media database,
+ * this function returns the updated latest information. (Media database will be updated if necessary).
*
- * @param[in] path The path to the media file
- * @param[out] info The handle to the media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @pre This function requires opened connection to content service by media_content_connect().
- * @see media_content_connect()
- */
-int media_info_insert_to_db (const char *path, media_info_h *info);
-
-/**
- * @brief Insert media files into the media database, asynchronously.
- * @details This function insert an media items into the content storage.
- * Normally, inserting a media file in database is done automatically by media server, without calling this function.
- * This function invokes media_insert_completed_cb callback function.
- * #media_insert_completed_cb will be called when insertion to media database is finished.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] path_array The path array to the media files
- * @param[in] array_length The length of array
- * @param[in] callback The callback to invoke when media items inserted completely
- * @param[in] user_data The user data to be passed to the callback function
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/content.write \n
+ * %http://tizen.org/privilege/mediastorage \n
+ * %http://tizen.org/privilege/externalstorage
+ *
+ * @remarks The @a info should be released using media_info_destroy(). \n
+ * You must add the privilege %http://tizen.org/privilege/content.write. You need to add more privileges depending on your choice of contents path. \n
+ * If you want to access only internal storage by using this function, you should add privilege %http://tizen.org/privilege/mediastorage. \n
+ * If you want to access only external storage by using this function, you should add privilege %http://tizen.org/privilege/externalstorage. \n
+ * If you want to access storages of both types, you must add all privileges. \n
+ * Since 4.0, this function does not accept symbolic links. \n
+ * @remarks Since 4.0, this function is related to the following feature:\n
+ * %http://tizen.org/feature/content.scanning.others\n
+ * If this feature is not supported on the device, #MEDIA_CONTENT_TYPE_OTHERS type files are not scanned.
+ *
+ * @param[in] path The path of the content file to add
+ * @param[out] info The handle of the inserted content file
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ *
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB operation failed
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
+ * @retval #MEDIA_CONTENT_ERROR_NETWORK Network fail
+ * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #MEDIA_CONTENT_ERROR_NOT_SUPPORTED Not supported
+ *
* @pre This function requires opened connection to content service by media_content_connect().
+ *
* @see media_content_connect()
- * @see media_insert_completed_cb()
+ * @see media_content_scan_file()
+ * @see media_content_scan_folder()
*/
-int media_info_insert_batch_to_db(const char **path_array,unsigned int array_length, media_insert_completed_cb callback, void *user_data);
+int media_info_insert_to_db(const char *path, media_info_h *info);
/**
- * @brief Insert the burst shot images into the media database, asynchronously.
- * @details This function insert the busrt images into the content storage.
- * #media_insert_burst_shot_completed_cb will be called when insertion to media database is finished.
+ * @brief Inserts content files into the media database, asynchronously.
+ * @details This function can insert multiple content files into the media database.
+ *
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ *
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/content.write \n
+ * %http://tizen.org/privilege/mediastorage \n
+ * %http://tizen.org/privilege/externalstorage
+ *
+ * @remarks You must add privilege %http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path. \n
+ * If you want to access only internal storage by using this function, you should add privilege %http://tizen.org/privilege/mediastorage. \n
+ * Or if you want to access only external storage by using this function, you should add privilege %http://tizen.org/privilege/externalstorage. \n
+ * If you can access both storage, you must add all privilege. \n
+ * Since 4.0, This function does not allow a symbolic link. \n
+ * @remarks Since 4.0, this function is related to the following feature:\n
+ * %http://tizen.org/feature/content.scanning.others\n
+ * If this feature is not supported on the device, MEDIA_CONTENT_TYPE_OTHERS type file is not scanned.
*
- * @param[in] path_array The path array to the burst shot images
- * @param[in] array_length The length of array
- * @param[in] callback The callback to invoke when the images inserted completely
+ * @param[in] path_array The path array of the content files to add
+ * @param[in] array_length The length of the array
+ * @param[in] callback The callback function to be invoked when media items inserted completely
* @param[in] user_data The user data to be passed to the callback function
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ *
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB operation failed
- * @pre This function requires opened connection to content service by media_content_connect().
- * @see media_content_connect()
- * @see media_insert_burst_shot_completed_cb()
- */
-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);
-
-/**
- * @brief Deletes media file from the media database.
- * @details This function deletes an media item from the content storage.
- * Normally, deleting a media file in database is done automatically by media server, without calling this function.
- * This function is only called when media server is busy and user needs to get quick result of deleting
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
+ * @retval #MEDIA_CONTENT_ERROR_NETWORK Network fail
+ * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #MEDIA_CONTENT_ERROR_NOT_SUPPORTED Not supported
*
- * @param[in] media_id The ID to the media file
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @pre This function requires opened connection to content service by media_content_connect().
- * @see media_content_connect()
- */
-int media_info_delete_from_db(const char *media_id);
-
-/**
- * @brief Deletes media files from the media database. The media files to delete can be specified as a condition in a filter.
- * @details This function deletes the media items from the content storage.
- * Normally, deleting media files in database are done automatically by media server, without calling this function.
- * This function is only called when media server is busy and user needs to get quick result of deleting
*
- * @param[in] filter The handle to filter
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @pre This function requires opened connection to content service by media_content_connect().
* @see media_content_connect()
+ * @see media_insert_completed_cb()
*/
-int media_info_delete_batch_from_db(filter_h filter);
-
+int media_info_insert_batch_to_db(const char **path_array, unsigned int array_length, media_insert_completed_cb callback, void *user_data);
/**
- * @brief Destroys the media info.
+ * @brief Destroys media info.
* @details The function frees all resources related to the media info handle. This handle
- * no longer can be used to perform any operation. New media info handle has to
- * be created before next usage.
+ * can no longer be used to perform any operations. New media info handle has to
+ * be created before the next usage.
*
- * @param[in] media The handle to media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ *
+ * @param[in] media The handle to the media info
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ *
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @pre Get copy of media_info handle by calling media_info_clone()
+ *
+ * @pre Get copy of media_info handle by calling media_info_clone().
+ *
* @see media_info_clone()
*/
int media_info_destroy(media_info_h media);
/**
* @brief Clones the media info handle.
*
- * @details This function copies the media info handle from a source to destination.
- * There is no media_info_create() function. The media_info_h is created internally and
- * available through media info foreach function such as media_info_foreach_media_from_db().
- * To use this handle outside of these foreach functions, use this function.
- * @remark The destination handle must be released with media_info_destroy() by you.
+ * @details This function copies the media info handle from a source to the destination.
+ * To use this handle outside of these foreach functions, use this function.
*
- * @param[out] dst A destination handle to media info
- * @param[in] src The source handle to media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ *
+ * @remarks The @a dst should be released using media_info_destroy().
+ *
+ * @param[out] dst The destination handle to the media info
+ * @param[in] src The source handle to the media info
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ *
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
+ *
* @see media_info_destroy()
* @see media_album_foreach_media_from_db()
* @see media_playlist_foreach_media_from_db()
- * @see media_group_foreach_media_from_db
+ * @see media_group_foreach_media_from_db()
* @see media_tag_foreach_media_from_db()
* @see media_info_foreach_media_from_db()
+ * @see media_info_insert_to_db()
* @see media_folder_foreach_media_from_db()
- *
*/
int media_info_clone(media_info_h *dst, media_info_h src);
/**
- * @brief Gets the number of media info for the passed @a filter from the media database.
+ * @brief Gets the count of media info for the passed @a filter from the media database.
+ * @details If @c NULL is passed to the @a filter, then no filtering is applied.
*
- * @param[in] filter The handle to filter.
- * @param[out] media_count The count of media tag
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ *
+ *
+ * @param[in] filter The handle to the media filter
+ * @param[out] media_count The count of media
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ *
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
+ *
* @pre This function requires opened connection to content service by media_content_connect().
- * @see media_content_connect()
*
+ * @see media_content_connect()
+ * @see media_filter_create()
*/
int media_info_get_media_count_from_db(filter_h filter, int *media_count);
/**
* @brief Iterates through media info from the media database.
- * @details This function gets all media info handles meeting the given @a filter. The @a callback function will be invoked for every retrieved media info.
- * If NULL is passed to the @a filter, no filtering is applied.
- * @param[in] filter The handle to media info filter
- * @param[in] callback The callback function to invoke
+ * @details This function gets all media info handles meeting the given @a filter.
+ * The @a callback function will be invoked for every retrieved media info.
+ * If @c NULL is passed to the @a filter, then no filtering is applied.
+ *
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ *
+ * @remarks Do not call updating DB function like media_info_update_to_db() in your callback function,
+ * your callback function is invoked as inline function.
+ * So, your callback function is in read state in SQLite. When you are in read state, sometimes you do not update DB.
+ * We do not recommend you call updating DB function in callback of foreach function.
+ *
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ *
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
- * @pre This function requires opened connection to content service by media_content_connect().
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
+ *
+ * @pre This function requires opened connection to content service by media_content_connect().
* @post This function invokes media_info_cb().
+ *
* @see media_content_connect()
* @see #media_info_cb
- * @see media_info_filter_create()
- *
+ * @see media_filter_create()
*/
int media_info_foreach_media_from_db(filter_h filter, media_info_cb callback, void *user_data);
/**
- * @brief Gets the number of media tag for the passed @a filter in the given @a media ID from the media database.
+ * @brief Gets the count of media tags for the passed @a filter in the given @a media_id from the media database.
+ * @details If @c NULL is passed to the @a filter, then no filtering is applied.
*
- * @param[in] media_id The ID of media info
- * @param[in] filter The handle to media filter
- * @param[out] tag_count The count of media tag
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ *
+ * @param[in] media_id The media ID
+ * @param[in] filter The handle to the media filter
+ * @param[out] tag_count The count of the media tag
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ *
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
+ *
* @pre This function requires opened connection to content service by media_content_connect().
- * @see media_content_connect()
*
+ * @see media_content_connect()
+ * @see media_filter_create()
*/
int media_info_get_tag_count_from_db(const char *media_id, filter_h filter, int *tag_count);
/**
- * @brief Iterates through the media tag in the given @a media @a info from the media database.
- * @details This function gets all media tag associated with the given @a media and calls registered callback function for every retrieved media tag.
- * @param[in] media_id The ID of media info
- * @param[in] filter The handle to media filter
- * @param[in] callback The callback function to invoke
+ * @brief Iterates through the media tag in the given media info from the media database.
+ * @details This function gets all the media tags associated with the given @a media_id and calls @a callback for every retrieved media tag. \n
+ * If @c NULL is passed to the @a filter, then no filtering is applied.
+ *
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ *
+ * @param[in] media_id The media ID
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ *
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @pre This function requires opened connection to content service by media_content_connect().
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
+ *
+ * @pre This function requires opened connection to content service by media_content_connect().
* @post This function invokes media_tag_cb().
+ *
* @see media_content_connect()
* @see #media_tag_cb
+ * @see media_filter_create()
*/
int media_info_foreach_tag_from_db(const char *media_id, filter_h filter, media_tag_cb callback, void *user_data);
/**
- * @brief Gets the number of bookmark for the passed @a filter in the given @a media ID from the media database.
+ * @brief Gets the number of bookmarks for the passed @a filter in the given media ID from the media database.
+ * @details If @c NULL is passed to the @a filter, then no filtering is applied.
+ *
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ *
+ * @param[in] media_id The media ID
+ * @param[in] filter The handle to the media filter
+ * @param[out] bookmark_count The count of the media tag
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ *
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
+ *
+ * @pre This function requires opened connection to content service by media_content_connect().
+ *
+ * @see media_content_connect()
+ * @see media_filter_create()
+ */
+int media_info_get_bookmark_count_from_db(const char *media_id, filter_h filter, int *bookmark_count);
+
+/**
+ * @brief Iterates through the media bookmark in the given media info from the media database.
+ * @details This function gets all media bookmarks associated with the given media and calls @a callback for every retrieved media bookmark.
+ * If @c NULL is passed to the @a filter, then no filtering is applied.
+ *
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ *
+ * @param[in] media_id The media ID
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
+ * @param[in] user_data The user data to be passed to the callback function
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ *
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
+ *
+ * @pre This function requires opened connection to content service by media_content_connect().
+ * @post This function invokes media_bookmark_cb().
+ *
+ * @see media_content_connect()
+ * @see media_bookmark_cb()
+ * @see media_filter_create()
+ */
+int media_info_foreach_bookmark_from_db(const char *media_id, filter_h filter, media_bookmark_cb callback, void *user_data);
+
+/**
+ * @deprecated Deprecated since 8.0.
+ * @brief Gets the number of face for the passed @a media_id from the media database.
+ * @details If @c NULL is passed to the @a filter, then no filtering is applied.
+ *
+ * @since_tizen 3.0
+ *
+ * @param[in] media_id The media ID
+ * @param[in] filter The handle to the media filter
+ * @param[out] face_count The count of media face
*
- * @param[in] media_id The ID of media info
- * @param[in] filter The handle to media filter
- * @param[out] bookmark_count The count of media tag
* @return 0 on success, otherwise a negative error value.
+ *
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB operation failed
+ *
* @pre This function requires opened connection to content service by media_content_connect().
* @see media_content_connect()
+ * @see media_filter_create()
*
*/
-int media_info_get_bookmark_count_from_db(const char *media_id, filter_h filter, int *bookmark_count);
+int media_info_get_face_count_from_db(const char *media_id, filter_h filter, int *face_count) TIZEN_DEPRECATED_API;
/**
- * @brief Iterates through the media bookmark in the given @a media @a info from the media database.
- * @details This function gets all media bookmark associated with the given @a media and calls registered callback function for every retrieved media bookmark.
- * @param[in] media_id The ID of media info
- * @param[in] filter The handle to media filter
+ * @deprecated Deprecated since 8.0.
+ * @brief Iterates through the media files with optional @a filter in the given @a media_id from the media database.
+ * @details This function gets all media face info associated with the given media id and
+ * meeting desired filter option and calls @a callback for
+ * every retrieved media face info. If NULL is passed to the @a filter, no filtering is applied.
+ *
+ * @since_tizen 3.0
+ *
+ * @param[in] media_id The media ID
+ * @param[in] filter The handle to the media filter
* @param[in] callback The callback function to invoke
* @param[in] user_data The user data to be passed to the callback function
+ *
* @return 0 on success, otherwise a negative error value.
+ *
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
+ *
* @pre This function requires opened connection to content service by media_content_connect().
- * @post This function invokes media_bookmark_cb().
* @see media_content_connect()
- * @see #media_bookmark_cb
+ * @see media_filter_create()
+ *
*/
-int media_info_foreach_bookmark_from_db (const char *media_id, filter_h filter, media_bookmark_cb callback, void *user_data);
+int media_info_foreach_face_from_db(const char *media_id, filter_h filter, media_face_cb callback, void *user_data) TIZEN_DEPRECATED_API;
/**
- * @brief Gets image metadata for a given media info.
+ * @brief Gets the image metadata handle for a given media info.
* @details This function returns an image metadata handle retrieved from the media info.
*
- * @remark The @a image handle must be released with image_meta_destroy() by you.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param [in] media The handle to media info
- * @param[out] image A handle to image meta
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @remarks The @a image should be released using image_meta_destroy().
+ *
+ * @param[in] media The handle to the media info
+ * @param[out] image The handle to the image metadata
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ *
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ *
* @see image_meta_destroy()
*/
int media_info_get_image(media_info_h media, image_meta_h *image);
/**
- * @brief Gets video metadata for a given media info.
+ * @brief Gets a video metadata handle for a given media info.
* @details This function returns a video metadata handle retrieved from the media info handle.
*
- * @remark The @a video handle must be released with video_meta_destroy() by you.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param [in] media The handle to media info
- * @param[out] video A handle to the video meta
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @remarks The @a video should be released using video_meta_destroy().
+ *
+ * @param[in] media The handle to the media info
+ * @param[out] video The handle to the video metadata
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ *
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
- * @see video_meta_destroy()
*
+ * @see video_meta_destroy()
*/
int media_info_get_video(media_info_h media, video_meta_h *video);
/**
- * @brief Gets audio metadata for a given media info.
+ * @brief Gets an audio metadata handle for a given media info.
* @details This function returns an audio metadata handle retrieved from the media info handle.
*
- * @remark The @a audio handle must be released with audio_meta_destroy() by you.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param [in] media The handle to media info
- * @param[out] audio A handle to the audio meta
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @remarks The @a audio should be released using audio_meta_destroy().
+ *
+ * @param[in] media The handle to the media info
+ * @param[out] audio The handle to the audio metadata
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ *
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
+ *
* @see audio_meta_destroy()
*/
int media_info_get_audio(media_info_h media, audio_meta_h *audio);
/**
- * @brief Gets ID to media info.
+ * @brief Gets a book metadata handle for a given media info.
+ * @details This function returns a book metadata handle retrieved from the media info handle. \n
+ * The title and description information of the book can be obtained from @a media.
*
+ * @since_tizen 6.5
*
- * @param [in] media_id The ID if media info
- * @param [out] media_id The ID of media tag
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @remarks The @a book should be released using book_meta_destroy().
+ *
+ * @param[in] media The handle to the media info
+ * @param[out] book The handle to the book metadata
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ *
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ *
+ * @see media_info_get_title()
+ * @see media_info_get_description()
+ * @see book_meta_destroy()
+ */
+int media_info_get_book(media_info_h media, book_meta_h *book);
+
+/**
+ * @brief Gets the media ID.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @remarks The @a media_id should be released using free().
+ *
+ * @param[in] media The handle to the media info
+ * @param[out] media_id The media ID
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ *
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*/
int media_info_get_media_id(media_info_h media, char **media_id);
/**
- * @brief Gets path to media info.
+ * @brief Gets the full path of the content file.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks @a path must be released with free() by you.
+ * @remarks The @a path should be released using free().
*
- * @param[in] media The handle to media info
- * @param[out] path The path of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @param[in] media The handle to the media info
+ * @param[out] path The full path of the content file
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ *
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
*
*/
int media_info_get_file_path(media_info_h media, char **path);
/**
- * @brief Gets name to media info.
+ * @brief Gets the file name including the extension of the content file.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks @a name must be released with free() by you.
+ * @remarks The @a name should be released using free().
*
- * @param[in] media The handle to media info
- * @param[out] name The name of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @param[in] media The handle to the media info
+ * @param[out] name The file name including the extension of the content file
*
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ *
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*/
int media_info_get_display_name(media_info_h media, char **name);
/**
- * @brief Gets media info's content type.
+ * @brief Gets the content type of the content file.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The handle to media info
- * @param[out] type The type of media content(#media_content_type_e)
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @param[in] media The handle to the media info
+ * @param[out] type The content type of the content file (#media_content_type_e)
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ *
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*
+ * @see #media_content_type_e
*/
int media_info_get_media_type(media_info_h media, media_content_type_e *type);
/**
- * @brief Gets name to media info.
+ * @brief Gets the MIME type of the content file.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks @a mime_type must be released with free() by you.
+ * @remarks The @a mime_type should be released using free().
*
- * @param[in] media The handle to media info
- * @param[out] mime_type The mime type of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @param[in] media The handle to the media info
+ * @param[out] mime_type The MIME type of the content file
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*/
int media_info_get_mime_type(media_info_h media, char **mime_type);
/**
- * @brief Gets media file's size.
+ * @brief Gets the content file size.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The handle to media info
- * @param[out] size The type of media content
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @param[in] media The handle to the media info
+ * @param[out] size The content file size
*
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ *
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*/
int media_info_get_size(media_info_h media, unsigned long long *size);
/**
- * @brief Gets added time.
+ * @brief Gets the added time of the content file.
+ * @details The added time refers to the time that content file was first added to media database.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The handle to media info
- * @param[out] added_time The added time to DB
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @param[in] media The handle to the media info
+ * @param[out] added_time The added time to the media database
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*/
int media_info_get_added_time(media_info_h media, time_t *added_time);
/**
- * @brief Gets media info's date of modification.
+ * @brief Gets the modified time of the content file.
+ * @details The modified time refers to the last modification time provided by the file system.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The handle to media info
- * @param[out] time The date of modification of File. Get from File
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @param[in] media The handle to the media info
+ * @param[out] time The last modification time of the content file
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*/
int media_info_get_modified_time(media_info_h media, time_t *time);
/**
- * @brief Gets the thumbnail to media info.
+ * @brief Gets the timeline of content file.
+ * @details If the content file has the creation time information (like Content recorded date or Image creation date), that value is timeline. \n
+ * Otherwise, timeline value is the same as modified time.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks @a path must be released with free() by you.
+ * @param[in] media The handle to the media info
+ * @param[out] time The timeline of content file
*
- * @param[in] media The handle to media info
- * @param[out] path The path to thumbnail of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*/
-int media_info_get_thumbnail_path(media_info_h media, char **path);
+int media_info_get_timeline(media_info_h media, time_t *time);
/**
- * @brief Gets the description to media info.
+ * @brief Gets the thumbnail path of content file.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks @a description must be released with free() by you.
+ * @remarks The @a path should be released using free(). \n
+ * If the thumbnail extraction for the given media has not been requested yet, this function returns NULL. \n
+ * To create a thumbnail, you should use media_info_generate_thumbnail() function. \n
+ * This function returns an empty string if media_info_generate_thumbnail() has failed to create a thumbnail for the given media.
*
- * @param[in] media The handle to media info
- * @param[out] description The description of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @param[in] media The handle to the media info
+ * @param[out] path The thumbnail path
*
- */
-int media_info_get_description(media_info_h media, char **description);
-
-/**
- * @brief Gets media info's longitude.
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- * @param[in] media The handle to media info
- * @param[out] longitude The longitude of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- *
*/
-int media_info_get_longitude(media_info_h media, double* longitude);
+int media_info_get_thumbnail_path(media_info_h media, char **path);
/**
- * @brief Gets media info's latitude.
+ * @brief Gets the description of content file.
+ * @details If the value is an empty string, the method returns "Unknown". \n
+ * Since 3.0, if the media info has no description, the method returns empty string.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The handle to media info
- * @param[out] latitude The latitude of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @remarks The @a description should be released using free().
*
- */
-int media_info_get_latitude(media_info_h media, double* latitude);
-
-/**
- * @brief Gets media info's altitude of modification.
+ * @param[in] media The handle to the media info
+ * @param[out] description The description of the content file
*
- * @param[in] media The handle to media info
- * @param[out] altitude The altitude of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- *
- */
-int media_info_get_altitude(media_info_h media, double* altitude);
-
-/**
- * @brief Gets media info's rating.
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- * @param[in] media The handle to media info
- * @param[out] rating The rating of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- *
*/
-int media_info_get_rating(media_info_h media, int *rating);
+int media_info_get_description(media_info_h media, char **description);
/**
- * @brief Gets the given media info's favorite status.
- *
- * @param [in] media The handle to media info
- * @param [out] favorite The media favorite status(non zero if favorite, 0 if not favorite)
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @brief Gets the longitude of content file.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- */
-int media_info_get_favorite(media_info_h media, bool* favorite);
-
-/**
- * @brief Gets the author to media info.
+ * @param[in] media The handle to the media info
+ * @param[out] longitude The longitude of the content file
*
- * @remarks @a author must be released with free() by you.
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- * @param[in] media The handle to media info
- * @param[out] author The author of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- *
*/
-int media_info_get_author(media_info_h media, char **author);
+int media_info_get_longitude(media_info_h media, double *longitude);
/**
- * @brief Gets the provider to media info.
+ * @brief Gets the latitude of content file.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks @a provider must be released with free() by you.
+ * @param[in] media The handle to the media info
+ * @param[out] latitude The latitude of the content file
*
- * @param[in] media The handle to media info
- * @param[out] provider The provider of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ *
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*
*/
-int media_info_get_provider(media_info_h media, char **provider);
+int media_info_get_latitude(media_info_h media, double* latitude);
/**
- * @brief Gets the content name to media info.
+ * @brief Gets the altitude of content file.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks @a content_name must be released with free() by you.
+ * @param[in] media The handle to the media info
+ * @param[out] altitude The altitude of the content file
*
- * @param[in] media The handle to media info
- * @param[out] content_name The content name of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*/
-int media_info_get_content_name(media_info_h media, char **content_name);
+int media_info_get_altitude(media_info_h media, double* altitude);
/**
- * @brief Gets the title to media info.
+ * @brief Gets the rating of content file.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks @a title must be released with free() by you.
+ * @param[in] media The handle to the media info
+ * @param[out] rating The rating of the content file
*
- * @param[in] media The handle to media info
- * @param[out] title The title of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*/
-int media_info_get_title(media_info_h media, char **title);
+int media_info_get_rating(media_info_h media, int *rating);
/**
- * @brief Gets the provider to media info.
+ * @brief Gets the favorite status of content file which User set.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks @a category must be released with free() by you.
+ * @param[in] media The handle to the media info
+ * @param[out] favorite @c true if content file is set as favorite,
+ * otherwise @c false if content file is not set as favorite
*
- * @param[in] media The handle to media info
- * @param[out] category The category of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ *
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*
+ * @see media_info_set_favorite()
*/
-int media_info_get_category(media_info_h media, char **category);
+int media_info_get_favorite(media_info_h media, bool* favorite);
/**
- * @brief Gets the location_tag to media info.
+ * @brief Gets the title of content file.
+ * @details If the content file does not have a title, this method returns the filename without the extension.
*
- * @remarks @a location_tag must be released with free() by you.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The handle to media info
- * @param[out] location_tag The location of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @remarks The @a title should be released using free().
*
- */
-int media_info_get_location_tag(media_info_h media, char **location_tag);
-
-/**
- * @brief Gets the age_rating to media info.
+ * @param[in] media The handle to the media info
+ * @param[out] title The title of the content file
*
- * @remarks @a age_rating must be released with free() by you.
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- * @param[in] media The handle to media info
- * @param[out] age_rating The age rating of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- *
*/
-int media_info_get_age_rating(media_info_h media, char **age_rating);
+int media_info_get_title(media_info_h media, char **title);
/**
- * @brief Gets the keyword to media info.
- *
- * @remarks @a keyword must be released with free() by you.
+ * @brief Checks whether the media is protected via DRM.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The handle to media info
- * @param[out] keyword The keyword of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @param[in] media The handle to the media info
+ * @param[out] is_drm @c true if media is DRM media,
+ * otherwise @c false if media is not DRM media
*
- */
-int media_info_get_keyword(media_info_h media, char **keyword);
-
-/**
- * @brief Checks whether the media is protected via drm.
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- * @param[in] media The handle to media info
- * @param[out] is_drm /@a true if the drm media,
- * /@a false if not drm.
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- *
*/
int media_info_is_drm(media_info_h media, bool *is_drm);
/**
- * @brief Gets media info's storage_type.
+ * @brief Checks whether the content file is 360 content.
+ * @since_tizen 3.0
*
- * @param[in] media The handle to media info
- * @param[out] storage_type The storage type of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @param[in] media The handle to the media info
+ * @param[out] is_360 @c true if media is 360 content,
+ * otherwise @c false if media is not 360 content
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*/
-int media_info_get_storage_type(media_info_h media, media_content_storage_e *storage_type);
+int media_info_is_360_content(media_info_h media, bool *is_360);
/**
* @brief Gets the media info from the media database.
*
- * @details This function creates a new media handle from the media database by the given media_id.
- * media info will be created, which is filled with info information.
+ * @details This function creates a new media handle from the media database by the given @a media_id.
+ * Media info will be created and filled with information.
*
- * @remarks @a media must be released with media_tag_destroy() by you.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media_id The ID of media info
- * @param[out] media The media handle associated with the media ID
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @remarks The @a media should be released using media_info_destroy().
+ *
+ * @param[in] media_id The media ID
+ * @param[out] media The handle to the media info
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ *
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
+ *
* @pre This function requires opened connection to content service by media_content_connect().
+ *
* @see media_content_connect()
* @see media_info_destroy()
- *
*/
int media_info_get_media_from_db(const char *media_id, media_info_h *media);
/**
- * @brief Sets display name to media info.
+ * @brief Gets the media info from the media database using path.
*
- * @param[in] media The handle to media info
- * @param[in] display_name The display name of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @post media_info_update_to_db()
- *
- */
-int media_info_set_display_name(media_info_h media, const char *display_name);
-
-/**
- * @brief Sets description to media info.
+ * @details This function creates a new media handle filled with information from the database by the given @a media_path.
*
- * @param[in] media The handle to media info
- * @param[in] description The description of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @post media_info_update_to_db()
+ * @since_tizen 6.5
*
- */
-int media_info_set_description(media_info_h media, const char *description);
-
-/**
- * @brief Sets longitude to media info.
+ * @remarks The @a media should be released using media_info_destroy().\n
+ * If you want to access only internal storage by using this function, you should add privilege %http://tizen.org/privilege/mediastorage. \n
+ * If you want to access only external storage by using this function, you should add privilege %http://tizen.org/privilege/externalstorage. \n
+ * If you want to access storages of both types, you must add all privileges. \n
*
- * @param[in] media The handle to media info
- * @param[in] longitude The longitude of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @post media_info_update_to_db()
+ * @param[in] media_path The media path
+ * @param[out] media The handle to the media info
*
- */
-int media_info_set_longitude(media_info_h media, double longitude);
-
-/**
- * @brief Sets latitude to media info.
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- * @param[in] media The handle to media info
- * @param[in] latitude The latitude of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @post media_info_update_to_db()
- *
- */
-int media_info_set_latitude(media_info_h media, double latitude);
-
-/**
- * @brief Sets altitude to media info.
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
+ * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
*
- * @param[in] media The handle to media info
- * @param[in] altitude The altitude of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @post media_info_update_to_db()
+ * @pre This function requires opened connection to content service by media_content_connect().
*
+ * @see media_content_connect()
+ * @see media_info_destroy()
*/
-int media_info_set_altitude(media_info_h media, double altitude);
+int media_info_get_media_from_db_by_path(const char *media_path, media_info_h *media);
/**
- * @brief Sets rating to media info.
+ * @brief Sets the favorite of media info.
+ * @details This function can mark favorite of the media. If set to @c true, this function record the time of the change moment. \n
+ * So, If you use it in order parameter, you can sort the order of the time was a favorite. \n
+ * Or, if you use it in condition parameter, you can get the result of the favorite media.
*
- * @param[in] media The handle to media info
- * @param[in] rating The rating of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @post media_info_update_to_db()
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- */
-int media_info_set_rating(media_info_h media, int rating);
-
-/**
- * @brief Sets favorite to media info.
+ * @param[in] media The handle to the media info
+ * @param[in] favorite Set @c true to set the media info as favorite,
+ * otherwise set @c false to not set the media info as favorite
*
- * @param[in] media The handle to media info
- * @param[in] favorite The favorite of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*/
int media_info_set_favorite(media_info_h media, bool favorite);
/**
- * @brief Sets author to media info.
+ * @brief Updates the media info to the media database.
*
- * @param[in] media The handle to media info
- * @param[in] author The author of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @details The function updates the given media info in the media database.
*
- */
-int media_info_set_author(media_info_h media, const char *author);
-
-/**
- * @brief Sets provider to media info.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/content.write
*
- * @param[in] media The handle to media info
- * @param[in] provider The provider of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @remarks The function should be called after any change in media, to be updated to the media
+ * database. For example, after using media_info_set_favorite()
+ * for setting the name of the media, the media_info_update_to_db() function should be called so as to update
+ * the given media info attributes in the media database.
*
- */
-int media_info_set_provider(media_info_h media, const char *provider);
-
-/**
- * @brief Sets content name to media info.
+ * @param[in] media The handle to the media info
*
- * @param[in] media The handle to media info
- * @param[in] content_name The content name of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ *
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @post media_info_update_to_db()
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
+ * @retval #MEDIA_CONTENT_ERROR_NETWORK Network fail
+ * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
*
+ * @pre This function requires opened connection to content service by media_content_connect().
+ *
+ * @see media_content_connect()
+ * @see media_info_set_favorite()
*/
-int media_info_set_content_name(media_info_h media, const char *content_name);
+int media_info_update_to_db(media_info_h media);
/**
- * @brief Sets category to media info.
+ * @brief Moves the media info to the given destination path in the media database.
+ * @details After moving or renaming a file in the filesystem, call this function to update the database. \n
+ * If the source path and destination path are the same, then this function does nothing.
+ * If you want to refresh media information, you should use media_content_scan_file() function.
+ *
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ *
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/content.write \n
+ * %http://tizen.org/privilege/mediastorage \n
+ * %http://tizen.org/privilege/externalstorage
+ *
+ * @remarks You must add privilege %http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path. \n
+ * If you want to access only internal storage by using this function, you should add privilege %http://tizen.org/privilege/mediastorage. \n
+ * Or if you want to access only external storage by using this function, you should add privilege %http://tizen.org/privilege/externalstorage. \n
+ * If you can access both storage, you should add all privilege. \n
+ * Since 4.0, this function does not allow symbolic links. \n
+ * This function does not support USB storage before 5.0. Since 5.0, USB storage is supported. \n
+ * Since 5.0, the thumbnail is removed if it exists.
+ *
+ * @param[in] media The handle to the media info
+ * @param[in] dst_path The path of destination
*
- * @param[in] media The handle to media info
- * @param[in] category The category of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @post media_info_update_to_db()
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- */
-int media_info_set_category(media_info_h media, const char *category);
-
-/**
- * @brief Sets location tag to media info.
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter (Especially, if the request is duplicated, this error returns.)
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
+ * @retval #MEDIA_CONTENT_ERROR_NETWORK Network fail
+ * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
*
- * @param[in] media The handle to media info
- * @param[in] location_tag The location of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @post media_info_update_to_db()
+ * @pre This function requires opened connection to content service by media_content_connect().
*
+ * @see media_content_connect()
+ * @see media_content_scan_folder()
+ * @see media_info_generate_thumbnail()
*/
-int media_info_set_location_tag(media_info_h media, const char *location_tag);
+int media_info_move_to_db(media_info_h media, const char* dst_path);
/**
- * @brief Sets age rating to media info.
+ * @brief Generates a thumbnail file for the given media, synchronously.
*
- * @param[in] media The handle to media info
- * @param[in] age_rating The age rating of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @post media_info_update_to_db()
+ * @since_tizen 5.0
*
- */
-int media_info_set_age_rating(media_info_h media, const char *age_rating);
-
-/**
- * @brief Sets keyword to media info.
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/content.write
*
- * @param[in] media The handle to media info
- * @param[in] keyword The keyword of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @post media_info_update_to_db()
+ * @remarks %http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage. \n
+ * %http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage. \n
+ * Items in external storage are not supported, with the exception of MMC.
*
- */
-int media_info_set_keyword(media_info_h media, const char *keyword);
-
-/**
- * @brief Updates the media info to the media database.
+ * @param[in] media The handle to the media info
*
- * @details The function updates the given media info in the media database. The function should be called after any change in media, to be updated to the media
- * database. For example, after using media_info_set_display_name() for setting the name of the media, media_info_update_to_db() function should be called so as to update
- * the given media info attibutes in the media database.
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- * @param[in] media The handle to media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
+ * @retval #MEDIA_CONTENT_ERROR_NETWORK Network fail
+ * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
+ *
* @pre This function requires opened connection to content service by media_content_connect().
- * @see media_content_connect()
- * @see media_info_set_display_name()
- * @see media_info_set_description()
- * @see media_info_set_longitude()
- * @see media_info_set_latitude()
- * @see media_info_set_altitude()
- * @see media_info_set_rating()
- * @see media_info_set_favorite()
- * @see media_info_set_author()
- * @see media_info_set_provider()
- * @see media_info_set_content_name()
- * @see media_info_set_category()
- * @see media_info_set_location_tag()
- * @see media_info_set_age_rating()
*
+ * @see media_content_connect()
+ * @see media_info_get_thumbnail_path()
*/
-int media_info_update_to_db(media_info_h media);
+int media_info_generate_thumbnail(media_info_h media);
/**
- * @brief Refresh the metadata of media to media database.
+ * @deprecated Deprecated since 8.0.
+ * @ingroup CAPI_CONTENT_MEDIA_FACE_DETECTION_MODULE
+ * @brief Starts face detection for the given image, asynchronously.
+ * @details This function detects faces for given image item and calls the given callback function when the detection is completed. \n
+ * The given callback function is called when the detection is completed. \n
+ * To obtain the detected faces, call the media_info_foreach_face_from_db() function. \n
+ * Supported image formats are jpg, png, and bmp.
*
- * @param[in] media_id The ID of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB operation failed
- * @pre This function requires opened connection to content service by media_content_connect().
- * @see media_content_connect()
+ * @since_tizen 3.0
*
- */
-int media_info_refresh_metadata_to_db(const char *media_id);
-
-/**
- * @brief Sets added_time to media info.
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/content.write \n
+ * %http://tizen.org/privilege/mediastorage \n
+ * %http://tizen.org/privilege/externalstorage
*
- * @param[in] media The handle to media info
- * @param[in] added_time The added time of media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @post media_info_update_to_db()
+ * @remarks If you want to destroy the media handle before the callback invoked, you must cancel the face detection request using media_info_cancel_face_detection(). \n
+ * If the face detection fails, the @a face_count argument in media_face_detection_completed_cb() will be set to 0. \n
+ * The face detection of media items in external storage except MMC is not supported. \n
+ * Since 5.5, if the format of media data is unsupported, this function returns an error and the callback will not be invoked.
*
- */
-int media_info_set_added_time(media_info_h media, time_t added_time);
-
-/**
- * @brief Moves the media info to the given destination path in the media database.
+ * @param[in] media The handle to the media info
+ * @param[in] callback The callback function to be invoked when detection is completed
+ * @param[in] user_data The user data to be passed to the callback function
*
- * @param[in] media The handle to media info
- * @param[in] dst_path The path of destination
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB operation failed
- * @pre This function requires opened connection to content service by media_content_connect().
- * @see media_content_connect()
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- */
-int media_info_move_to_db(media_info_h media, const char* dst_path);
-
-/**
- * @brief Creates a thumbnail image for given the media, asynchronously.
- * @details This function creates an thumbnail image for given media item and and calls registered callback function for completion of creating the thumbnail.
- * If there already exist a thumbnail for given media, then the path of thumbnail will be return in callback function.
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
+ * @retval #MEDIA_CONTENT_ERROR_NETWORK Network fail
+ * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #MEDIA_CONTENT_ERROR_NOT_SUPPORTED Not supported
*
- * @param[in] media The handle to media info
- * @param[in] callback The callback function to invoke
- * @param[in] user_data The user data to be passed to the callback function
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter ( Especially, if the request is duplicated, this error returns. )
- * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB operation failed
* @pre This function requires opened connection to content service by media_content_connect().
+ *
* @see media_content_connect()
+ * @see media_info_cancel_face_detection()
*/
-int media_info_create_thumbnail(media_info_h media, media_thumbnail_completed_cb callback, void *user_data);
-
+int media_info_start_face_detection(media_info_h media, media_face_detection_completed_cb callback, void *user_data) TIZEN_DEPRECATED_API;
/**
- * @brief Cancel to creates a thumbnail image for given the media.
+ * @deprecated Deprecated since 8.0.
+ * @ingroup CAPI_CONTENT_MEDIA_FACE_DETECTION_MODULE
+ * @brief Cancels face detection of image for the given media.
+ * @details This function cancels face detection for given media item. \n
+ * If you cancel face detection request before callback is invoked, the callback registered by media_info_start_face_detection() function will not be invoked.
*
- * @param[in] media The handle to media info
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @since_tizen 3.0
+ *
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/content.write
+ *
+ * @remarks If face detection is already done when you request the cancellation, this function returns #MEDIA_CONTENT_ERROR_INVALID_OPERATION
+ *
+ * @param[in] media The handle to the media info
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ *
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
+ *
* @pre This function requires opened connection to content service by media_content_connect().
+ *
* @see media_content_connect()
+ * @see media_info_start_face_detection()
*/
-int media_info_cancel_thumbnail(media_info_h media);
+int media_info_cancel_face_detection(media_info_h media) TIZEN_DEPRECATED_API;
/**
* @}
*/
-
#ifdef __cplusplus
}
#endif /* __cplusplus */
-#endif /* __TIZEN_MEDIA_INFORMATION_H__ */
+#endif /* __TIZEN_CONTENT_MEDIA_INFO_H__ */
projects / platform / core / api / media-content.git / blobdiff