X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=include%2Fmedia_video.h;h=c9699903dd964ef01d741ca97286b50a8bcf567c;hb=e68d9bbbc5b05d2d6e76cad0c739288e9f66ca33;hp=449a483fd5a259dd51d30b779176afe563201f11;hpb=0d33375fab1a74cd11194cb16b200782b84c5055;p=platform%2Fcore%2Fapi%2Fmedia-content.git

diff --git a/include/media_video.h b/include/media_video.h
index 449a483..c969990 100755
--- a/include/media_video.h
+++ b/include/media_video.h
@@ -15,8 +15,8 @@
 */
 
 
-#ifndef __TIZEN_VIDEO_META_H__
-#define __TIZEN_VIDEO_META_H__
+#ifndef __TIZEN_CONTENT_MEDIA_VIDEO_H__
+#define __TIZEN_CONTENT_MEDIA_VIDEO_H__
 
 #include <media_content_type.h>
 
@@ -28,7 +28,7 @@ extern "C" {
  * @file media_video.h
  * @brief This file contains the video metadata API and related functions to proceed with video metadata. \n
  *        Functions include cloning and destroying video metadata, getting video metadata such as width, height, \n
- *        album, genre, played parameters etc. and updating video to DB.
+ *        album, genre, etc.
  */
 
 /**
@@ -42,10 +42,10 @@ extern "C" {
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks You must release the destination handle using video_meta_destroy().
+ * @remarks The @a dst should be released using video_meta_destroy().
  *
  * @param[out] dst The destination handle to the video metadata
- * @param[in]  src The source handle to the video metadata
+ * @param[in] src The source handle to the video metadata
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -61,12 +61,12 @@ int video_meta_clone(video_meta_h *dst, video_meta_h src);
 /**
  * @brief Destroys the video metadata.
  * @details This function frees all resources related to the video metadata handle. This handle
- *          no longer can be used to perform any operation. A new handle has to
+ *          no longer can be used to perform any operations. A new handle has to
  *          be created before the next use.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @param[in] video The video metadata handle
+ * @param[in] video The handle to the video metadata
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -84,10 +84,10 @@ int video_meta_destroy(video_meta_h video);
  * @brief Gets the ID of the media of the given video metadata.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks You must release @a media_id using free().
+ * @remarks The @a media_id should be released using free().
  *
- * @param[in]  video    The video metadata handle
- * @param[out] media_id The ID of the video
+ * @param[in] video The handle to the video metadata
+ * @param[out] media_id The media ID
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -101,13 +101,13 @@ int video_meta_get_media_id(video_meta_h video, char **media_id);
 /**
  * @brief Gets the album of the given video metadata.
  * @details If the value is an empty string, the method returns "Unknown". \n
- *                Since 3.0, if the media content has no album info, the method returns empty string.
+ *          Since 3.0, if the media content has no album info, the method returns empty string.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks You must release @a album using free().
+ * @remarks The @a album should be released using free().
  *
- * @param[in]  video The video metadata handle
+ * @param[in] video The handle to the video metadata
  * @param[out] album The album of the video metadata
  *
  * @return @c 0 on success,
@@ -122,13 +122,13 @@ int video_meta_get_album(video_meta_h video, char **album);
 /**
  * @brief Gets the artist of the given video metadata.
  * @details If the value is an empty string, the method returns "Unknown". \n
- *                Since 3.0, if the media content has no artist info, the method returns empty string.
+ *          Since 3.0, if the media content has no artist info, the method returns empty string.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks You must release @a artist using free().
+ * @remarks The @a artist should be released using free().
  *
- * @param[in]  video  The video metadata handle
+ * @param[in] video The handle to the video metadata
  * @param[out] artist The artist of the video metadata
  *
  * @return @c 0 on success,
@@ -143,13 +143,13 @@ int video_meta_get_artist(video_meta_h video, char **artist);
 /**
  * @brief Gets the video album artist.
  * @details If the value is an empty string, the method returns "Unknown". \n
- *                Since 3.0, if the media content has no album artist info, the method returns empty string.
+ *          Since 3.0, if the media content has no album artist info, the method returns empty string.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks You must release @a album_artist using free().
+ * @remarks The @a album_artist should be released using free().
  *
- * @param[in]  video        The video metadata handle
+ * @param[in] video The handle to the video metadata
  * @param[out] album_artist The album artist of the video metadata
  *
  * @return @c 0 on success,
@@ -164,13 +164,13 @@ int video_meta_get_album_artist(video_meta_h video, char **album_artist);
 /**
  * @brief Gets the genre of the given video metadata.
  * @details If the value is an empty string, the method returns "Unknown". \n
- *                Since 3.0, if the media content has no genre info, the method returns empty string.
+ *          Since 3.0, if the media content has no genre info, the method returns empty string.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks You must release @a genre using free().
+ * @remarks The @a genre should be released using free().
  *
- * @param[in]  video The video metadata handle
+ * @param[in] video The handle to the video metadata
  * @param[out] genre The genre of the video metadata
  *
  * @return @c 0 on success,
@@ -185,13 +185,13 @@ int video_meta_get_genre(video_meta_h video, char **genre);
 /**
  * @brief Gets the composer of the given video metadata.
  * @details If the value is an empty string, the method returns "Unknown". \n
- *                Since 3.0, if the media content has no composer info, the method returns empty string.
+ *          Since 3.0, if the media content has no composer info, the method returns empty string.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks You must release @a composer using free().
+ * @remarks The @a composer should be released using free().
  *
- * @param[in]  video    The video metadata handle
+ * @param[in] video The handle to the video metadata
  * @param[out] composer The composer of the video metadata
  *
  * @return @c 0 on success,
@@ -206,14 +206,14 @@ int video_meta_get_composer(video_meta_h video, char **composer);
 /**
  * @brief Gets the year of the given video metadata.
  * @details If the value is an empty string, the method returns "Unknown". \n
- *                Since 3.0, if the media content has no year info, the method returns empty string.
+ *          Since 3.0, if the media content has no year info, the method returns empty string.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks You must release @a year using free().
+ * @remarks The @a year should be released using free().
  *
- * @param[in]  video The video metadata handle
- * @param[out] year  The year of the video metadata
+ * @param[in] video The handle to the video metadata
+ * @param[out] year The year of the video metadata
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -225,15 +225,15 @@ int video_meta_get_composer(video_meta_h video, char **composer);
 int video_meta_get_year(video_meta_h video, char **year);
 
 /**
- * @brief Gets the recorded date of the video.
- * @details The recorded date is got from video file's metadata. Some formats like mp4 use UTC and the rest can be different. \n
- *              So, please refer to the format specification if needed.
+ * @brief Gets the recorded date of the given video metadata.
+ * @details The format of the recorded date may vary depending on the file format. \n
+ *          For more details on the recorded date format, refer to the file format specification.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks You must release @a recorded_date using free().
+ * @remarks The @a recorded_date should be released using free().
  *
- * @param[in]  video         The video metadata handle
+ * @param[in] video The handle to the video metadata
  * @param[out] recorded_date The recorded date of the video metadata
  *
  * @return @c 0 on success,
@@ -248,13 +248,13 @@ int video_meta_get_recorded_date(video_meta_h video, char **recorded_date);
 /**
  * @brief Gets the copyright notice of the given video metadata.
  * @details If the value is an empty string, the method returns "Unknown". \n
- *                Since 3.0, if the media content has no copyright info, the method returns empty string.
+ *          Since 3.0, if the media content has no copyright info, the method returns empty string.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks You must release @a copyright using free().
+ * @remarks The @a copyright should be released using free().
  *
- * @param[in]  video     The video metadata handle
+ * @param[in] video The handle to the video metadata
  * @param[out] copyright The copyright of the video metadata
  *
  * @return @c 0 on success,
@@ -269,13 +269,13 @@ int video_meta_get_copyright(video_meta_h video, char **copyright);
 /**
  * @brief Gets the track number of the given video metadata.
  * @details If the value is an empty string, the method returns "Unknown". \n
- *                Since 3.0, if the media content has no track info, the method returns empty string.
+ *          Since 3.0, if the media content has no track info, the method returns empty string.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks You must release @a track_num using free().
+ * @remarks The @a track_num should be released using free().
  *
- * @param[in]  video     The video metadata handle
+ * @param[in] video The handle to the video metadata
  * @param[out] track_num The track number of the video metadata
  *
  * @return @c 0 on success,
@@ -291,7 +291,7 @@ int video_meta_get_track_num(video_meta_h video, char **track_num);
  * @brief Gets the bitrate of the given video metadata in bitrate per second.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @param[in]  video    The video metadata handle
+ * @param[in] video The handle to the video metadata
  * @param[out] bit_rate The video bit rate in bit per second [bps]
  *
  * @return @c 0 on success,
@@ -306,7 +306,7 @@ int video_meta_get_bit_rate(video_meta_h video, int *bit_rate);
  * @brief Gets the track duration of the given video metadata.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @param[in]  video    The video metadata handle
+ * @param[in] video The handle to the video metadata
  * @param[out] duration The video duration in milliseconds
  *
  * @return @c 0 on success,
@@ -321,7 +321,7 @@ int video_meta_get_duration(video_meta_h video, int *duration);
  * @brief Gets the width of the given video metadata.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @param[in]  video The video metadata handle
+ * @param[in] video The handle to the video metadata
  * @param[out] width The video width in pixels
  *
  * @return @c 0 on success,
@@ -336,7 +336,7 @@ int video_meta_get_width(video_meta_h video, int *width);
  * @brief Gets the height of the given video metadata.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @param[in]  video  The video metadata handle
+ * @param[in] video The handle to the video metadata
  * @param[out] height The video height in pixels
  *
  * @return @c 0 on success,
@@ -351,7 +351,7 @@ int video_meta_get_height(video_meta_h video, int *height);
  * @brief Gets the rotation of the given video metadata.
  * @since_tizen 4.0
  *
- * @param[in]  video  The video metadata handle
+ * @param[in] video The handle to the video metadata
  * @param[out] rotation The clockwise rotation angle of the video in degrees (can be returned from 0 to less than 360)
  *
  * @return @c 0 on success,
@@ -363,39 +363,6 @@ int video_meta_get_height(video_meta_h video, int *height);
 int video_meta_get_rotation(video_meta_h video, int *rotation);
 
 /**
- * @deprecated Deprecated since 4.0. Related setter functions are deprecated, therefore this function is not needed anymore.
- * @brief Updates an video metadata with modified attributes in the media database.
- * @details The function updates the given video meta in the media database. The function should be called after any change in video attributes, to be updated to the media
- *          database.
- *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- * @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_media_from_db().
- *
- * @param[in] video The video metadata handle
- *
- * @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
- *
- * @pre This function requires opened connection to content service by media_content_connect().
- *
- * @see media_content_connect()
- */
-int video_meta_update_to_db(video_meta_h video) TIZEN_DEPRECATED_API;
-
-/**
  *@}
  */
 
@@ -403,4 +370,4 @@ int video_meta_update_to_db(video_meta_h video) TIZEN_DEPRECATED_API;
 }
 #endif /* __cplusplus */
 
-#endif /*__TIZEN_VIDEO_META_H__*/
+#endif /*__TIZEN_CONTENT_MEDIA_VIDEO_H__*/