Remove profile tag
[platform/core/api/media-content.git] / include_product / media_info.h
index d91c101..e0c0f40 100755 (executable)
@@ -48,7 +48,7 @@ extern "C" {
  *          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).
  *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @privlevel public
  * @privilege %http://tizen.org/privilege/content.write \n
@@ -93,7 +93,7 @@ int media_info_insert_to_db(const char *path, media_info_h *info);
  * @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
+ * @since_tizen 2.3
  *
  * @privlevel public
  * @privilege %http://tizen.org/privilege/content.write \n
@@ -140,7 +140,7 @@ int media_info_insert_batch_to_db(const char **path_array, unsigned int array_le
  *          can no longer be used to perform any operations. New media info handle has to
  *          be created before the next usage.
  *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] media The handle to the media info
  *
@@ -162,7 +162,7 @@ int media_info_destroy(media_info_h media);
  * @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.
  *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @remarks The @a dst should be released using media_info_destroy().
  *
@@ -191,7 +191,7 @@ int media_info_clone(media_info_h *dst, media_info_h src);
  * @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.
  *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  *
  * @param[in] filter The handle to the media filter
@@ -218,7 +218,7 @@ int media_info_get_media_count_from_db(filter_h filter, int *media_count);
  *          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
+ * @since_tizen 2.3
  *
  * @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.
@@ -251,7 +251,7 @@ int media_info_foreach_media_from_db(filter_h filter, media_info_cb callback, vo
  * @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.
  *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] media_id The media ID
  * @param[in] filter The handle to the media filter
@@ -277,7 +277,7 @@ int media_info_get_tag_count_from_db(const char *media_id, filter_h filter, int
  * @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
+ * @since_tizen 2.3
  *
  * @param[in] media_id The media ID
  * @param[in] filter The handle to the media filter
@@ -306,7 +306,7 @@ int media_info_foreach_tag_from_db(const char *media_id, filter_h filter, media_
  * @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
+ * @since_tizen 2.3
  *
  * @param[in] media_id The media ID
  * @param[in] filter The handle to the media filter
@@ -332,7 +332,7 @@ int media_info_get_bookmark_count_from_db(const char *media_id, filter_h filter,
  * @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
+ * @since_tizen 2.3
  *
  * @param[in] media_id The media ID
  * @param[in] filter The handle to the media filter
@@ -412,7 +412,7 @@ int media_info_foreach_face_from_db(const char *media_id, filter_h filter, media
  * @brief Gets the image metadata handle for a given media info.
  * @details This function returns an image metadata handle retrieved from the media info.
  *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @remarks The @a image should be released using image_meta_destroy().
  *
@@ -434,7 +434,7 @@ int media_info_get_image(media_info_h media, image_meta_h *image);
  * @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.
  *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @remarks The @a video should be released using video_meta_destroy().
  *
@@ -456,7 +456,7 @@ int media_info_get_video(media_info_h media, video_meta_h *video);
  * @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.
  *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @remarks The @a audio should be released using audio_meta_destroy().
  *
@@ -500,7 +500,7 @@ 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
+ * @since_tizen 2.3
  * @remarks The @a media_id should be released using free().
  *
  * @param[in] media The handle to the media info
@@ -517,7 +517,7 @@ int media_info_get_media_id(media_info_h media, char **media_id);
 
 /**
  * @brief Gets the full path of the content file.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @remarks The @a path should be released using free().
  *
@@ -536,7 +536,7 @@ int media_info_get_file_path(media_info_h media, char **path);
 
 /**
  * @brief Gets the file name including the extension of the content file.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @remarks The @a name should be released using free().
  *
@@ -554,7 +554,7 @@ int media_info_get_display_name(media_info_h media, char **name);
 
 /**
  * @brief Gets the content type of the content file.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] media The handle to the media info
  * @param[out] type The content type of the content file (#media_content_type_e)
@@ -571,7 +571,7 @@ int media_info_get_media_type(media_info_h media, media_content_type_e *type);
 
 /**
  * @brief Gets the MIME type of the content file.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @remarks The @a mime_type should be released using free().
  *
@@ -589,7 +589,7 @@ int media_info_get_mime_type(media_info_h media, char **mime_type);
 
 /**
  * @brief Gets the content file size.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] media The handle to the media info
  * @param[out] size The content file size
@@ -605,7 +605,7 @@ int media_info_get_size(media_info_h media, unsigned long long *size);
 /**
  * @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
+ * @since_tizen 2.3
  *
  * @param[in] media The handle to the media info
  * @param[out] added_time The added time to the media database
@@ -621,7 +621,7 @@ int media_info_get_added_time(media_info_h media, time_t *added_time);
 /**
  * @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
+ * @since_tizen 2.3
  *
  * @param[in] media The handle to the media info
  * @param[out] time The last modification time of the content file
@@ -638,7 +638,7 @@ int media_info_get_modified_time(media_info_h media, time_t *time);
  * @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
+ * @since_tizen 2.3
  *
  * @param[in] media The handle to the media info
  * @param[out] time The timeline of content file
@@ -653,7 +653,7 @@ int media_info_get_timeline(media_info_h media, time_t *time);
 
 /**
  * @brief Gets the thumbnail path of content file.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @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
@@ -676,7 +676,7 @@ int media_info_get_thumbnail_path(media_info_h media, char **path);
  * @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
+ * @since_tizen 2.3
  *
  * @remarks The @a description should be released using free().
  *
@@ -694,7 +694,7 @@ int media_info_get_description(media_info_h media, char **description);
 
 /**
  * @brief Gets the longitude of content file.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] media The handle to the media info
  * @param[out] longitude The longitude of the content file
@@ -709,7 +709,7 @@ int media_info_get_longitude(media_info_h media, double *longitude);
 
 /**
  * @brief Gets the latitude of content file.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] media The handle to the media info
  * @param[out] latitude The latitude of the content file
@@ -725,7 +725,7 @@ int media_info_get_latitude(media_info_h media, double* latitude);
 
 /**
  * @brief Gets the altitude of content file.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] media The handle to the media info
  * @param[out] altitude The altitude of the content file
@@ -740,7 +740,7 @@ int media_info_get_altitude(media_info_h media, double* altitude);
 
 /**
  * @brief Gets the rating of content file.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] media The handle to the media info
  * @param[out] rating The rating of the content file
@@ -755,7 +755,7 @@ int media_info_get_rating(media_info_h media, int *rating);
 
 /**
  * @brief Gets the favorite status of content file which User set.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] media The handle to the media info
  * @param[out] favorite @c true if content file is set as favorite,
@@ -775,7 +775,7 @@ int media_info_get_favorite(media_info_h media, bool* favorite);
  * @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.
  *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @remarks The @a title should be released using free().
  *
@@ -793,7 +793,7 @@ int media_info_get_title(media_info_h media, char **title);
 
 /**
  * @brief Checks whether the media is protected via DRM.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] media The handle to the media info
  * @param[out] is_drm @c true if media is DRM media,
@@ -829,7 +829,7 @@ int media_info_is_360_content(media_info_h media, bool *is_360);
  * @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.
  *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @remarks The @a media should be released using media_info_destroy().
  *
@@ -890,7 +890,7 @@ int media_info_get_media_from_db_by_path(const char *media_path, media_info_h *m
  *                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.
  *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
  * @param[in] media The handle to the media info
  * @param[in] favorite Set @c true to set the media info as favorite,
@@ -909,7 +909,7 @@ int media_info_set_favorite(media_info_h media, bool favorite);
  *
  * @details The function updates the given media info in the media database.
  *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  * @privlevel public
  * @privilege %http://tizen.org/privilege/content.write
  *
@@ -945,7 +945,7 @@ int media_info_update_to_db(media_info_h media);
  *               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
+ * @since_tizen 2.3
  *
  * @privlevel public
  * @privilege %http://tizen.org/privilege/content.write \n