Modify checker for scan ignore

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

diff --git a/include/media_video.h b/include/media_video.h
index 9d8da34..1148325 100755 (executable)
--- a/include/media_video.h
+++ b/include/media_video.h
@@ -53,7 +53,6 @@ extern "C" {
  * @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 video_meta_destroy()
  */
@@ -74,7 +73,6 @@ int video_meta_clone(video_meta_h *dst, video_meta_h src);
  *
  * @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 video metadata handle by calling video_meta_clone().
  *
@@ -97,7 +95,6 @@ int video_meta_destroy(video_meta_h video);
  * @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 video_meta_get_media_id(video_meta_h video, char **media_id);
 
@@ -119,7 +116,6 @@ int video_meta_get_media_id(video_meta_h video, char **media_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 video_meta_get_album(video_meta_h video, char **album);
 
@@ -141,7 +137,6 @@ int video_meta_get_album(video_meta_h video, char **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
  */
 int video_meta_get_artist(video_meta_h video, char **artist);
 
@@ -163,7 +158,6 @@ int video_meta_get_artist(video_meta_h video, 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 video_meta_get_album_artist(video_meta_h video, char **album_artist);
 
@@ -185,7 +179,6 @@ int video_meta_get_album_artist(video_meta_h video, char **album_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 video_meta_get_genre(video_meta_h video, char **genre);
 
@@ -207,7 +200,6 @@ int video_meta_get_genre(video_meta_h video, char **genre);
  * @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 video_meta_get_composer(video_meta_h video, char **composer);
 
@@ -229,7 +221,6 @@ int video_meta_get_composer(video_meta_h video, char **composer);
  * @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 video_meta_get_year(video_meta_h video, char **year);
 
@@ -248,7 +239,6 @@ int video_meta_get_year(video_meta_h video, char **year);
  * @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 video_meta_get_recorded_date(video_meta_h video, char **recorded_date);
 
@@ -270,7 +260,6 @@ int video_meta_get_recorded_date(video_meta_h video, char **recorded_date);
  * @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 video_meta_get_copyright(video_meta_h video, char **copyright);
 
@@ -292,7 +281,6 @@ int video_meta_get_copyright(video_meta_h video, char **copyright);
  * @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 video_meta_get_track_num(video_meta_h video, char **track_num);
 
@@ -308,7 +296,6 @@ int video_meta_get_track_num(video_meta_h video, char **track_num);
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  */
 int video_meta_get_bit_rate(video_meta_h video, int *bit_rate);
 
@@ -324,7 +311,6 @@ int video_meta_get_bit_rate(video_meta_h video, int *bit_rate);
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  */
 int video_meta_get_duration(video_meta_h video, int *duration);
 
@@ -340,7 +326,6 @@ int video_meta_get_duration(video_meta_h video, int *duration);
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  */
 int video_meta_get_width(video_meta_h video, int *width);
 
@@ -356,7 +341,6 @@ int video_meta_get_width(video_meta_h video, int *width);
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  */
 int video_meta_get_height(video_meta_h video, int *height);
 
@@ -376,7 +360,8 @@ 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 @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. [Use media_info_get_played_count() instead]
+ * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. \n
+ *        This function does not guarantee independence of the played count value between applications. It is recommended that the value is managed by the application.
  * @brief Gets the played count of the video.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
@@ -388,12 +373,12 @@ int video_meta_get_rotation(video_meta_h video, int *rotation);
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  */
 int video_meta_get_played_count(video_meta_h video, int *played_count) TIZEN_DEPRECATED_API;
 
 /**
- * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. [Use media_info_get_played_time() instead]
+ * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. \n
+ *        This function does not guarantee independence of the played time value between applications. It is recommended that the value is managed by the application.
  * @brief Gets the last played time parameter of the video.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
@@ -405,12 +390,12 @@ int video_meta_get_played_count(video_meta_h video, int *played_count) TIZEN_DEP
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  */
 int video_meta_get_played_time(video_meta_h video, time_t *played_time) TIZEN_DEPRECATED_API;
 
 /**
- * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif.
+ * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. \n
+ *        This function does not guarantee independence of the played position value between applications. It is recommended that the value is managed by the application.
  * @brief Gets the played position parameter of the video.
  * @details This function returns the elapsed playback position parameter of the video as period
  *          starting from the beginning of the movie.
@@ -425,12 +410,12 @@ int video_meta_get_played_time(video_meta_h video, time_t *played_time) TIZEN_DE
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  */
 int video_meta_get_played_position(video_meta_h video, int *played_position) TIZEN_DEPRECATED_API;
 
 /**
- * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. [Use media_info_increase_played_count() instead]
+ * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. \n
+ *        This function does not guarantee independence of the played count value between applications. It is recommended that the value is managed by the application.
  * @brief Sets the played count of the video.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
@@ -442,14 +427,12 @@ int video_meta_get_played_position(video_meta_h video, int *played_position) TIZ
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
- *
- * @post video_meta_update_to_db().
  */
 int video_meta_set_played_count(video_meta_h video, int played_count) TIZEN_DEPRECATED_API;
 
 /**
- * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. [Use media_info_set_played_time() instead]
+ * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. \n
+ *        This function does not guarantee independence of the played time value between applications. It is recommended that the value is managed by the application.
  * @brief Sets the last played time of the video.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
@@ -461,14 +444,12 @@ int video_meta_set_played_count(video_meta_h video, int played_count) TIZEN_DEPR
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
- *
- * @post video_meta_update_to_db().
  */
 int video_meta_set_played_time(video_meta_h video, time_t played_time) TIZEN_DEPRECATED_API;
 
 /**
- * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif.
+ * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif. \n
+ *        This function does not guarantee independence of the played position value between applications. It is recommended that the value is managed by the application.
  * @brief Sets the played position of the video.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@@ -483,16 +464,14 @@ int video_meta_set_played_time(video_meta_h video, time_t played_time) TIZEN_DEP
  *
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
- *
- * @post video_meta_update_to_db().
  */
 int video_meta_set_played_position(video_meta_h video, int played_position) TIZEN_DEPRECATED_API;
 
 /**
+ * @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. For example, for setting the played time using video_meta_get_played_time(), after that the video_meta_update_to_db() function should be called to update media database.
+ *          database.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
@@ -518,11 +497,8 @@ int video_meta_set_played_position(video_meta_h video, int played_position) TIZE
  * @pre This function requires opened connection to content service by media_content_connect().
  *
  * @see media_content_connect()
- * @see video_meta_set_played_time()
- * @see video_meta_set_played_count()
- * @see video_meta_set_played_position()
  */
-int video_meta_update_to_db(video_meta_h video);
+int video_meta_update_to_db(video_meta_h video) TIZEN_DEPRECATED_API;
 
 /**
  *@}