Update API version description 81/63081/1
authorMinje Ahn <minje.ahn@samsung.com>
Tue, 22 Mar 2016 05:13:37 +0000 (14:13 +0900)
committerMinje Ahn <minje.ahn@samsung.com>
Tue, 22 Mar 2016 05:13:37 +0000 (14:13 +0900)
Change-Id: Ia06f383a66aa04ce3bc75b69b7fa1191ed8ce325
Signed-off-by: Minje Ahn <minje.ahn@samsung.com>
include/media_content.h
include/media_content_internal.h
include/media_content_type.h
include/media_filter.h
include/media_folder.h
include/media_image.h
include/media_info.h
include/media_playlist.h
include/media_storage.h

index 71fd8c7..7a9adea 100755 (executable)
@@ -155,7 +155,7 @@ int media_content_scan_folder(const char *path, bool is_recursive, media_scan_co
 
 /**
  * @brief Requests to cancel the media folder scanning.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @param[in] path         The folder path
  *
index e675b5c..9c39be6 100755 (executable)
@@ -35,7 +35,7 @@ extern "C" {
 /**
  * @ingroup CAPI_MEDIA_CONTENT_MODULE
  * @brief Enumeration for a media storage scan status.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
 typedef enum{
        MEDIA_STORAGE_SCAN_NONE = 0,                            /**< Media Scanner not detect storage yet*/
@@ -51,7 +51,7 @@ typedef enum{
 /**
 * @internal
 * @brief Insert media storage to database.
-* @since_tizen 2.4
+* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 *
 * @remarks You must release @a storage using media_storage_destroy().
 *
@@ -79,7 +79,7 @@ int media_storage_insert_to_db(const char *storage_name, const char *storage_pat
 /**
 * @internal
 * @brief Deletes the database for media storage.
-* @since_tizen 2.4
+* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 *
 * @privlevel platform
 * @privilege %http://tizen.org/privilege/content.write
@@ -100,7 +100,7 @@ int media_storage_delete_from_db(const char *storage_id);
 
 /**
  * @brief Gets the storage account of media storage.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @remarks You must release @a storage_account using free().
  *
@@ -119,7 +119,7 @@ int media_storage_get_storage_account(media_storage_h storage, char **storage_ac
 /**
 * @internal
 * @brief Sets the MIME type of media info handle.
-* @since_tizen 2.4
+* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 *
 * @param[in] media The media info handle
 * @param[in] mime_type The MIME type of the media info
@@ -139,7 +139,7 @@ int media_info_set_mime_type(media_info_h media, const char *mime_type);
 /**
 * @internal
 * @brief Sets the thumbnail path of media info handle.
-* @since_tizen 2.4
+* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 *
 * @param[in] media The media info handle
 * @param[in] thumbnail_path The thumbnail path of media info handle
@@ -159,7 +159,7 @@ int media_info_set_thumbnail_path(media_info_h media, const char *thumbnail_path
 /**
 * @internal
 * @brief Sets the size of media info handle.
-* @since_tizen 2.4
+* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 *
 * @param[in] media The media info handle
 * @param[in] size The size of media info handle
@@ -179,7 +179,7 @@ int media_info_set_size(media_info_h media, unsigned long long size);
 /**
 * @internal
 * @brief Sets the modified time of media info handle.
-* @since_tizen 2.4
+* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 *
 * @param[in] media The media info handle
 * @param[in] modified_time The modified time of media info handle
@@ -199,7 +199,7 @@ int media_info_set_modified_time(media_info_h media, time_t modified_time);
 /**
 * @internal
 * @brief Sets the media type of media info handle.
-* @since_tizen 2.4
+* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 *
 * @param[in] media The media info handle
 * @param[in] type The media type of media info handle
@@ -219,7 +219,7 @@ int media_info_set_media_type(media_info_h media, media_content_type_e type);
 /**
 * @internal
 * @brief Sets the duration of media info handle.
-* @since_tizen 2.4
+* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 *
 * @param[in] media The media info handle
 * @param[in] duration The duration of media info handle
@@ -239,7 +239,7 @@ int media_info_set_duration(media_info_h media, int duration);
 /**
 * @internal
 * @brief Sets the width of media info handle.
-* @since_tizen 2.4
+* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 *
 * @param[in] media The media info handle
 * @param[in] width The width of media info handle
@@ -259,7 +259,7 @@ int media_info_set_width(media_info_h media, int width);
 /**
 * @internal
 * @brief Sets the height of media info handle.
-* @since_tizen 2.4
+* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 *
 * @param[in] media The media info handle
 * @param[in] height The height of media info handle
@@ -279,7 +279,7 @@ int media_info_set_height(media_info_h media, int height);
 /**
 * @internal
 * @brief Sets the storage type of media info handle.
-* @since_tizen 2.4
+* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 *
 * @param[in] media The media info handle
 * @param[in] storage_type The storage type of media info handle
@@ -299,7 +299,7 @@ int media_info_set_storage_type(media_info_h media, media_content_storage_e stor
 /**
 * @internal
 * @brief Sets the storage type of media info handle.
-* @since_tizen 2.4
+* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 *
 * @param[in] media The media info handle
 * @param[in] storage_id The storage id of media info handle
@@ -318,7 +318,7 @@ int media_info_set_storage_id(media_info_h media, const char *storage_id);
 
 /**
  * @brief Gets the storage scan status of media storage.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @param[in]  storage The media storage handle
  * @param[out] scan_status  The storage type of the media storage
@@ -336,7 +336,7 @@ int media_storage_get_scan_status(const char *storage_uuid, media_storage_scan_s
  * @details This function subscribes notifications of the media DB change which are published by the media server or other apps.
  *          media_content_db_update_cb() function will be called when notification of the media DB change is subscribed.
  *
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @param[in] callback  The callback to be invoked when the scanning is finished
  * @param[in] user_data The user data to be passed to the callback function
@@ -360,7 +360,7 @@ int media_content_set_db_updated_cb_v2(media_content_noti_h *noti_handle, media_
  * @brief Unsubscribes notifications of the media DB change.
  * @details This function unsubscribes notifications of the media DB change which are published by the media server or other apps.
  *
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
index a91f2a4..57850c4 100755 (executable)
@@ -260,7 +260,7 @@ typedef struct filter_s *filter_h;
 /**
  * @ingroup CAPI_CONTENT_MEDIA_STORAGE_MODULE
  * @brief The structure type for the Media storage handle.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
 typedef void *media_storage_h;
 
@@ -556,7 +556,7 @@ typedef bool (*media_group_cb)(const char *group_name, void *user_data);
 /**
  * @ingroup CAPI_CONTENT_MEDIA_STORAGE_MODULE
  * @brief Called for every storage in the obtained list of storages.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @details Iterates over a media storage list.
  *
@@ -950,28 +950,28 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 
 /**
  * @brief You can use above define to set the condition of media filter and order keyword.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  */
 #define MEDIA_EXPOSURE_TIME "MEDIA_EXPOSURE_TIME"      /**< media exposure_time*/
 
 /**
  * @brief You can use above define to set the condition of media filter and order keyword.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  */
 #define MEDIA_FNUMBER "MEDIA_FNUMBER"  /**< media fnumber*/
 
 /**
  * @brief You can use above define to set the condition of media filter and order keyword.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  */
 #define MEDIA_ISO "MEDIA_ISO"  /**< media iso*/
 
 /**
  * @brief You can use above define to set the condition of media filter and order keyword.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  */
 #define MEDIA_MODEL "MEDIA_MODEL"      /**< media model*/
@@ -1136,13 +1136,13 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
 
 /**
  * @brief You can use above define to set the condition of folder filter and order keyword.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
 #define FOLDER_ORDER "FOLDER_ORDER"  /**< Folder order info */
 
 /**
  * @brief You can use above define to set the condition of folder filter and order keyword.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
 #define FOLDER_PARENT_FOLDER_ID "FOLDER_PARENT_FOLDER_ID"      /**< parent folder id */
 
@@ -1208,13 +1208,13 @@ typedef bool (*media_face_cb)(media_face_h face, void *user_data);
  * @addtogroup CAPI_CONTENT_MEDIA_STORAGE_MODULE
  * @{
  * @brief You can use above define to set the condition of storage filter and order keyword.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
 #define MEDIA_STORAGE_ID                                       "STORAGE_ID"  /**< Storage ID */
 
 /**
  * @brief You can use above define to set the condition of storage filter and order keyword.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  */
 #define MEDIA_STORAGE_PATH                             "STORAGE_PATH"  /**< Storage path */
 
index 528727c..7940d0d 100755 (executable)
@@ -152,7 +152,7 @@ int media_filter_set_order(filter_h filter, media_content_order_e order_type, co
  * @brief Sets the @a storage id for the given @a filter.
  * @details You can use this API when you want to search items only in the specific storage
  *
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @param[in] filter       The handle to the media filter
  * @param[in] storage_id    The storage_id for browsing or searching
@@ -238,7 +238,7 @@ int media_filter_get_order(filter_h filter, media_content_order_e* order_type, c
 
 /**
  * @brief Get the @a storage id for given @a filter.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @remarks You must release @a storage_id using free().
  *
index 313f54a..582119b 100755 (executable)
@@ -229,7 +229,7 @@ int media_folder_get_folder_id(media_folder_h folder, char **folder_id);
 
 /**
  * @brief Gets the parent folder ID.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @remarks You must release @a parent_folder_id using free().
  *
@@ -317,7 +317,7 @@ int media_folder_get_storage_type(media_folder_h folder, media_content_storage_e
 
 /**
  * @brief Gets the storage id of the folder.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @remarks You must release @a storage_id using free().
  *
@@ -336,7 +336,7 @@ int media_folder_get_storage_id(media_folder_h folder, char **storage_id);
 
 /**
  * @brief Gets the folder viewing order.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @param[in] folder The handle to the media folder
  * @param[out] order   The viewing order of the media folder
@@ -404,7 +404,7 @@ int media_folder_set_name(media_folder_h folder, const char *name);
  * @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
  *
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @remarks  If you don't set the order value, the order value will be set default value. Default is 0. \n
  *                    If you don't use the filter, the set order value does not effect the folder viewing order.
  *
index a97524e..a253b81 100755 (executable)
@@ -183,7 +183,7 @@ int image_meta_get_burst_id(image_meta_h image, char **burst_id);
 
 /**
  * @brief Gets the exposure time from exif.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @remarks @a exposure time must be released with free() by you.
  *
@@ -202,7 +202,7 @@ int image_meta_get_exposure_time(image_meta_h image, char **exposure_time);
 
 /**
  * @brief Gets the fnumber from exif.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @param[in] media The handle toimage metadata
  * @param[out] fnumber The value of fnumber, getting from exif
@@ -219,7 +219,7 @@ int image_meta_get_fnumber(image_meta_h image, double *fnumber);
 
 /**
  * @brief Gets the iso from exif.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @param[in] media The handle toimage metadata
  * @param[out] iso The value of iso, getting from exif
@@ -236,7 +236,7 @@ int image_meta_get_iso(image_meta_h image, int *iso);
 
 /**
  * @brief Gets the model from exif.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @remarks @a model must be released with free() by you.
  *
index 5e77a8f..8a5a56e 100755 (executable)
@@ -1005,7 +1005,7 @@ int media_info_get_keyword(media_info_h media, char **keyword);
 
 /**
  * @brief Gets the storage id of media info.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @remarks You must release @a storage_id using free().
  *
@@ -1057,7 +1057,7 @@ int media_info_get_storage_type(media_info_h media, media_content_storage_e *sto
 
 /**
  * @brief Gets number which represents how many times given content has been played.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @param [in] media The handle to media info
  * @param [out] count_played The counter of content played
@@ -1074,7 +1074,7 @@ int media_info_get_played_count(media_info_h media, int *played_count);
  * @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.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @param [in] media The handle to media info
  * @param [out] played_time The elapsed time of the content
@@ -1117,7 +1117,7 @@ int media_info_get_media_from_db(const char *media_id, media_info_h *media);
 /**
  * @brief Increments the played count to content meta handle.
  * @detalis You can increase the played(opened) count of the media file.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @param [in] media The handle to media info
  *
@@ -1134,7 +1134,7 @@ int media_info_increase_played_count(media_info_h media);
 /**
  * @brief Sets the played time to content meta handle.
  * @detalis You can set the latest played(opened) time of the media file. the latest played time to be set the current time on the system.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @param [in] media The handle to media info
  *
index fd4d9bb..cee1702 100755 (executable)
@@ -502,7 +502,7 @@ int media_playlist_update_to_db(media_playlist_h playlist);
 /**
  * @brief Imports the playlist from m3u playlist file.
  * @details This api reads a playlist from the m3u playlist file and insert into the db.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @privlevel public
  * @privilege %http://tizen.org/privilege/content.write
@@ -531,7 +531,7 @@ int media_playlist_import_from_file(const char *playlist_name, const char *path,
 
 /**
  * @brief Exports the playlist to m3u playlist file.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @remarks   http://tizen.org/privilege/mediastorage is needed if input or output path are relevant to media storage. \n
  *                     http://tizen.org/privilege/externalstorage is needed if input or output path are relevant to external storage. \n
index b202612..1be8292 100755 (executable)
@@ -39,7 +39,7 @@ extern "C" {
 
 /**
 * @brief Gets media storage from database.
-* @since_tizen 2.4
+* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 *
 * @remarks You must release the handle using media_storage_destroy(). \n
 *
@@ -65,7 +65,7 @@ int media_storage_get_storage_info_from_db(const char *storage_id, media_storage
 
 /**
 * @brief Gets the count of media storage for the passed @a filter from the media database.
-* @since_tizen 2.4
+* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
 *
 * @param[in] filter The handle to filter
 * @param[out] storage_count The count of storage
@@ -92,7 +92,7 @@ int media_storage_get_storage_count_from_db(filter_h filter, int *storage_count)
  *          The @a callback function will be invoked for every retrieved media storage.
  *          If @c NULL is passed to the @a filter, then no filtering is applied.
  *
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @param[in] filter    The media storage handle filter
  * @param[in] callback  The callback function to be invoked
@@ -118,7 +118,7 @@ int media_storage_foreach_storage_from_db(filter_h filter, media_storage_cb call
 
 /**
  * @brief Gets the count of media files for the passed @a filter in the given @a storage from the media database.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @param[in] storage_id    The ID of the media storage
  * @param[in] filter       The filter of the media content
@@ -145,7 +145,7 @@ int media_storage_get_media_count_from_db(const char *storage_id, filter_h filte
  *          meeting desired filter option and calls registered callback function for
  *          every retrieved media item. If @c NULL is passed to the @a filter, no filtering is applied.
  *
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @remarks   Do not call updating DB function like media_info_update_to_db(), media_info_refresh_metadata_to_db(), audio_meta_update_to_db(), image_meta_update_to_db() and video_meta_update_to_db()  in your callback function,
  *                    your callback function is invoked as inline function. \n
@@ -182,7 +182,7 @@ int media_storage_foreach_media_from_db(const char *storage_id, filter_h filter,
  *          can no longer be used to perform any operation. New media storage handle has to
  *          be created before the next usage.
  *
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @param[in]  storage  The media storage handle
  *
@@ -206,7 +206,7 @@ int media_storage_destroy(media_storage_h storage);
  *          available through media storage foreach function such as media_storage_foreach_storage_from_db().
  *          To use this handle outside of these foreach functions, use this function.
  *
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @remarks You must release the destination handle using media_storage_destroy().
  *
@@ -228,7 +228,7 @@ int media_storage_clone(media_storage_h *dst, media_storage_h src);
 
 /**
  * @brief Gets the storage id of media storage.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @remarks You must release @a storage_id using free().
  *
@@ -246,7 +246,7 @@ int media_storage_get_id(media_storage_h storage, char **storage_id);
 
 /**
  * @brief Gets the storage name of media storage.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @remarks You must release @a storage_name using free().
  *                   If the requested storage is not the cloud storage, this API returns NULL.
@@ -265,7 +265,7 @@ int media_storage_get_name(media_storage_h storage, char **storage_name);
 
 /**
  * @brief Gets the storage path of media storage.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @remarks You must release @a storage_path using free().
  *
@@ -283,7 +283,7 @@ int media_storage_get_path(media_storage_h storage, char **storage_path);
 
 /**
  * @brief Gets the storage type of media storage.
- * @since_tizen 2.4
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
  * @param[in]  storage The media storage handle
  * @param[out] storage_type  The storage type of the media storage