*/
-
#ifndef __TIZEN_VIDEO_META_H__
#define __TIZEN_VIDEO_META_H__
/**
* @brief Clones the video metadata.
- * @details This function copies the video metadata handle from a source to
- * destination.
+ * @details This function copies the video metadata handle from a source to destination.
*
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @remarks You must release the destination handle using video_meta_destroy().
*
* @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()
*/
* no longer can be used to perform any operation. A new handle has to
* be created before the next use.
*
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[in] video The video metadata handle
*
*
* @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().
*
/**
* @brief Gets the ID of the media of the given video metadata.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @remarks You must release @a media_id using free().
*
* @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);
/**
- * @brief Gets the video's album.
- * @details If the value is an empty string, the method returns "Unknown".
+ * @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_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @remarks You must release @a album using free().
*
* @param[in] video The video metadata handle
- * @param[out] album The video album or @c NULL
+ * @param[out] album The album of the video metadata
*
* @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
*/
int video_meta_get_album(video_meta_h video, char **album);
/**
- * @brief Gets the video artist.
- * @details If the value is an empty string, the method returns "Unknown".
+ * @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_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @remarks You must release @a artist using free().
*
* @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);
+/**
+ * @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_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ *
+ * @remarks You must release @a album_artist using free().
+ *
+ * @param[in] video The video metadata handle
+ * @param[out] album_artist The album artist of the video metadata
+ *
+ * @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
+ */
+int video_meta_get_album_artist(video_meta_h video, char **album_artist);
/**
- * @brief Gets the video genre.
- * @details If the value is an empty string, the method returns "Unknown".
+ * @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_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @remarks You must release @a genre using free().
*
* @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);
/**
- * @brief Gets the video composer.
- * @details If the value is an empty string, the method returns "Unknown".
+ * @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_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @remarks You must release @a composer using free().
*
* @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);
/**
- * @brief Gets the year of the video.
- * @details If the value is an empty string, the method returns "Unknown".
+ * @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_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @remarks You must release @a year using free().
*
* @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);
/**
* @brief Gets the recorded date of the video.
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @remarks You must release @a recorded_date using free().
*
* @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);
/**
- * @brief Gets the video copyright.
- * @since_tizen 2.3
+ * @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_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @remarks You must release @a copyright using free().
*
* @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);
/**
- * @brief Gets the track number of the video.
- * @details If the value is an empty string, the method returns "Unknown".
+ * @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_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @remarks You must release @a track_num using free().
*
* @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);
/**
- * @brief Gets the video bit rate.
- * @since_tizen 2.3
- *
- * @remarks You must release @a bit_rate using free().
+ * @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[out] bit_rate The bit rate of the video metadata
+ * @param[in] video The video metadata handle
+ * @param[out] bit_rate The video bit rate in bit per second [bps]
*
* @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
*/
int video_meta_get_bit_rate(video_meta_h video, int *bit_rate);
/**
- * @brief Gets the duration of video metadata.
- * @since_tizen 2.3
+ * @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[out] duration The video duration in milliseconds
*
* @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);
/**
- * @brief Gets the video width in pixels.
- * @since_tizen 2.3
+ * @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[out] width The video width in pixels
*
* @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);
/**
- * @brief Gets the video height in pixels.
- * @since_tizen 2.3
+ * @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[out] height The video height in pixels
*
* @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);
/**
+ * @brief Gets the rotation of the given video metadata.
+ * @since_tizen 4.0
+ *
+ * @param[in] video The video metadata handle
+ * @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,
+ * otherwise a negative error value
+ *
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
+ */
+int video_meta_get_rotation(video_meta_h video, int *rotation);
+
+/**
+ * @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 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[in] video The video metadata handle
- * @param[out] played_count The number of played
+ * @param[out] played_count The counter of the video played
*
* @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
*/
-int video_meta_get_played_count(video_meta_h video, int *played_count);
+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. \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 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[in] video The video metadata handle
- * @param[out] played_time The time last played in the video
+ * @param[out] played_time The last played time of the video
*
* @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
*/
-int video_meta_get_played_time(video_meta_h video, time_t *played_time);
+int video_meta_get_played_time(video_meta_h video, time_t *played_time) TIZEN_DEPRECATED_API;
/**
- * @brief Gets the position played parameter of the video.
- * @details This function returns the elapsed playback time parameter of the video as period
+ * @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.
*
- * @since_tizen 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[in] video The video metadata handle
- * @param[out] played_position The position from the beginning of the video (in milliseconds)
+ * @param[out] played_position The elapsed time of the video
*
* @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
*/
-int video_meta_get_played_position(video_meta_h video, int *played_position);
+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. \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 2.3
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[in] video The video metadata handle
* @param[in] played_count The number of played
*
* @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);
+int video_meta_set_played_count(video_meta_h video, int played_count) TIZEN_DEPRECATED_API;
/**
- * @brief Sets the time last played parameter of the video.
- * @since_tizen 2.3
+ * @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
*
* @param[in] video The video metadata handle
- * @param[in] played_time The time last played in the video
+ * @param[in] played_time The last played time of the video
*
* @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
- *
- * @post video_meta_update_to_db().
*/
-int video_meta_set_played_time(video_meta_h video, time_t played_time);
+int video_meta_set_played_time(video_meta_h video, time_t played_time) TIZEN_DEPRECATED_API;
/**
- * @brief Sets the position played parameter of the video.
- * @details This function returns video's elapsed playback time parameter as period
- * starting from the beginning of the movie.
+ * @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
*
- * @since_tizen 2.3
+ * @remarks It is NOT recommended to use this attribute for your application-specific purpose because this attribute can be overwritten by other applications (even 0).
*
* @param[in] video The video metadata handle
* @param[in] played_position The position from the beginning of the video (in milliseconds)
*
* @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);
+int video_meta_set_played_position(video_meta_h video, int played_position) TIZEN_DEPRECATED_API;
/**
- * @brief Updates the video to the media database.
- *
+ * @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, after using video_meta_get_played_time() for setting the played time of the video, the video_meta_update_to_db() function should be called so as to update
- * the given video attributes in the media database.
+ * 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
*
* @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()
- * @see video_meta_set_played_time()
- * @see video_meta_set_played_count()s
- * @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;
/**
*@}
#ifdef __cplusplus
}
#endif /* __cplusplus */
+
#endif /*__TIZEN_VIDEO_META_H__*/
projects / platform / core / api / media-content.git / blobdiff