Code sync(New ACR Items) with TV Product code

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

diff --git a/include/media_bookmark.h b/include/media_bookmark.h
index 1d329b8..d30745f 100755 (executable)
--- a/include/media_bookmark.h
+++ b/include/media_bookmark.h
@@ -219,6 +219,75 @@ int media_bookmark_get_marked_time(media_bookmark_h bookmark, time_t *marked_tim
  */
 int media_bookmark_get_thumbnail_path(media_bookmark_h bookmark, char **path);
 
+/**
+ * @brief Gets the media bookmark name which user set.
+ * @since_tizen 4.0
+ *
+ * @remarks You must release @a name using free().
+ *
+ * @param[in] bookmark The handle to media bookmark
+ * @param[out] name     The name of media bookmark. If name was not set, empty string is returned.
+ *                               If User set bookmark name to NULL, name will be empty string also.
+ *
+ * @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
+ */
+int media_bookmark_get_name(media_bookmark_h bookmark, char **name);
+
+/**
+ * @brief Sets the media bookmark name.
+ * @since_tizen 4.0
+ *
+ * @param[in] bookmark The handle to media bookmark
+ * @param[in] name     The name of media bookmark. Can be NULL, empty or non-empty string.
+ *
+ * @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
+ *
+ * @post media_bookmark_update_to_db()
+ */
+int media_bookmark_set_name(media_bookmark_h bookmark, const char *name);
+
+/**
+ * @brief Updates bookmark information to the media database.
+ * @details The function updates the given bookmark meta in the media database. \n
+ *          The function should be called after any change in bookmark attributes, to be updated to the media database. \n
+ *          For example, after using media_bookmark_set_name() for setting the name of the bookmark, \n
+ *          the media_bookmark_update_to_db() function should be called so as to update the given bookmark attributes in the media database.
+ * @since_tizen 4.0
+ *
+ * @privlevel public
+ * @privilege %http://tizen.org/privilege/content.write
+ *
+ * @remarks Do not call this function in callback function of foreach function like media_info_foreach_bookmark_from_db().
+ * @param[in] bookmark The handle to media bookmark
+ *
+ * @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_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 when Application has no privilege
+ *
+ * @pre This function requires opened connection to content service by media_content_connect().
+ *
+ * @see media_content_connect()
+ * @see media_bookmark_set_name()
+ */
+int media_bookmark_update_to_db(media_bookmark_h bookmark);
 
 /**
  * @}