[ACR]Add Bookmark and Face Search APIs

[platform/core/api/media-content.git] / include / media_bookmark.h

diff --git a/include/media_bookmark.h b/include/media_bookmark.h
index ef32da6..2d2af6e 100755 (executable)
--- a/include/media_bookmark.h
+++ b/include/media_bookmark.h
@@ -117,6 +117,35 @@ int media_bookmark_delete_from_db(int bookmark_id);
 int media_bookmark_get_bookmark_count_from_db(filter_h filter, int *bookmark_count);
 
 /**
+ * @brief Iterates through the bookmarks with an optional filter from the media database.
+ * @details This function gets all bookmarks associated with the given filter and calls registered callback function for every retrieved media bookmark. 
+ *          If @c NULL is passed to the @a filter, then no filtering is applied.
+ * @since_tizen 4.0
+ *
+ * @param[in] filter     The handle to the bookmark 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
+ * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
+ *
+ * @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_bookmark_foreach_bookmark_from_db(filter_h filter, media_bookmark_cb callback, void *user_data);
+
+/**
  * @brief Clones a media bookmark.
  * @details This function copies the media bookmark handle from a source to destination. There is no media_bookmark_create() function.
  *          The media_bookmark_h is created internally and available through media bookmark foreach function such as media_info_foreach_bookmark_from_db().