*/
-
-#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>
extern "C" {
#endif /* __cplusplus */
+/**
+ * @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, etc.
+ */
/**
* @addtogroup CAPI_CONTENT_MEDIA_VIDEO_META_MODULE
*/
/**
- * @brief Clones video metadata.
- * @details This function copies the video metadata handle from a source to
- * destination.
-
- * @remark The destination handle must be released with video_meta_destroy() by you.
+ * @brief Clones the video metadata.
+ * @details This function copies the video metadata handle from a source to destination.
+ *
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ *
+ * @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
+ *
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- * @param [out] dst A destination handle to video metadata
- * @param [in] src The source handle to video metadata
- * @return 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
+ *
* @see video_meta_destroy()
*/
int video_meta_clone(video_meta_h *dst, video_meta_h src);
/**
- * @brief Destroys video metadata.
- * @details Function frees all resources related to video metadata handle. This handle
- * no longer can be used to perform any operation. A new handle has to
- * be created before the next use.
+ * @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 operations. A new handle has to
+ * be created before the next use.
*
- * @param [in] video The handle to video metadata
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ *
+ * @param[in] video The handle to 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
- * @pre Get copy of video metadata handle by calling video_meta_clone()
- * @see video_meta_clone()
*
+ * @pre Get copy of video metadata handle by calling video_meta_clone().
+ *
+ * @see video_meta_clone()
*/
int video_meta_destroy(video_meta_h video);
/**
- * @brief Gets id of media of given video metadata.
+ * @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 @a media id must be released with free() by you.
+ * @remarks The @a media_id should be released using free().
*
- * @param [in] video The handle to video metadata
- * @param [out] media_id The id of the video
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @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
+ *
+ * @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_OUT_OF_MEMORY Out of memory
*/
int video_meta_get_media_id(video_meta_h video, char **media_id);
/**
- * @brief Gets the video's title.
+ * @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.
*
- * @remarks @a title must be released with free() by you.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param [in] video The handle to video metadata
- * @param [out] title The title of video metadata
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @remarks The @a album should be released using free().
+ *
+ * @param[in] video The handle to the video metadata
+ * @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_OUT_OF_MEMORY Out of memory
*/
-int video_meta_get_title(video_meta_h video, char **title);
+int video_meta_get_album(video_meta_h video, char **album);
/**
- * @brief Gets the video's album.
- * 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.
*
- * @remarks @a album must be released with free() by you.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param [in] video The handle to video metadata
- * @param [out] album The video album or NULL
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @remarks The @a artist should be released using free().
+ *
+ * @param[in] video The handle to the video metadata
+ * @param[out] artist The 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
+ * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
*/
-int video_meta_get_album(video_meta_h video, char **album);
+int video_meta_get_artist(video_meta_h video, char **artist);
/**
- * @brief Gets the video's artist.
- * If the value is an empty string, the method returns "Unknown".
+ * @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.
*
- * @remarks @a artist must be released with free() by you.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param [in] video The handle to video metadata
- * @param [out] artist The artist of video metadata
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @remarks The @a album_artist should be released using free().
+ *
+ * @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,
+ * 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_OUT_OF_MEMORY Out of memory
*/
-int video_meta_get_artist(video_meta_h video, char **artist);
+int video_meta_get_album_artist(video_meta_h video, char **album_artist);
/**
- * @brief Gets the video's genre.
- * 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.
*
- * @remarks @a genre must be released with free() by you.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param [in] video The handle to video metadata
- * @param [out] genre The genre of video metadata
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @remarks The @a genre should be released using free().
+ *
+ * @param[in] video The handle to the video metadata
+ * @param[out] genre The genre 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_OUT_OF_MEMORY Out of memory
*/
int video_meta_get_genre(video_meta_h video, char **genre);
/**
- * @brief Gets the video's composer.
- * 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.
*
- * @remarks @a composer must be released with free() by you.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param [in] video The handle to video metadata
- * @param [out] composer The composer of video metadata
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @remarks The @a composer should be released using free().
+ *
+ * @param[in] video The handle to the video metadata
+ * @param[out] composer The composer 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_OUT_OF_MEMORY Out of memory
*/
int video_meta_get_composer(video_meta_h video, char **composer);
/**
- * @brief Gets the video's year.
- * 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.
*
- * @remarks @a year must be released with free() by you.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param [in] video The handle to video metadata
- * @param [out] year The year of video metadata
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @remarks The @a year should be released using free().
+ *
+ * @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
+ *
+ * @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_OUT_OF_MEMORY Out of memory
*/
int video_meta_get_year(video_meta_h video, char **year);
/**
- * @brief Gets the video's recorded_date.
+ * @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.
*
- * @remarks @a recorded_date must be released with free() by you.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param [in] video The handle to video metadata
- * @param [out] recorded_date The recorded_date of video metadata
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @remarks The @a recorded_date should be released using free().
+ *
+ * @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,
+ * 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_OUT_OF_MEMORY Out of memory
*/
int video_meta_get_recorded_date(video_meta_h video, char **recorded_date);
/**
- * @brief Gets the video's copyright.
+ * @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.
*
- * @remarks @a copyright must be released with free() by you.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param [in] video The handle to video metadata
- * @param [out] copyright The copyright of video metadata
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @remarks The @a copyright should be released using free().
+ *
+ * @param[in] video The handle to the video metadata
+ * @param[out] copyright The copyright 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_OUT_OF_MEMORY Out of memory
*/
int video_meta_get_copyright(video_meta_h video, char **copyright);
/**
- * @brief Gets the video's track number.
- * 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.
*
- * @remarks @a track_num must be released with free() by you.
+ * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param [in] video The handle to video metadata
- * @param [out] track_num The track number of video metadata
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @remarks The @a track_num should be released using free().
+ *
+ * @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,
+ * 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_OUT_OF_MEMORY Out of memory
*/
int video_meta_get_track_num(video_meta_h video, char **track_num);
/**
- * @brief Gets the video's bit rate.
+ * @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
*
- * @remarks @a bit_rate must be released with free() by you.
+ * @param[in] video The handle to the video metadata
+ * @param[out] bit_rate The video bit rate in bit per second [bps]
*
- * @param [in] video The handle to video metadata
- * @param [out] bit_rate The bit rate of video metadata
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @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_bit_rate(video_meta_h video, int *bit_rate);
/**
- * @brief Gets duration of video metadata.
+ * @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 handle to video metadata
- * @param [out] duration The video duration in milliseconds
- * @return 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_duration(video_meta_h video, int *duration);
-
-/**
- * @brief Gets the video's width in pixels.
+ * @param[in] video The handle to the video metadata
+ * @param[out] duration The video duration in milliseconds
*
- * @param [in] video The handle to video metadata
- * @param [out] width The video width in pixels
- * @return 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_width(video_meta_h video, int *width);
-
-/**
- * @brief Gets the video's height in pixels.
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- * @param [in] video The handle to video metadata
- * @param [out] height The video height in pixels
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*/
-int video_meta_get_height(video_meta_h video, int *height);
+int video_meta_get_duration(video_meta_h video, int *duration);
/**
- * @brief Gets the video's played count.
+ * @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 handle to video metadata
- * @param [out] played_count The number of played
- * @return 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_played_count(video_meta_h video, int *played_count);
-
-/**
- * @brief Gets the video's time last played parameter.
+ * @param[in] video The handle to the video metadata
+ * @param[out] width The video width in pixels
*
- * @param [in] video The handle to video metadata
- * @param [out] played_time The time last played in the video
- * @return 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_played_time(video_meta_h video, time_t *played_time);
-
-/**
- * @brief Gets the video's position played parameter.
- * @details Function returns video's elapsed playback time parameter as period
- * starting from the beginning of the movie.
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- * @param [in] video The handle to video metadata
- * @param [out] played_position The position from the beginning of the video (in milliseconds)
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*/
-int video_meta_get_played_position(video_meta_h video, int *played_position);
+int video_meta_get_width(video_meta_h video, int *width);
/**
- * @brief Sets the video's played count.
+ * @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 handle to video metadata
- * @param [in] played_count The number of played
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @post video_meta_update_to_db()
- */
-int video_meta_set_played_count(video_meta_h video, int played_count);
-
-/**
- * @brief Sets the video's time last played parameter.
+ * @param[in] video The handle to the video metadata
+ * @param[out] height The video height in pixels
*
- * @param [in] video The handle to video metadata
- * @param [in] played_time The time last played in the video
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @post video_meta_update_to_db()
- */
-int video_meta_set_played_time(video_meta_h video, time_t played_time);
-
-/**
- * @brief Sets the video's position played parameter.
- * @details Function returns video's elapsed playback time parameter as period
- * starting from the beginning of the movie.
+ * @return @c 0 on success,
+ * otherwise a negative error value
*
- * @param [in] video The handle to video metadata
- * @param [in] played_position The position from the beginning of the video (in milliseconds)
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @post video_meta_update_to_db()
*/
-int video_meta_set_played_position(video_meta_h video, int played_position);
+int video_meta_get_height(video_meta_h video, int *height);
/**
- * @brief Updates the video to the media database.
+ * @brief Gets the rotation of the given video metadata.
+ * @since_tizen 4.0
*
- * @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, video_meta_update_to_db() function should be called so as to update
- * the given video attibutes in the media database.
+ * @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)
*
- * @param[in] image The handle to image
- * @return 0 on success, otherwise a negative error value.
- * @retval #MEDIA_CONTENT_ERROR_NONE Successful
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ *
+ * @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @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_get_rotation(video_meta_h video, int *rotation);
/**
*@}
#ifdef __cplusplus
}
#endif /* __cplusplus */
-#endif /*__TIZEN_VIDEO_META_H__*/
+
+#endif /*__TIZEN_CONTENT_MEDIA_VIDEO_H__*/
projects / platform / core / api / media-content.git / blobdiff