Merge "Apply tizen coding rule" into tizen

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

diff --git a/include/media_playlist.h b/include/media_playlist.h
index bc3bb73..fdd233c 100755 (executable)
--- a/include/media_playlist.h
+++ b/include/media_playlist.h
@@ -39,12 +39,12 @@ extern "C" {
 
 /**
  * @brief Gets the number of playlists for the passed @a filter from the media database.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in]  filter         The handle to the filter
  * @param[out] playlist_count The count of the media playlist
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
@@ -65,13 +65,13 @@ int media_playlist_get_playlist_count_from_db(filter_h filter, int *playlist_cou
  *          The callback function will be invoked for every retrieved media playlist.
  *          If @c NULL is passed to the filter, no filtering is applied.
  *
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in] filter    The handle to the audio 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, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
@@ -92,13 +92,13 @@ int media_playlist_foreach_playlist_from_db(filter_h filter, media_playlist_cb c
 
 /**
  * @brief Gets the number of the media info for the given playlist present in the media database.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in]  playlist_id  The ID of the media playlist
  * @param[in]  filter       The media filter handle
  * @param[out] media_count  The number of media items
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
@@ -119,14 +119,14 @@ int media_playlist_get_media_count_from_db(int playlist_id, filter_h filter, int
  *          meeting desired filter option and calls registered callback function for
  *          every retrieved media info. If @c NULL is passed to the @a filter, no filtering is applied.
  *
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in] playlist_id The ID of the media playlist
  * @param[in] filter      The audio 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
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
@@ -147,7 +147,7 @@ int media_playlist_foreach_media_from_db(int playlist_id, filter_h filter, playl
 
 /**
  * @brief Inserts a new playlist with the given name into the media database.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @privlevel public
  * @privilege %http://tizen.org/privilege/content.write
@@ -157,7 +157,7 @@ int media_playlist_foreach_media_from_db(int playlist_id, filter_h filter, playl
  * @param[in]  name     The name of the inserted playlist
  * @param[out] playlist A created handle to media playlist
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
@@ -178,14 +178,14 @@ int media_playlist_insert_to_db(const char *name, media_playlist_h *playlist);
 
 /**
  * @brief Deletes the given playlist from the media database.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @privlevel public
  * @privilege %http://tizen.org/privilege/content.write
  *
  * @param[in] playlist_id The ID of media playlist
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
@@ -209,14 +209,14 @@ int media_playlist_delete_from_db(int playlist_id);
  * @details This function creates a new media playlist handle from the media database by the given @a playlist_id.
  *          The media playlist will be created and will be filled with the playlist information.
  *
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @remarks You must release @a playlist using media_playlist_destroy().
  *
  * @param[in]  playlist_id The ID of the media playlist
  * @param[out] playlist    The media playlist handle associated with the playlist ID
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
@@ -239,11 +239,11 @@ int media_playlist_get_playlist_from_db(int playlist_id, media_playlist_h *playl
  *          handle no longer can be used to perform any operation. A new handle has to
  *          be created before next usage.
  *
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in] playlist The media playlist handle
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
@@ -263,14 +263,14 @@ int media_playlist_destroy(media_playlist_h playlist);
  *          media playlist foreach function such as media_playlist_foreach_playlist_from_db().
  *          To use this handle outside of these foreach functions, use this function.
  *
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @remarks The destination handle must be released using media_playlist_destroy().
  *
  * @param[in]  src  The source handle of a media playlist
  * @param[out] dst  The destination handle to a media playlist
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
@@ -285,12 +285,12 @@ int media_playlist_clone(media_playlist_h *dst, media_playlist_h src);
 
 /**
  * @brief Gets the media playlist ID.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in]  playlist    The media playlist handle
  * @param[out] playlist_id The ID of the media playlist
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
@@ -301,14 +301,14 @@ int media_playlist_get_playlist_id(media_playlist_h playlist, int *playlist_id);
 
 /**
  * @brief Gets a name of the playlist.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @remarks You must release @a playlist_name using free().
  *
  * @param[in]  playlist      The media playlist handle
  * @param[out] playlist_name The playlist name
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
@@ -320,12 +320,12 @@ int media_playlist_get_name(media_playlist_h playlist, char **playlist_name);
 
 /**
  * @brief Sets the name of the playlist.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in] playlist      The media playlist handle
  * @param[in] playlist_name The name of the media playlist
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
@@ -340,14 +340,14 @@ int media_playlist_set_name(media_playlist_h playlist, const char *playlist_name
 
 /**
  * @brief Gets a thumbnail path of the playlist.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @remarks You must release @a path using free().
  *
  * @param[in]  playlist The media playlist handle
  * @param[out] path     The path of the thumbnail
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
@@ -359,12 +359,12 @@ int media_playlist_get_thumbnail_path(media_playlist_h playlist, char **path);
 
 /**
  * @brief Sets the thumbnail path of the playlist.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in] playlist The media playlist handle
  * @param[in] path     The path of the thumbnail
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
@@ -379,13 +379,13 @@ int media_playlist_set_thumbnail_path(media_playlist_h playlist, const char *pat
 
 /**
  * @brief Sets the playing order in the playlist.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in] playlist           The media playlist handle
  * @param[in] playlist_member_id The playlist member ID
  * @param[in] play_order         The playing order
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
@@ -399,12 +399,12 @@ int media_playlist_set_play_order(media_playlist_h playlist, int playlist_member
 
 /**
  * @brief Adds a new media info to the playlist.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in] playlist The media playlist handle
  * @param[in] media_id The ID to the media info which is added
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
@@ -422,12 +422,12 @@ int media_playlist_add_media(media_playlist_h playlist, const char *media_id);
 
 /**
  * @brief Removes the playlist members related with the media from the given playlist.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in] playlist           The media playlist handle
  * @param[in] playlist_member_id The playlist member ID
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
@@ -445,13 +445,13 @@ int media_playlist_remove_media(media_playlist_h playlist, int playlist_member_i
 
 /**
  * @brief Gets the played order of the playlist.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @param[in] playlist           The media playlist handle
  * @param[in] playlist_member_id The playlist member ID
  * @param[out] play_order        The played order
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
@@ -469,14 +469,14 @@ int media_playlist_get_play_order(media_playlist_h playlist, int playlist_member
  *          media_playlist_update_to_db() function should be called so as to update
  *          the given playlist attributes in the media database.
  *
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
  * @privlevel public
  * @privilege %http://tizen.org/privilege/content.write
  *
  * @param[in] playlist The media playlist handle
  *
- * @return @c 0 on success, 
+ * @return @c 0 on success,
  *         otherwise a negative error value
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
@@ -502,7 +502,7 @@ int media_playlist_update_to_db(media_playlist_h playlist);
 /**
  * @brief Imports the playlist from m3u playlist file.
  * @details This api reads a playlist from the m3u playlist file and insert into the db.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @privlevel public
  * @privilege %http://tizen.org/privilege/content.write
@@ -531,7 +531,7 @@ int media_playlist_import_from_file(const char *playlist_name, const char *path,
 
 /**
  * @brief Exports the playlist to m3u playlist file.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @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