Remove profile tag

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

diff --git a/include/media_group.h b/include/media_group.h
index f437017..e9819ad 100755 (executable)
--- a/include/media_group.h
+++ b/include/media_group.h
@@ -14,8 +14,8 @@
 * limitations under the License.
 */
 
-#ifndef __TIZEN_MEDIA_GROUP_H__
-#define __TIZEN_MEDIA_GROUP_H__
+#ifndef __TIZEN_CONTENT_MEDIA_GROUP_H__
+#define __TIZEN_CONTENT_MEDIA_GROUP_H__
 
 
 #include <media_content_type.h>
@@ -43,7 +43,7 @@ extern "C" {
  * @brief Gets the number of the album for the passed @a filter from the media database.
  * @since_tizen 2.3
  *
- * @param[in]  filter      The media filter handle
+ * @param[in] filter The handle to the media filter
  * @param[out] album_count The count of the media album
  *
  * @return @c 0 on success,
@@ -51,8 +51,8 @@ extern "C" {
  *
  * @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_PERMISSION_DENIED Permission denied
+ * @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().
  *
@@ -68,8 +68,8 @@ int media_album_get_album_count_from_db(filter_h filter, int *album_count);
  *
  * @since_tizen 2.3
  *
- * @param[in] filter    The media filter handle
- * @param[in] callback  The callback function to be invoked
+ * @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,
@@ -78,7 +78,8 @@ int media_album_get_album_count_from_db(filter_h filter, int *album_count);
  * @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_PERMISSION_DENIED Permission denied
+ * @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_album_cb().
@@ -93,34 +94,35 @@ int media_album_foreach_album_from_db(filter_h filter, media_album_cb callback,
  * @brief Gets the number of media info for the given album present in the media database.
  * @since_tizen 2.3
  *
- * @param[in]  album_id    The ID of the media album
- * @param[in]  filter      The media filter handle
- * @param[out] media_count The count of the album
+ * @param[in] album_id The ID of the media album
+ * @param[in] filter The handle to the media filter
+ * @param[out] media_count The count of the media album
  *
  * @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_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()
  */
-int media_album_get_media_count_from_db (int album_id, filter_h filter, int *media_count);
+int media_album_get_media_count_from_db(int album_id, filter_h filter, int *media_count);
 
 /**
  * @brief Iterates through the media files with an optional @a filter in the given media album from the media database.
  * @details This function gets all media files associated with the given media album and
- *          meeting desired filter option and calls registered callback function for
+ *          meeting desired filter option and calls @a callback for
  *          every retrieved media info. If @c NULL is passed to the @a filter, no filtering is applied.
  *
  * @since_tizen 2.3
  *
- * @param[in] album_id  The ID of the media album
- * @param[in] filter    The media filter handle
- * @param[in] callback  The callback function to be invoked
+ * @param[in] album_id The ID of the media album
+ * @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,
@@ -128,7 +130,9 @@ int media_album_get_media_count_from_db (int album_id, filter_h filter, int *med
  *
  * @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_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().
@@ -142,19 +146,18 @@ int media_album_foreach_media_from_db(int album_id, filter_h filter, media_info_
 /**
  * @brief Destroys the album handle.
  * @details This function frees all resources related to the album handle. This handle
- *          can no longer be used to perform any operation. A new handle has to
+ *          can no longer be used to perform any operations. A new handle has to
  *          be created before the next use.
  *
  * @since_tizen 2.3
  *
- * @param[in] album The media album handle
+ * @param[in] album The handle to the media album
  *
  * @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
  *
  * @pre Get copy of album handle by calling media_album_clone().
  *
@@ -171,10 +174,10 @@ int media_album_destroy(media_album_h album);
  *
  * @since_tizen 2.3
  *
- * @remarks You must release the destination handle using media_album_destroy().
+ * @remarks The @a dst should be released using media_album_destroy().
  *
- * @param[in]  src  The source handle to the media album
- * @param[out] dst  The destination handle to the media album
+ * @param[out] dst The destination handle to the media album
+ * @param[in] src The source handle to the media album
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -182,7 +185,6 @@ int media_album_destroy(media_album_h album);
  * @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_PERMISSION_DENIED Permission denied
  *
  * @see media_album_destroy()
  * @see media_album_foreach_album_from_db()
@@ -193,16 +195,14 @@ int media_album_clone(media_album_h *dst, media_album_h src);
  * @brief Gets the ID of the album.
  * @since_tizen 2.3
  *
- * @param[in]  album    The media album handle
- * @param[out] album_id The media album ID
+ * @param[in] album The handle to the media album
+ * @param[out] album_id The ID of the media album
  *
  * @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_PERMISSION_DENIED Permission denied
  *
  * @see media_album_foreach_album_from_db()
  */
@@ -212,10 +212,10 @@ int media_album_get_album_id(media_album_h album, int *album_id);
  * @brief Gets the name of the album.
  * @since_tizen 2.3
  *
- * @remarks You must release @a album_name using free().
+ * @remarks The @a album_name should be released using free().
  *
- * @param[in]  album       The media album handle
- * @param[out] album_name  The name of the media album handle
+ * @param[in] album The handle to the media album
+ * @param[out] album_name The name of the media album handle
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -223,7 +223,6 @@ int media_album_get_album_id(media_album_h album, int *album_id);
  * @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_PERMISSION_DENIED Permission denied
  */
 int media_album_get_name(media_album_h album, char **album_name);
 
@@ -231,9 +230,9 @@ int media_album_get_name(media_album_h album, char **album_name);
  * @brief Gets the name of the artist from the given album.
  * @since_tizen 2.3
  *
- * @remarks You must release @a artist using free().
+ * @remarks The @a artist should be released using free().
  *
- * @param[in]  album  The media album handle
+ * @param[in] album The handle to the media album
  * @param[out] artist The name of the media artist
  *
  * @return @c 0 on success,
@@ -242,7 +241,6 @@ int media_album_get_name(media_album_h album, char **album_name);
  * @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_PERMISSION_DENIED Permission denied
  */
 int media_album_get_artist(media_album_h album, char **artist);
 
@@ -250,9 +248,9 @@ int media_album_get_artist(media_album_h album, char **artist);
  * @brief Gets the album art path from the album.
  * @since_tizen 2.3
  *
- * @remarks You must release @a album_art using free().
+ * @remarks The @a album_art should be released using free().
  *
- * @param[in]  album     The media album handle
+ * @param[in] album The handle to the media album
  * @param[out] album_art The path of the media album_art
  *
  * @return @c 0 on success,
@@ -261,7 +259,6 @@ int media_album_get_artist(media_album_h album, char **artist);
  * @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_PERMISSION_DENIED Permission denied
  */
 int media_album_get_album_art(media_album_h album, char **album_art);
 
@@ -273,17 +270,19 @@ int media_album_get_album_art(media_album_h album, char **album_art);
  *
  * @since_tizen 2.3
  *
- * @remarks You must release @a folder using media_album_destroy().
+ * @remarks The @a album should be released using media_album_destroy().
  *
- * @param[in]  album_id The ID of the media album
- * @param[out] album    The album handle associated with the album ID
+ * @param[in] album_id The ID of the media album
+ * @param[out] album The handle to the media album
  *
  * @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_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().
  *
@@ -307,16 +306,17 @@ int media_album_get_album_from_db(int album_id, media_album_h *album);
  * @brief Gets the number of the group for the passed @a filter from the media database.
  * @since_tizen 2.3
  *
- * @param[in]  filter       The media filter handle
- * @param[in]  group        The type of the media group
- * @param[out] group_count  The count of the media group
+ * @param[in] filter The handle to the media filter
+ * @param[in] group The type of the media group
+ * @param[out] group_count The count of the media group
  *
  * @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().
  *
@@ -332,9 +332,9 @@ int media_group_get_group_count_from_db(filter_h filter, media_group_e group, in
  *
  * @since_tizen 2.3
  *
- * @param[in] filter    The media filter handle
- * @param[in] group     The type of the media group
- * @param[in] callback  The callback function to be invoked
+ * @param[in] filter The handle to the media filter
+ * @param[in] group The type of the media group
+ * @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,
@@ -342,7 +342,9 @@ int media_group_get_group_count_from_db(filter_h filter, media_group_e group, in
  *
  * @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_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_group_cb().
@@ -357,9 +359,9 @@ int media_group_foreach_group_from_db(filter_h filter, media_group_e group, medi
  * @brief Gets the count of the media info for the given media group present in the media database.
  * @since_tizen 2.3
  *
- * @param[in]  group_name  The name of the media group
- * @param[in]  group       The type of the media group
- * @param[in]  filter      The media filter handle
+ * @param[in] group_name The name of the media group
+ * @param[in] group The type of the media group
+ * @param[in] filter The handle to the media filter
  * @param[out] media_count The count of the media
  *
  * @return @c 0 on success,
@@ -367,7 +369,9 @@ int media_group_foreach_group_from_db(filter_h filter, media_group_e group, medi
  *
  * @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_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().
  *
@@ -378,23 +382,25 @@ int media_group_get_media_count_from_db(const char *group_name, media_group_e gr
  /**
  * @brief Iterates through the media files with an optional @a filter in the given @a group from the media database.
  * @details This function gets all media files associated with the given group and
- *          meeting desired filter option and calls registered callback function for
+ *          meeting desired filter option and calls @a callback for
  *          every retrieved media info. If @c NULL is passed to the @a filter, no filtering is applied.
  *
  * @since_tizen 2.3
  *
  * @param[in] group_name The name of the media group
- * @param[in] group      The type of the media group
- * @param[in] filter     The media filter handle
- * @param[in] callback   The callback function to be invoked
- * @param[in] user_data  The user data to be passed to the callback function
+ * @param[in] group The type of the media group
+ * @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_PERMISSION_DENIED Permission denied
+ * @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().
@@ -410,7 +416,7 @@ int media_group_foreach_media_from_db(const char *group_name, media_group_e grou
   */
 
 #ifdef __cplusplus
- }
+}
 #endif /* __cplusplus */
 
-#endif /* __TIZEN_MEDIA_GROUP_H__ */
+#endif /* __TIZEN_CONTENT_MEDIA_GROUP_H__ */