From: Minje Ahn Date: Mon, 15 May 2017 00:45:40 +0000 (+0900) Subject: [ACR] Deprecate APIs that are difficult to use publicly X-Git-Tag: accepted/tizen/unified/20170531.082631^0 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=f7f440446f5532f150851f6292fee3bfa721de0a;p=platform%2Fcore%2Fapi%2Fmedia-content.git [ACR] Deprecate APIs that are difficult to use publicly Change-Id: I6d61ff54862bc324a0e96d325431d12545237aba Signed-off-by: Minje Ahn --- diff --git a/include/media_audio.h b/include/media_audio.h index ff80926..6e25593 100755 --- a/include/media_audio.h +++ b/include/media_audio.h @@ -376,7 +376,8 @@ int audio_meta_get_channel(audio_meta_h audio, int *channel); int audio_meta_get_duration(audio_meta_h audio, int *duration); /** - * @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 number of times the given audio has been played. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -393,7 +394,8 @@ int audio_meta_get_duration(audio_meta_h audio, int *duration); int audio_meta_get_played_count(audio_meta_h audio, 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 audio. * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif @@ -411,7 +413,8 @@ int audio_meta_get_played_count(audio_meta_h audio, int *played_count) TIZEN_DEP int audio_meta_get_played_time(audio_meta_h audio, 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 audio. * @details This function returns the elapsed playback position parameter of the audio as a period * starting from the beginning of the track. @@ -431,7 +434,8 @@ int audio_meta_get_played_time(audio_meta_h audio, time_t *played_time) TIZEN_DE int audio_meta_get_played_position(audio_meta_h audio, 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 audio. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -444,13 +448,12 @@ int audio_meta_get_played_position(audio_meta_h audio, 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 audio_meta_update_to_db(). */ int audio_meta_set_played_count(audio_meta_h audio, 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 audio. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -463,13 +466,12 @@ int audio_meta_set_played_count(audio_meta_h audio, 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 audio_meta_update_to_db(). */ int audio_meta_set_played_time(audio_meta_h audio, 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 audio. * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif @@ -485,15 +487,14 @@ int audio_meta_set_played_time(audio_meta_h audio, 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 audio_meta_update_to_db(). */ int audio_meta_set_played_position(audio_meta_h audio, 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 audio metadata with modified attributes in the media database. * @details The function updates the given audio meta in the media database. The function should be called after any change in audio attributes, to be updated to the media - * database. For example, for setting the played time using audio_meta_get_played_time(), after that the audio_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 * @@ -519,11 +520,8 @@ int audio_meta_set_played_position(audio_meta_h audio, int played_position) TIZE * @pre This function requires opened connection to content service by media_content_connect(). * * @see media_content_connect() - * @see audio_meta_set_played_time() - * @see audio_meta_set_played_count() - * @see audio_meta_set_played_position() */ -int audio_meta_update_to_db(audio_meta_h audio); +int audio_meta_update_to_db(audio_meta_h audio) TIZEN_DEPRECATED_API; /** *@} diff --git a/include/media_content.h b/include/media_content.h index 2b6525c..4c3bc14 100755 --- a/include/media_content.h +++ b/include/media_content.h @@ -124,6 +124,13 @@ int media_content_scan_file(const char *path); * media_scan_completed_cb() function will be called when the scanning is finished. * The sub folders are also scanned, if there are sub folders in that folder. \n * If any folder must not be scanned, a blank file ".scan_ignore" has to be created in that folder. + * After adding or removing a folder from the filesystem, call this function on its source location + * (this will add or remove an entry from the database). \n + * After moving or renaming a folder in the filesystem, call this function on its source location + * (this will remove an entry from the database) and call this function again on its destination location + * (this will add a new entry to the database).\n + * Alternatively, you can call this API on any parent of source location and on any parent of destination location.\n + * You can also call the function once, on a folder which is a parent of both source and destination.\n * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * diff --git a/include/media_content_type.h b/include/media_content_type.h index 90d3a36..7dfc764 100755 --- a/include/media_content_type.h +++ b/include/media_content_type.h @@ -175,11 +175,11 @@ typedef enum { MEDIA_CONTENT_GROUP_RATING, /**< Media group ID for a rating*/ MEDIA_CONTENT_GROUP_AUTHOR, /**< Media group ID for an author*/ MEDIA_CONTENT_GROUP_PROVIDER, /**< Media group ID for a provider*/ - MEDIA_CONTENT_GROUP_CONTENT_NAME, /**< Media group ID for the content name*/ + MEDIA_CONTENT_GROUP_CONTENT_NAME, /**< Media group ID for the content name (Deprecated since 4.0)*/ MEDIA_CONTENT_GROUP_CATEGORY, /**< Media group ID for a category*/ MEDIA_CONTENT_GROUP_LOCATION_TAG, /**< Media group ID for a location tag*/ MEDIA_CONTENT_GROUP_AGE_RATING, /**< Media group ID for an age rating*/ - MEDIA_CONTENT_GROUP_KEYWORD, /**< Media group ID for a keyword*/ + MEDIA_CONTENT_GROUP_KEYWORD, /**< Media group ID for a keyword (Deprecated since 4.0)*/ MEDIA_CONTENT_GROUP_WEATHER, /**< Media group ID for the weather*/ MEDIA_CONTENT_GROUP_MAX /**< Invalid media group ID*/ } media_group_e; @@ -893,6 +893,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data); #define MEDIA_BURST_ID "BURST_ID" /**< Media burst ID*/ /** + * @deprecated Deprecated since 4.0. * @brief You can use above define to set the condition of media filter and order keyword. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -900,6 +901,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data); #define MEDIA_PLAYED_COUNT "MEDIA_PLAYED_COUNT" /**< Media playedcount*/ /** + * @deprecated Deprecated since 4.0. * @brief You can use above define to set the condition of media filter and order keyword. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -907,6 +909,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data); #define MEDIA_LAST_PLAYED_TIME "MEDIA_LAST_PLAYED_TIME" /**< Media last played time*/ /** + * @deprecated Deprecated since 4.0. * @brief You can use above define to set the condition of media filter and order keyword. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -942,6 +945,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data); #define MEDIA_PROVIDER "MEDIA_PROVIDER" /**< Media provider*/ /** + * @deprecated Deprecated since 4.0. * @brief You can use above define to set the condition of media filter and order keyword. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -970,6 +974,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data); #define MEDIA_AGE_RATING "MEDIA_AGE_RATING" /**< Media age rating*/ /** + * @deprecated Deprecated since 4.0. * @brief You can use above define to set the condition of media filter and order keyword. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -1103,6 +1108,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data); #define MEDIA_PROVIDER_PINYIN "MEDIA_PROVIDER_PINYIN" /**< Media provider pinyin*/ /** + * @deprecated Deprecated since 4.0. * @brief You can use above define to set the condition of media filter and order keyword. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -1131,6 +1137,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data); #define MEDIA_AGE_RATING_PINYIN "MEDIA_AGE_RATING_PINYIN" /**< Media age rating pinyin*/ /** + * @deprecated Deprecated since 4.0. * @brief You can use above define to set the condition of media filter and order keyword. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -1191,6 +1198,7 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data); #define FOLDER_NAME_PINYIN "FOLDER_NAME_PINYIN" /**< Folder base name pinyin*/ /** + * @deprecated Deprecated since 4.0. * @brief You can use above define to set the condition of folder filter and order keyword. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif */ diff --git a/include/media_folder.h b/include/media_folder.h index 582119b..c918c65 100755 --- a/include/media_folder.h +++ b/include/media_folder.h @@ -335,6 +335,9 @@ int media_folder_get_storage_type(media_folder_h folder, media_content_storage_e int media_folder_get_storage_id(media_folder_h folder, char **storage_id); /** + * @deprecated Deprecated since 4.0. \n + * This function does not guarantee order independence between applications. It is recommended that the viewing order is managed by the application. + * * @brief Gets the folder viewing order. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * @@ -351,7 +354,7 @@ int media_folder_get_storage_id(media_folder_h folder, char **storage_id); * * @post media_folder_update_to_db() */ -int media_folder_get_order(media_folder_h folder, int *order); +int media_folder_get_order(media_folder_h folder, int *order) TIZEN_DEPRECATED_API; /** * @brief Gets the media folder from the media database. @@ -381,6 +384,7 @@ int media_folder_get_order(media_folder_h folder, int *order); int media_folder_get_folder_from_db(const char *folder_id, media_folder_h *folder); /** + * @deprecated Deprecated since 4.0. Use media_content_scan_folder() or media_info_move_to_db() instead. * @brief Sets the folder name. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -394,12 +398,12 @@ int media_folder_get_folder_from_db(const char *folder_id, media_folder_h *folde * @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 - * - * @post media_folder_update_to_db() */ -int media_folder_set_name(media_folder_h folder, const char *name); +int media_folder_set_name(media_folder_h folder, const char *name) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 4.0. \n + * This function does not guarantee order independence between applications. It is recommended that the viewing order is managed by the application. * @brief Sets the folder viewing order. * @details If you set the order value for each folder, you can sort in ascending or descending order as the set order values using the filter. \n * Moreover, more detailed settings are possible when used with the filter. \n @@ -418,17 +422,15 @@ int media_folder_set_name(media_folder_h folder, const char *name); * @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 - * - * @post media_folder_update_to_db() */ -int media_folder_set_order(media_folder_h folder, int order); +int media_folder_set_order(media_folder_h folder, int order) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 4.0. Related setter functions are deprecated, therefore this function is not needed anymore. * @brief Updates the media folder to the media database. * * @details The function updates the given media folder in the media database. The function should be called after any change in folder attributes, to be updated to the media - * database. For example, after using media_folder_set_name() for setting the name of the folder, the media_folder_update_to_db() function should be called so as to update - * the given folder attributes in the media database. + * database. * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -450,13 +452,11 @@ int media_folder_set_order(media_folder_h folder, int order); * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied * * @pre This function requires opened connection to content service by media_content_connect(). - * @pre If you do not set new name of folder by using media_folder_set_name(), your updating function is failed. * * @see media_content_connect() * @see media_folder_destroy() - * @see media_folder_set_name() */ -int media_folder_update_to_db(media_folder_h folder); +int media_folder_update_to_db(media_folder_h folder) TIZEN_DEPRECATED_API; /** * @} diff --git a/include/media_image.h b/include/media_image.h index 9dbd88c..6743be9 100755 --- a/include/media_image.h +++ b/include/media_image.h @@ -271,6 +271,7 @@ int image_meta_get_model(image_meta_h image, char **model); int image_meta_is_burst_shot(image_meta_h image, bool *is_burst_shot); /** + * @deprecated Deprecated since 4.0. This data cannot be saved to the file. * @brief Sets an orientation of the image. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -283,17 +284,15 @@ int image_meta_is_burst_shot(image_meta_h image, bool *is_burst_shot); * @retval #MEDIA_CONTENT_ERROR_NONE Successful * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied - * - * @post image_meta_update_to_db() */ -int image_meta_set_orientation(image_meta_h image, media_content_orientation_e orientation); +int image_meta_set_orientation(image_meta_h image, media_content_orientation_e orientation) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 4.0. Related setter functions are deprecated, therefore this function is not needed anymore. * @brief Updates the image to the media database. * - * @details The function updates the given image meta in the media database. The function should be called after any change in image attributes, to be updated to the media - * database. For example, after using image_meta_set_orientation() for setting the orientation of the image, the image_meta_update_to_db() function should be called so as to update - * the given image attributes in the media database. + * @details The function updates the given image meta in the media database. \n + * The function should be called after any change in image attributes, to be updated to the media database. * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -319,9 +318,8 @@ int image_meta_set_orientation(image_meta_h image, media_content_orientation_e o * @pre This function requires opened connection to content service by media_content_connect(). * * @see media_content_connect() - * @see image_meta_set_orientation() */ -int image_meta_update_to_db(image_meta_h image); +int image_meta_update_to_db(image_meta_h image) TIZEN_DEPRECATED_API; /** * @} diff --git a/include/media_info.h b/include/media_info.h index b5777fa..12bf5c1 100755 --- a/include/media_info.h +++ b/include/media_info.h @@ -918,6 +918,7 @@ int media_info_get_author(media_info_h media, char **author); int media_info_get_provider(media_info_h media, char **provider); /** + * @deprecated Deprecated since 4.0. Redundant, use media_info_get_display_name() instead. * @brief Gets the content name of content file which User set. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -936,7 +937,7 @@ int media_info_get_provider(media_info_h media, char **provider); * * @see media_info_set_content_name() */ -int media_info_get_content_name(media_info_h media, char **content_name); +int media_info_get_content_name(media_info_h media, char **content_name) TIZEN_DEPRECATED_API; /** * @brief Gets the title of content file. @@ -1024,6 +1025,7 @@ int media_info_get_location_tag(media_info_h media, char **location_tag); int media_info_get_age_rating(media_info_h media, char **age_rating); /** + * @deprecated Deprecated since 4.0. Use media_tag_insert_to_db() instead. * @brief Gets the keyword of content file which User set. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -1042,7 +1044,7 @@ int media_info_get_age_rating(media_info_h media, char **age_rating); * * @see media_info_set_keyword() */ -int media_info_get_keyword(media_info_h media, char **keyword); +int media_info_get_keyword(media_info_h media, char **keyword) TIZEN_DEPRECATED_API; /** * @brief Gets the storage id of content file. @@ -1113,6 +1115,8 @@ int media_info_is_360_content(media_info_h media, bool *is_360); int media_info_get_storage_type(media_info_h media, media_content_storage_e *storage_type); /** + * @deprecated Deprecated since 4.0. \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 number which represents how many times given content has been played. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * @@ -1125,9 +1129,11 @@ int media_info_get_storage_type(media_info_h media, media_content_storage_e *sto * @retval #MEDIA_CONTENT_ERROR_NONE Successful * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter */ -int media_info_get_played_count(media_info_h media, int *played_count); +int media_info_get_played_count(media_info_h media, int *played_count) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 4.0. \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 content's played time parameter. * @details Function returns content's elapsed playback time parameter as period * starting from the beginning of the track. @@ -1142,7 +1148,7 @@ int media_info_get_played_count(media_info_h media, int *played_count); * @retval #MEDIA_CONTENT_ERROR_NONE Successful * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter */ -int media_info_get_played_time(media_info_h media, time_t *played_time); +int media_info_get_played_time(media_info_h media, time_t *played_time) TIZEN_DEPRECATED_API; /** * @brief Gets the media info from the media database. @@ -1172,6 +1178,8 @@ int media_info_get_played_time(media_info_h media, time_t *played_time); int media_info_get_media_from_db(const char *media_id, media_info_h *media); /** + * @deprecated Deprecated since 4.0. \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 Increments the played count to content meta handle. * @details You can increase the played(opened) count of the content file. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -1186,9 +1194,11 @@ int media_info_get_media_from_db(const char *media_id, media_info_h *media); * * @post media_info_update_to_db() */ -int media_info_increase_played_count(media_info_h media); +int media_info_increase_played_count(media_info_h media) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 4.0. \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 played time to content meta handle. * @details You can set the latest played(opened) time of the content file. the latest played time to be set the current time on the system. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif @@ -1203,9 +1213,10 @@ int media_info_increase_played_count(media_info_h media); * * @post media_info_update_to_db() */ -int media_info_set_played_time(media_info_h media); +int media_info_set_played_time(media_info_h media) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 4.0. Redundant, use media_info_move_to_db() instead. * @brief Sets the file name including the extension of the content file. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -1223,9 +1234,10 @@ int media_info_set_played_time(media_info_h media); * @post media_info_update_to_db(). * */ -int media_info_set_display_name(media_info_h media, const char *display_name); +int media_info_set_display_name(media_info_h media, const char *display_name) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 4.0. This data cannot be saved to the file. * @brief Sets the description of media info. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -1243,9 +1255,10 @@ int media_info_set_display_name(media_info_h media, const char *display_name); * @post media_info_update_to_db(). * */ -int media_info_set_description(media_info_h media, const char *description); +int media_info_set_description(media_info_h media, const char *description) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 4.0. This data cannot be saved to the file. * @brief Sets the longitude of media info. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -1262,9 +1275,10 @@ int media_info_set_description(media_info_h media, const char *description); * * @post media_info_update_to_db(). */ -int media_info_set_longitude(media_info_h media, double longitude); +int media_info_set_longitude(media_info_h media, double longitude) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 4.0. This data cannot be saved to the file. * @brief Sets the latitude of media info. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -1281,9 +1295,10 @@ int media_info_set_longitude(media_info_h media, double longitude); * * @post media_info_update_to_db(). */ -int media_info_set_latitude(media_info_h media, double latitude); +int media_info_set_latitude(media_info_h media, double latitude) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 4.0. This data cannot be saved to the file. * @brief Sets the altitude of media info. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -1300,7 +1315,7 @@ int media_info_set_latitude(media_info_h media, double latitude); * * @post media_info_update_to_db(). */ -int media_info_set_altitude(media_info_h media, double altitude); +int media_info_set_altitude(media_info_h media, double altitude) TIZEN_DEPRECATED_API; /** * @brief Sets the weather of media info. @@ -1323,6 +1338,7 @@ int media_info_set_altitude(media_info_h media, double altitude); int media_info_set_weather(media_info_h media, const char *weather); /** + * @deprecated Deprecated since 4.0. This data cannot be saved to the file. * @brief Sets the rating of media info. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -1339,7 +1355,7 @@ int media_info_set_weather(media_info_h media, const char *weather); * * @post media_info_update_to_db(). */ -int media_info_set_rating(media_info_h media, int rating); +int media_info_set_rating(media_info_h media, int rating) TIZEN_DEPRECATED_API; /** * @brief Sets the favorite of media info. @@ -1364,6 +1380,7 @@ int media_info_set_rating(media_info_h media, int rating); int media_info_set_favorite(media_info_h media, bool favorite); /** + * @deprecated Deprecated since 4.0. This data cannot be saved to the file. * @brief Sets the author of media info. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -1378,7 +1395,7 @@ int media_info_set_favorite(media_info_h media, bool favorite); * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied */ -int media_info_set_author(media_info_h media, const char *author); +int media_info_set_author(media_info_h media, const char *author) TIZEN_DEPRECATED_API; /** * @brief Sets the provider of media info. @@ -1398,6 +1415,7 @@ int media_info_set_author(media_info_h media, const char *author); int media_info_set_provider(media_info_h media, const char *provider); /** + * @deprecated Deprecated since 4.0. Redundant, use media_info_move_to_db() instead. * @brief Sets the content name of media info. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -1414,7 +1432,7 @@ int media_info_set_provider(media_info_h media, const char *provider); * * @post media_info_update_to_db() */ -int media_info_set_content_name(media_info_h media, const char *content_name); +int media_info_set_content_name(media_info_h media, const char *content_name) TIZEN_DEPRECATED_API; /** * @brief Sets the category of media info. @@ -1474,6 +1492,7 @@ int media_info_set_location_tag(media_info_h media, const char *location_tag); int media_info_set_age_rating(media_info_h media, const char *age_rating); /** + * @deprecated Deprecated since 4.0. Use media_tag_insert_to_db() instead. * @brief Sets the keyword of media info. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -1490,7 +1509,7 @@ int media_info_set_age_rating(media_info_h media, const char *age_rating); * * @post media_info_update_to_db() */ -int media_info_set_keyword(media_info_h media, const char *keyword); +int media_info_set_keyword(media_info_h media, const char *keyword) TIZEN_DEPRECATED_API; /** * @brief Updates the media info to the media database. @@ -1502,7 +1521,7 @@ int media_info_set_keyword(media_info_h media, const char *keyword); * @privilege %http://tizen.org/privilege/content.write * * @remarks The function should be called after any change in media, to be updated to the media - * database. For example, after using media_info_set_display_name() + * database. For example, after using media_info_set_favorite() * for setting the name of the media, the media_info_update_to_db() function should be called so as to update * the given media info attributes in the media database. * @@ -1523,16 +1542,8 @@ int media_info_set_keyword(media_info_h media, const char *keyword); * @pre This function requires opened connection to content service by media_content_connect(). * * @see media_content_connect() - * @see media_info_set_display_name() - * @see media_info_set_description() - * @see media_info_set_longitude() - * @see media_info_set_latitude() - * @see media_info_set_altitude() - * @see media_info_set_rating() * @see media_info_set_favorite() - * @see media_info_set_author() * @see media_info_set_provider() - * @see media_info_set_content_name() * @see media_info_set_category() * @see media_info_set_location_tag() * @see media_info_set_age_rating() @@ -1540,6 +1551,7 @@ int media_info_set_keyword(media_info_h media, const char *keyword); int media_info_update_to_db(media_info_h media); /** + * @deprecated Deprecated since 4.0. Use media_content_scan_file() instead. * @brief Refreshes the media metadata to the media database. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -1571,9 +1583,10 @@ int media_info_update_to_db(media_info_h media); * * @see media_content_connect() */ -int media_info_refresh_metadata_to_db(const char *media_id); +int media_info_refresh_metadata_to_db(const char *media_id) TIZEN_DEPRECATED_API; /** + * @deprecated Deprecated since 4.0. This data cannot be saved to the file. * @brief Sets the added time of media info. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @@ -1590,10 +1603,12 @@ int media_info_refresh_metadata_to_db(const char *media_id); * * @post media_info_update_to_db() */ -int media_info_set_added_time(media_info_h media, time_t added_time); +int media_info_set_added_time(media_info_h media, time_t added_time) TIZEN_DEPRECATED_API; /** * @brief Moves the media info to the given destination path in the media database. + * @details After moving or renaming a file in the filesystem, call this function to update the database. + * * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * * @privlevel public @@ -1624,6 +1639,7 @@ int media_info_set_added_time(media_info_h media, time_t added_time); * @pre This function requires opened connection to content service by media_content_connect(). * * @see media_content_connect() + * @see media_content_scan_folder() */ int media_info_move_to_db(media_info_h media, const char* dst_path); @@ -1764,8 +1780,6 @@ int media_info_cancel_face_detection(media_info_h media); * @deprecated Deprecated since 4.0. Use media_info_insert_to_db() instead. * @brief Creates the media info handle. * @details If the information about the file that is already known, you can use this API to generate empty handler. -* And you can add the information to the generated handler using media_info_set_XXX() API. -* After filling the information to the handler, you can insert into database using media_info_insert_to_db_with_data() API. * @since_tizen 3.0 * * @@ -1787,7 +1801,6 @@ int media_info_cancel_face_detection(media_info_h media); * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB operation failed * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied * -* @see media_info_insert_to_db_with_data() * @see media_info_destroy() */ int media_info_create(const char *path, media_info_h *media) TIZEN_DEPRECATED_API; @@ -1795,11 +1808,9 @@ int media_info_create(const char *path, media_info_h *media) TIZEN_DEPRECATED_AP /** * @deprecated Deprecated since 4.0. Use media_info_insert_to_db() instead. * @brief Inserts media info to database with media info data. -* @details After filling the information to the generated handler using media_info_create() API, you can insert into database using this API. * @since_tizen 3.0 * -* @remarks You must create media handle using media_info_create(), -* and release @a info using media_info_destroy(). +* @remarks You must release @a info using media_info_destroy(). * * @privlevel public * @privilege %http://tizen.org/privilege/content.write @@ -1813,8 +1824,6 @@ int media_info_create(const char *path, media_info_h *media) TIZEN_DEPRECATED_AP * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB operation failed * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied -* -* @see media_info_create() */ int media_info_insert_to_db_with_data(media_info_h media) TIZEN_DEPRECATED_API; @@ -1831,8 +1840,6 @@ int media_info_insert_to_db_with_data(media_info_h media) TIZEN_DEPRECATED_API; * * @retval #MEDIA_CONTENT_ERROR_NONE Successful * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter -* -* @post media_info_insert_to_db_with_data() */ int media_info_set_title(media_info_h media, const char *title) TIZEN_DEPRECATED_API; @@ -1849,8 +1856,6 @@ int media_info_set_title(media_info_h media, const char *title) TIZEN_DEPRECATED * * @retval #MEDIA_CONTENT_ERROR_NONE Successful * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter -* -* @post media_info_insert_to_db_with_data() */ int media_info_set_album(media_info_h media, const char *album) TIZEN_DEPRECATED_API; @@ -1867,8 +1872,6 @@ int media_info_set_album(media_info_h media, const char *album) TIZEN_DEPRECATED * * @retval #MEDIA_CONTENT_ERROR_NONE Successful * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter -* -* @post media_info_insert_to_db_with_data() */ int media_info_set_artist(media_info_h media, const char *artist) TIZEN_DEPRECATED_API; @@ -1885,8 +1888,6 @@ int media_info_set_artist(media_info_h media, const char *artist) TIZEN_DEPRECAT * * @retval #MEDIA_CONTENT_ERROR_NONE Successful * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter -* -* @post media_info_insert_to_db_with_data() */ int media_info_set_genre(media_info_h media, const char *genre) TIZEN_DEPRECATED_API; @@ -1903,8 +1904,6 @@ int media_info_set_genre(media_info_h media, const char *genre) TIZEN_DEPRECATED * * @retval #MEDIA_CONTENT_ERROR_NONE Successful * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter -* -* @post media_info_insert_to_db_with_data() */ int media_info_set_recorded_date(media_info_h media, const char *recorded_date) TIZEN_DEPRECATED_API; diff --git a/include/media_video.h b/include/media_video.h index 9d8da34..59041ac 100755 --- a/include/media_video.h +++ b/include/media_video.h @@ -376,7 +376,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 * @@ -393,7 +394,8 @@ int video_meta_get_rotation(video_meta_h video, int *rotation); 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 * @@ -410,7 +412,8 @@ int video_meta_get_played_count(video_meta_h video, int *played_count) TIZEN_DEP 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. @@ -430,7 +433,8 @@ int video_meta_get_played_time(video_meta_h video, time_t *played_time) TIZEN_DE 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 * @@ -443,13 +447,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 * @@ -462,13 +465,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 @@ -484,15 +486,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 +519,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; /** *@}