*/
-#ifndef __TIZEN_AUDIO_META_H__
-#define __TIZEN_AUDIO_META_H__
+#ifndef __TIZEN_CONTENT_MEDIA_AUDIO_H__
+#define __TIZEN_CONTENT_MEDIA_AUDIO_H__
#include <media_content_type.h>
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release the destination handle using audio_meta_destroy().
+ * @remarks The @a dst should be released using audio_meta_destroy().
*
* @param[out] dst The destination handle to the audio metadata
- * @param[in] src The source handle to the audio metadata
+ * @param[in] src The source handle to the audio metadata
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the ID of the media of the given audio metadata.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a media_id using free().
+ * @remarks The @a media_id should be released using free().
*
- * @param[in] audio The audio metadata handle
- * @param[out] media_id The ID of the audio
+ * @param[in] audio The handle to the audio metadata
+ * @param[out] media_id The media ID
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a album using free().
+ * @remarks The @a album should be released using free().
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
* @param[out] album The album of the audio metadata
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a artist using free().
+ * @remarks The @a artist should be released using free().
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
* @param[out] artist The artist of the audio metadata
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a album_artist using free().
+ * @remarks The @a album_artist should be released using free().
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
* @param[out] album_artist The album artist of the audio metadata
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a genre using free().
+ * @remarks The @a genre should be released using free().
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
* @param[out] genre The genre of the audio metadata
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a composer using free().
+ * @remarks The @a composer should be released using free().
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
* @param[out] composer The composer of the audio metadata
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a year using free().
+ * @remarks The @a year should be released using free().
*
- * @param[in] audio The audio metadata handle
- * @param[out] year The year of the audio metadata
+ * @param[in] audio The handle to the audio metadata
+ * @param[out] year The year of the audio metadata
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a recorded_date using free().
+ * @remarks The @a recorded_date should be released using free().
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
* @param[out] recorded_date The recorded date of the audio metadata
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a copyright using free().
+ * @remarks The @a copyright should be released using free().
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
* @param[out] copyright The copyright of the audio metadata
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a track_num using free().
+ * @remarks The @a track_num should be released using free().
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
* @param[out] track_num The audio track number of the audio metadata
*
* @return @c 0 on success,
* @brief Gets the bitrate of the given audio metadata in bitrate per second.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
* @param[out] bit_rate The audio bitrate in bit per second [bps]
*
* @return @c 0 on success,
* @brief Gets bit per sample of the given audio metadata.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param [in] audio The handle to the audio metadata
- * @param [out] bitpersample The audio bit per sample
+ * @param[in] audio The handle to the audio metadata
+ * @param[out] bitpersample The audio bit per sample
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the sample rate of the given audio metadata.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
* @param[out] sample_rate The audio sample rate[hz]
*
* @return @c 0 on success,
* @brief Gets the channel of the given audio metadata.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
* @param[out] channel The channel of the audio
*
* @return @c 0 on success,
* @brief Gets the track duration of the given audio metadata.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
* @param[out] duration The audio file duration
*
* @return @c 0 on success,
*
* @remarks Do not call this function in callback function of foreach function like media_info_foreach_media_from_db().
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
*
* @return @c 0 on success,
* otherwise a negative error value
}
#endif /* __cplusplus */
-#endif /*__TIZEN_AUDIO_META_H__*/
+#endif /*__TIZEN_CONTENT_MEDIA_AUDIO_H__*/
-#ifndef __TIZEN_MEDIA_BOOKMARK_H__
-#define __TIZEN_MEDIA_BOOKMARK_H__
+#ifndef __TIZEN_CONTENT_MEDIA_BOOKMARK_H__
+#define __TIZEN_CONTENT_MEDIA_BOOKMARK_H__
#include <media_content_type.h>
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @param[in] media_id The media ID
- * @param[in] time The bookmark time offset (in seconds)
+ * @param[in] media_id The media ID
+ * @param[in] time The bookmark time offset (in seconds)
* @param[in] thumbnail_path The thumbnail path of video bookmark\ n
* If the media type is audio, then thumbnail is null.
*
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @param[in] bookmark_id The ID of media bookmark
+ * @param[in] bookmark_id The ID of the media bookmark
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the number of bookmarks with an optional filter from the media database.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] filter The handle to the media filter
+ * @param[in] filter The handle to the media filter
* @param[out] bookmark_count The count of the media bookmark
*
* @return @c 0 on success,
* If @c NULL is passed to the @a filter, then no filtering is applied.
* @since_tizen 4.0
*
- * @param[in] filter The handle to the bookmark filter
- * @param[in] callback The callback function to be invoked
- * @param[in] user_data The user data to be passed to the callback function
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks The destination handle must be released using media_bookmark_destroy().
+ * @remarks The @a dst should be released using media_bookmark_destroy().
*
- * @param[out] dst The destination handle to media bookmark
- * @param[in] src The source handle to media bookmark
+ * @param[out] dst The destination handle to the media bookmark
+ * @param[in] src The source handle to the media bookmark
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] bookmark The handle to media bookmark
+ * @param[in] bookmark The handle to the media bookmark
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the bookmark ID.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] bookmark The handle to media bookmark
- * @param[out] bookmark_id The media bookmark ID
+ * @param[in] bookmark The handle to the media bookmark
+ * @param[out] bookmark_id The ID of the media bookmark
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] bookmark The handle to media bookmark
+ * @param[in] bookmark The handle to the media bookmark
* @param[out] marked_time The bookmark time offset (in seconds)
*
* @return @c 0 on success,
* @brief Gets the media bookmark thumbnail.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a path using free().
+ * @remarks The @a path should be released using free().
*
- * @param[in] bookmark The handle to media bookmark
- * @param[out] path The thumbnail path of media bookmark
+ * @param[in] bookmark The handle to the media bookmark
+ * @param[out] path The thumbnail path of media bookmark
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the media bookmark name which user set.
* @since_tizen 4.0
*
- * @remarks You must release @a name using free().
+ * @remarks The @a name should be released using free().
*
- * @param[in] bookmark The handle to media bookmark
- * @param[out] name The name of media bookmark. If name was not set, empty string is returned.
+ * @param[in] bookmark The handle to the media bookmark
+ * @param[out] name The name of media bookmark. If name was not set, empty string is returned.
* If User set bookmark name to NULL, name will be empty string also.
*
* @return @c 0 on success,
* @brief Sets the media bookmark name.
* @since_tizen 4.0
*
- * @param[in] bookmark The handle to media bookmark
- * @param[in] name The name of media bookmark. Can be NULL, empty or non-empty string.
+ * @param[in] bookmark The handle to the media bookmark
+ * @param[in] name The name of media bookmark. Can be NULL, empty or non-empty string.
*
* @return @c 0 on success,
* otherwise a negative error value
* @privilege %http://tizen.org/privilege/content.write
*
* @remarks Do not call this function in callback function of foreach function like media_info_foreach_bookmark_from_db().
- * @param[in] bookmark The handle to media bookmark
+ * @param[in] bookmark The handle to the media bookmark
*
* @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_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 when Application has no privilege
+ * @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 when Application has no privilege
*
* @pre This function requires opened connection to content service by media_content_connect().
*
#ifdef __cplusplus
}
#endif /* __cplusplus */
-#endif /*__TIZEN_MEDIA_BOOKMARK_H__*/
+#endif /*__TIZEN_CONTENT_MEDIA_BOOKMARK_H__*/
* limitations under the License.
*/
-#ifndef __TIZEN_MEDIA_CONTENT_H__
-#define __TIZEN_MEDIA_CONTENT_H__
+#ifndef __TIZEN_CONTENT_MEDIA_CONTENT_H__
+#define __TIZEN_CONTENT_MEDIA_CONTENT_H__
#include <media_audio.h>
#include <media_content_type.h>
* @details This function requests to scan a media file to the media server.
* If media file is not registered to DB yet, that media file information will be added to the media DB. If it is already registered to the DB, then this tries to refresh information. \n
* If requested file does not exist on file system, information of the media file will be removed from the media DB. \n
- * If file information does not exist in DB, this API will be return #MEDIA_CONTENT_ERROR_INVALID_PARAMETER.
+ * If file information does not exist in DB, this function will be return #MEDIA_CONTENT_ERROR_INVALID_PARAMETER.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* %http://tizen.org/privilege/externalstorage
*
* @remarks You must add privilege http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path. \n
- * If you want to access only internal storage by using this API, you should add privilege http://tizen.org/privilege/mediastorage. \n
- * Or if you want to access only external storage by using this API, you should add privilege http://tizen.org/privilege/externalstorage. \n
+ * If you want to access only internal storage by using this function, you should add privilege http://tizen.org/privilege/mediastorage. \n
+ * Or if you want to access only external storage by using this function, you should add privilege http://tizen.org/privilege/externalstorage. \n
* If you can access both storage, you must add all privilege.
* @remarks Since 4.0, this function is related to the following feature:\n
* %http://tizen.org/feature/content.scanning.others\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
+ * Alternatively, you can call this function 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
* %http://tizen.org/privilege/externalstorage
*
* @remarks You must add privilege http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path. \n
- * If you want to access only internal storage by using this API, you should add privilege http://tizen.org/privilege/mediastorage. \n
- * Or if you want to access only external storage by using this API, you should add privilege http://tizen.org/privilege/externalstorage. \n
+ * If you want to access only internal storage by using this function, you should add privilege http://tizen.org/privilege/mediastorage. \n
+ * Or if you want to access only external storage by using this function, you should add privilege http://tizen.org/privilege/externalstorage. \n
* If you can access both storage, you must add all privilege.
*
- * @param[in] path The folder path
+ * @param[in] path The folder path
* @param[in] is_recursive Set @c true to scan recursively subdirectories,
* otherwise @c false to scan only the current directory
- * @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
+ * @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
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @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
*
* @pre This function requires opened connection to content service by media_content_connect().
* @see media_scan_completed_cb()
* @brief Requests to cancel the media folder scanning.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @param[in] path The folder path
+ * @param[in] path The folder path
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Subscribes notifications of the media DB change.
* @details This function subscribes notifications of the media DB change which are published by the media server or other apps. \n
* media_content_db_update_cb() function will be called when notification of the media DB change is subscribed. \n
- * Using this API, multiple callback is possible to register in one process.
+ * Using this function, multiple callback is possible to register in one process.
*
* @since_tizen 3.0
*
- * @remarks To release the registered callback, you must use media_content_remove_db_updated_cb() API. \n
- * If you set the same callback that you previously added, this API returns MEDIA_CONTENT_ERROR_INVALID_OPERATION error. \n
+ * @remarks The @a noti_handle should be released using media_content_remove_db_updated_cb(). \n
+ * If you set the same callback that you previously added, this function returns MEDIA_CONTENT_ERROR_INVALID_OPERATION error. \n
*
- * @param[in] callback The callback to be invoked when the scanning is finished
+ * @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
* @param[out] noti_handle The handle to db updated notification
*
*/
int media_content_add_db_updated_cb(media_content_db_update_cb callback, void *user_data, media_content_noti_h *noti_handle);
-
/**
- * @brief Unsubscribes notifications of the media DB change.
+ * @brief Removes 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 3.0
}
#endif /* __cplusplus */
-#endif /* __TIZEN_MEDIA_CONTENT_H__ */
+#endif /* __TIZEN_CONTENT_MEDIA_CONTENT_H__ */
-#ifndef __TIZEN_MEDIA_CONTENT_INTERNAL_H__
-#define __TIZEN_MEDIA_CONTENT_INTERNAL_H__
+#ifndef __TIZEN_CONTENT_MEDIA_CONTENT_INTERNAL_H__
+#define __TIZEN_CONTENT_MEDIA_CONTENT_INTERNAL_H__
#include <media_content_type.h>
#ifdef __cplusplus
}
#endif /* __cplusplus */
-#endif /*__TIZEN_MEDIA_CONTENT_INTERNAL_H__*/
+#endif /*__TIZEN_CONTENT_MEDIA_CONTENT_INTERNAL_H__*/
*/
-#ifndef __TIZEN_MEDIA_CONTENT_TYPE_H__
-#define __TIZEN_MEDIA_CONTENT_TYPE_H__
+#ifndef __TIZEN_CONTENT_MEDIA_CONTENT_TYPE_H__
+#define __TIZEN_CONTENT_MEDIA_CONTENT_TYPE_H__
#include <time.h>
#include <tizen.h>
typedef enum {
MEDIA_CONTENT_ORDER_ASC = 0, /**< Ascending order*/
MEDIA_CONTENT_ORDER_DESC = 1, /**< Descending order*/
- MEDIA_CONTENT_ORDER_OTHER = 2, /** order by order key**/
+ MEDIA_CONTENT_ORDER_OTHER = 2, /**< order by order key**/
} media_content_order_e;
/**
MEDIA_CONTENT_COLLATE_LOCALIZED = 3, /**< Collation LOCALIZATION, NOCASE also applied */
} media_content_collation_e;
+/**
+* @brief Error class.
+* @details Class for Media Content error
+* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+*
+*/
#define MEDIA_CONTENT_ERROR_CLASS TIZEN_ERROR_MEDIA_CONTENT
/**
/**
* @ingroup CAPI_MEDIA_CONTENT_MODULE
* @brief Called when the media scanning is finished.
+ * @details The following error codes can be received: \n
+ * #MEDIA_CONTENT_ERROR_NONE : Success \n
+ * #MEDIA_CONTENT_ERROR_INVALID_PARAMETER : Invalid parameter \n
+ * #MEDIA_CONTENT_ERROR_INVALID_OPERATION : Invalid operation \n
+ * #MEDIA_CONTENT_ERROR_PERMISSION_DENIED : Permission denied \n
+ * #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY : Out of memory \n
+ * #MEDIA_CONTENT_ERROR_DB_FAILED : DB Operation failed \n
+ * #MEDIA_CONTENT_ERROR_DB_BUSY : DB Operation busy \n
+ * #MEDIA_CONTENT_ERROR_NETWORK : Network fail \n
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks The callback is called in a separate thread(not in the main loop).
*
- * @param[in] error The error code
+ * @param[in] error The error code
* @param[in] user_data The user data passed from the foreach function
*
* @pre media_content_scan_folder().
/**
* @ingroup CAPI_MEDIA_CONTENT_MODULE
* @brief Called when the notification of the media DB change is subscribed.
+ * @details The following error codes can be received: \n
+ * #MEDIA_CONTENT_ERROR_NONE : Success \n
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @remarks The callback is called in a separate thread(not in the main loop).
*
- * @param[in] error The error code
- * @param[in] pid The PID which publishes notification
+ * @param[in] error The error code
+ * @param[in] pid The PID which publishes notification
* @param[in] update_item The update item of notification
* @param[in] update_type The update type of notification
- * @param[in] media_type The type of the media content (#media_content_type_e)
- * @param[in] uuid The UUID of media or directory, which is updated
- * @param[in] path The path of the media or directory
- * @param[in] mime_type The mime type of the media info
- * @param[in] user_data The user data passed from the foreach function
+ * @param[in] media_type The type of the media content (#media_content_type_e)
+ * @param[in] uuid The UUID of media or directory, which is updated
+ * @param[in] path The path of the media or directory
+ * @param[in] mime_type The MIME of the media info
+ * @param[in] user_data The user data passed from the foreach function
*
* @pre media_content_add_db_updated_cb().
* @see media_content_add_db_updated_cb()
* @remarks To use the @a media outside this function, copy the handle with media_info_clone() function. \n
* The callback is called in the main loop.
*
- * @param[in] media The handle to the media info
+ * @param[in] media The handle to the media info
* @param[in] user_data The user data passed from the foreach function
*
* @return @c true to continue with the next iteration of the loop,
/**
* @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
* @brief Called when media items are inserted completely.
+ * @details The following error codes can be received: \n
+ * #MEDIA_CONTENT_ERROR_NONE : Success \n
+ * #MEDIA_CONTENT_ERROR_INVALID_PARAMETER : Invalid parameter \n
+ * #MEDIA_CONTENT_ERROR_INVALID_OPERATION : Invalid operation \n
+ * #MEDIA_CONTENT_ERROR_PERMISSION_DENIED : Permission denied \n
+ * #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY : Out of memory \n
+ * #MEDIA_CONTENT_ERROR_DB_FAILED : DB Operation failed \n
+ * #MEDIA_CONTENT_ERROR_DB_BUSY : DB Operation busy \n
+ * #MEDIA_CONTENT_ERROR_NETWORK : Network fail \n
+ * #MEDIA_CONTENT_ERROR_NOT_SUPPORTED : Not supported \n
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @remarks The callback is called in a separate thread(not in the main loop).
*
- * @param[in] media The handle to the media info
+ * @param[in] error The error code
* @param[in] user_data The user data passed from the foreach function
*
* @pre media_info_insert_batch_to_db()
* @deprecated Deprecated since 4.0.
* @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
* @brief Called when the burst shot is inserted completely.
+ * @details The following error codes can be received: \n
+ * #MEDIA_CONTENT_ERROR_NONE : Success \n
+ * #MEDIA_CONTENT_ERROR_INVALID_PARAMETER : Invalid parameter \n
+ * #MEDIA_CONTENT_ERROR_INVALID_OPERATION : Invalid operation \n
+ * #MEDIA_CONTENT_ERROR_PERMISSION_DENIED : Permission denied \n
+ * #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY : Out of memory \n
+ * #MEDIA_CONTENT_ERROR_DB_FAILED : DB Operation failed \n
+ * #MEDIA_CONTENT_ERROR_DB_BUSY : DB Operation busy \n
+ * #MEDIA_CONTENT_ERROR_NETWORK : Network fail \n
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @remarks The callback is called in a separate thread(not in the main loop).
*
- * @param[in] media The handle to the media info
+ * @param[in] error The error code
* @param[in] user_data The user data passed from the foreach function
*
* @pre media_info_insert_burst_shot_to_db()
*
* @remarks The callback is called in a separate thread(not in the main loop).
*
- * @param[in] error The error code
- * @param[in] path The path of the thumbnail which is generated
+ * @param[in] error The error code
+ * @param[in] path The path of the thumbnail which is generated
* @param[in] user_data The user data passed from the foreach function
*
* @pre media_info_create_thumbnail()
*
* @remarks The callback is called in a separate thread(not in the main loop).
*
- * @param[in] error The error code
- * @param[in] face_count The number of all detected faces
+ * @param[in] error The error code
+ * @param[in] face_count The number of all detected faces
* @param[in] user_data The user data passed from the foreach function
*
* @pre media_info_start_face_detection()
* @remarks To use the @a folder outside this function, copy the handle with the media_folder_clone() function. \n
* The callback is called in the main loop.
*
- * @param[in] folder The handle to the media folder
+ * @param[in] folder The handle to the media folder
* @param[in] user_data The user data passed from the foreach function
*
* @return @c true to continue with the next iteration of the loop,
* @remarks To use the @a playlist outside this function, copy the handle with the media_playlist_clone() function. \n
* The callback is called in the main loop.
*
- * @param[in] playlist The handle to the media playlist
+ * @param[in] playlist The handle to the media playlist
* @param[in] user_data The user data passed from the foreach function
*
* @return @c true to continue with the next iteration of the loop,
* @remarks To use the @a media outside this function, copy the handle with the media_info_clone() function. \n
* The callback is called in the main loop.
*
- * @param[in] playlist_member_id The ID to member of the playlist
- * @param[in] media The handle to the media info
- * @param[in] user_data The user data passed from the foreach function
+ * @param[in] playlist_member_id The ID of the playlist member
+ * @param[in] media The handle to the media info
+ * @param[in] user_data The user data passed from the foreach function
*
* @return @c true to continue with the next iteration of the loop,
* otherwise @c false to break out of the loop
* @remarks To use the @a tag outside this function, copy the handle with the media_tag_clone() function. \n
* The callback is called in the main loop.
*
- * @param[in] tag The handle to the media tag
+ * @param[in] tag The handle to the media tag
* @param[in] user_data The user data passed from the foreach function
*
* @return @c true to continue with the next iteration of the loop,
* @remarks To use the @a bookmark outside this function, copy the handle with the media_bookmark_clone() function. \n
* The callback is called in the main loop.
*
- * @param[in] bookmark The handle to the video bookmark
+ * @param[in] bookmark The handle to the media bookmark
* @param[in] user_data The user data passed from the foreach function
*
* @return @c true to continue with the next iteration of the loop,
* @remarks To use the @a album outside this function, copy the handle with the media_album_clone() function. \n
* The callback is called in the main loop.
*
- * @param[in] album The handle to the media album
+ * @param[in] album The handle to the media album
* @param[in] user_data The user data passed from the foreach function
*
* @return @c true to continue with the next iteration of the loop,
* The callback is called in the main loop.
*
* @param[in] group_name The name of the media group
- * @param[in] user_data The user data passed from the foreach function
+ * @param[in] user_data The user data passed from the foreach function
*
* @return @c true to continue with the next iteration of the loop,
* otherwise @c false to break out of the loop
* @remarks You should not destroy @a storage returned by this function. \n
* The callback is called in the main loop.
*
- * @param[in] storage The handle of the media storage
- * @param[in] user_data The user data passed from the foreach function
+ * @param[in] storage The handle of the media storage
+ * @param[in] user_data The user data passed from the foreach function
*
* @return @c true to continue with the next iteration of the loop,
* otherwise @c false to break out of the loop
* @remarks You should not destroy @a face returned by this function. \n
* The callback is called in the main loop.
*
- * @param[in] face The handle of the media face
- * @param[in] user_data The user data passed from the foreach function
+ * @param[in] face The handle of the media face
+ * @param[in] user_data The user data passed from the foreach function
*
* @return @c true to continue with the next iteration of the loop,
* otherwise @c false to break out of the loop
*/
/**
- * @brief Media ID
+ * @brief Media ID.
* @details 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
*
#define MEDIA_ID "MEDIA_ID"
/**
- * @brief Media full path
+ * @brief Media full path.
* @details 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
*
#define MEDIA_PATH "MEDIA_PATH"
/**
- * @brief The file name including the extension
+ * @brief The file name including the extension.
* @details 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
*
#define MEDIA_DISPLAY_NAME "MEDIA_DISPLAY_NAME"
/**
- * @brief Media type
+ * @brief Media type.
* @details There are 5 media types:\n
* 0-image, 1-video, 2-sound, 3-music, 4-other\n
* You can use above define to set the condition of media filter and order keyword.
#define MEDIA_TYPE "MEDIA_TYPE"
/**
- * @brief Media MIME type
+ * @brief Media MIME type.
* @details 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
*
/**
- * @brief Media file size
+ * @brief Media file size.
* @details 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
*
#define MEDIA_SIZE "MEDIA_SIZE"
/**
- * @brief The time that content file was first added to media database
+ * @brief The time that content file was first added to media database.
* @details 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
*
#define MEDIA_ADDED_TIME "MEDIA_ADDED_TIME"
/**
- * @brief The last modification time provided by the file system
+ * @brief The last modification time provided by the file system.
* @details 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
*
#define MEDIA_MODIFIED_TIME "MEDIA_MODIFIED_TIME"
/**
- * @brief Media created time
+ * @brief Media created time.
* @details 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
*
#define MEDIA_TIMELINE "MEDIA_TIMELINE"
/**
- * @brief Media thumbnail path
+ * @brief Media thumbnail path.
* @details 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
*
#define MEDIA_THUMBNAIL_PATH "MEDIA_THUMBNAIL_PATH"
/**
- * @brief Media title get from tag or file name
+ * @brief Media title get from tag or file name.
* @details 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
*
#define MEDIA_TITLE "MEDIA_TITLE"
/**
- * @brief Media album name
+ * @brief Media album name.
* @details 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
*
#define MEDIA_ALBUM "MEDIA_ALBUM"
/**
- * @brief Media artist
+ * @brief Media artist.
* @details 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
*
#define MEDIA_ARTIST "MEDIA_ARTIST"
/**
- * @brief Media album artist
+ * @brief Media album artist.
* @details 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
*
#define MEDIA_ALBUM_ARTIST "MEDIA_ALBUM_ARTIST"
/**
- * @brief Media genre
+ * @brief Media genre.
* @details 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
*
#define MEDIA_GENRE "MEDIA_GENRE"
/**
- * @brief Media composer
+ * @brief Media composer.
* @details 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
*
#define MEDIA_COMPOSER "MEDIA_COMPOSER"
/**
- * @brief Media year
+ * @brief Media year.
* @details 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
*
#define MEDIA_YEAR "MEDIA_YEAR"
/**
- * @brief Media recorded date
+ * @brief Media recorded date.
* @details 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
*
#define MEDIA_RECORDED_DATE "MEDIA_RECORDED_DATE"
/**
- * @brief Media copyright
+ * @brief Media copyright.
* @details 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
*
#define MEDIA_COPYRIGHT "MEDIA_COPYRIGHT"
/**
- * @brief Media track number
+ * @brief Media track number.
* @details 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
*
#define MEDIA_TRACK_NUM "MEDIA_TRACK_NUM"
/**
- * @brief Media description
+ * @brief Media description.
* @details 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
*
#define MEDIA_DESCRIPTION "MEDIA_DESCRIPTION"
/**
- * @brief Media bitrate
+ * @brief Media bitrate.
* @details 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
*
#define MEDIA_BITRATE "MEDIA_BITRATE"
/**
- * @brief Media bit per sample
+ * @brief Media bit per sample.
* @details 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
*
#define MEDIA_BITPERSAMPLE "MEDIA_BITPERSAMPLE"
/**
- * @brief Media sample rate
+ * @brief Media sample rate.
* @details 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
*
#define MEDIA_SAMPLERATE "MEDIA_SAMPLERATE"
/**
- * @brief Media channel
+ * @brief Media channel.
* @details 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
*
#define MEDIA_CHANNEL "MEDIA_CHANNEL"
/**
- * @brief Media duration
+ * @brief Media duration.
* @details 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
*
#define MEDIA_DURATION "MEDIA_DURATION"
/**
- * @brief Media longitude
+ * @brief Media longitude.
* @details 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
*
#define MEDIA_LONGITUDE "MEDIA_LONGITUDE"
/**
- * @brief Media latitude
+ * @brief Media latitude.
* @details 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
*
#define MEDIA_LATITUDE "MEDIA_LATITUDE"
/**
- * @brief Media altitude
+ * @brief Media altitude.
* @details 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
*
#define MEDIA_ALTITUDE "MEDIA_ALTITUDE"
/**
- * @brief Media width
+ * @brief Media width.
* @details 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
*
#define MEDIA_WIDTH "MEDIA_WIDTH"
/**
- * @brief Media height
+ * @brief Media height.
* @details 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
*
#define MEDIA_HEIGHT "MEDIA_HEIGHT"
/**
- * @brief Media datetaken
+ * @brief Media datetaken.
* @details 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
*
#define MEDIA_DATETAKEN "MEDIA_DATETAKEN"
/**
- * @brief Media orientation
+ * @brief Media orientation.
* @details 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
*
/**
* @deprecated Deprecated since 4.0.
- * @brief Media burst ID
+ * @brief Media burst ID.
* @details 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
*
/**
* @deprecated Deprecated since 4.0.
- * @brief Media playedcount
+ * @brief Media playedcount.
* @details 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
*
/**
* @deprecated Deprecated since 4.0.
- * @brief Media last played time
+ * @brief Media last played time.
* @details 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
*
/**
* @deprecated Deprecated since 4.0.
- * @brief Media last played position of file
+ * @brief Media last played position of file.
* @details 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
*
#define MEDIA_LAST_PLAYED_POSITION "MEDIA_LAST_PLAYED_POSITION"
/**
- * @brief Media rating
+ * @brief Media rating.
* @details 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
*
#define MEDIA_RATING "MEDIA_RATING"
/**
- * @brief The time to register favourite
+ * @brief The time to register favourite.
* @details 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
*
/**
* @deprecated Deprecated since 4.0.
- * @brief Media author
+ * @brief Media author.
* @details 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
*
/**
* @deprecated Deprecated since 4.0.
- * @brief Media provider
+ * @brief Media provider.
* @details 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
*
/**
* @deprecated Deprecated since 4.0.
- * @brief Media content name
+ * @brief Media content name.
* @details 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
*
/**
* @deprecated Deprecated since 4.0.
- * @brief Media category
+ * @brief Media category.
* @details 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
*
/**
* @deprecated Deprecated since 4.0.
- * @brief Media location tag
+ * @brief Media location tag.
* @details 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
*
/**
* @deprecated Deprecated since 4.0.
- * @brief Media age rating
+ * @brief Media age rating.
* @details 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
*
/**
* @deprecated Deprecated since 4.0.
- * @brief Media keyword
+ * @brief Media keyword.
* @details 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
*
/**
* @deprecated Deprecated since 4.0.
- * @brief Media weather
+ * @brief Media weather.
* @details 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
*
#define MEDIA_WEATHER "MEDIA_WEATHER"
/**
- * @brief Is DRM
+ * @brief Is DRM.
* @details There are 2 types:\n
* 0-not drm, 1-drm\n
* You can use above define to set the condition of media filter and order keyword.
#define MEDIA_IS_DRM "MEDIA_IS_DRM"
/**
- * @brief Media storage
+ * @brief Media storage.
* @details There are 2 types:\n
* 0-internal storage, 1-external storage\n
* You can use above define to set the condition of media filter and order keyword.
#define MEDIA_STORAGE_TYPE "MEDIA_STORAGE_TYPE"
/**
- * @brief Media exposure time
+ * @brief Media exposure time.
* @details You can use above define to set the condition of media filter and order keyword.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
#define MEDIA_EXPOSURE_TIME "MEDIA_EXPOSURE_TIME"
/**
- * @brief Media fnumber
+ * @brief Media fnumber.
* @details You can use above define to set the condition of media filter and order keyword.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
#define MEDIA_FNUMBER "MEDIA_FNUMBER"
/**
- * @brief Media ISO
+ * @brief Media ISO.
* @details You can use above define to set the condition of media filter and order keyword.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
#define MEDIA_ISO "MEDIA_ISO"
/**
- * @brief Media model
+ * @brief Media model.
* @details You can use above define to set the condition of media filter and order keyword.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
#define MEDIA_MODEL "MEDIA_MODEL"
/**
- * @brief Media file name pinyin
+ * @brief Media file name pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
#define MEDIA_FILE_NAME_PINYIN "MEDIA_FILE_NAME_PINYIN"
/**
- * @brief Media title pinyin
+ * @brief Media title pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
#define MEDIA_TITLE_PINYIN "MEDIA_TITLE_PINYIN"
/**
- * @brief Media album pinyin
+ * @brief Media album pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
#define MEDIA_ALBUM_PINYIN "MEDIA_ALBUM_PINYIN"
/**
- * @brief Media artist pinyin
+ * @brief Media artist pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
#define MEDIA_ARTIST_PINYIN "MEDIA_ARTIST_PINYIN"
/**
- * @brief Media album artist pinyin
+ * @brief Media album artist pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
#define MEDIA_ALBUM_ARTIST_PINYIN "MEDIA_ALBUM_ARTIST_PINYIN"
/**
- * @brief Media genre pinyin
+ * @brief Media genre pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
#define MEDIA_GENRE_PINYIN "MEDIA_GENRE_PINYIN"
/**
- * @brief Media composer pinyin
+ * @brief Media composer pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
#define MEDIA_COMPOSER_PINYIN "MEDIA_COMPOSER_PINYIN"
/**
- * @brief Media copyright pinyin
+ * @brief Media copyright pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
#define MEDIA_COPYRIGHT_PINYIN "MEDIA_COPYRIGHT_PINYIN"
/**
- * @brief Media description pinyin
+ * @brief Media description pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
/**
* @deprecated Deprecated since 4.0.
- * @brief Media author pinyin
+ * @brief Media author pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
/**
* @deprecated Deprecated since 4.0.
- * @brief Media provider pinyin
+ * @brief Media provider pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
/**
* @deprecated Deprecated since 4.0.
- * @brief Media content name pinyin
+ * @brief Media content name pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
/**
* @deprecated Deprecated since 4.0.
- * @brief Media category pinyin
+ * @brief Media category pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
/**
* @deprecated Deprecated since 4.0.
- * @brief Media location tag pinyin
+ * @brief Media location tag pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
/**
* @deprecated Deprecated since 4.0.
- * @brief Media age rating pinyin
+ * @brief Media age rating pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
/**
* @deprecated Deprecated since 4.0.
- * @brief Media keyword pinyin
+ * @brief Media keyword pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
#define MEDIA_KEYWORD_PINYIN "MEDIA_KEYWORD_PINYIN"
/**
- * @brief Virtual Reality content
+ * @brief Virtual Reality content.
* @details You can use above define to set the condition of media filter and order keyword.
* @since_tizen 3.0
*
#define MEDIA_360 "MEDIA_360"
/**
- * @brief Folder ID
+ * @brief Folder ID.
* @details You can use above define to set the condition of folder filter and order keyword.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define FOLDER_ID "FOLDER_ID"
/**
- * @brief Folder full path
+ * @brief Folder full path.
* @details You can use above define to set the condition of folder filter and order keyword.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define FOLDER_PATH "FOLDER_PATH"
/**
- * @brief Folder base name
+ * @brief Folder base name.
* @details You can use above define to set the condition of folder filter and order keyword.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
/**
* @deprecated Deprecated since 4.0.
- * @brief Folder modified time
+ * @brief Folder modified time.
* @details You can use above define to set the condition of folder filter and order keyword.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define FOLDER_MODIFIED_TIME "FOLDER_MODIFIED_TIME"
/**
- * @brief Folder storage
+ * @brief Folder storage.
* @details There are 2 types:\n
* 0-internal storage, 1-external storage\n
* You can use above define to set the condition of folder filter and order keyword.
#define FOLDER_STORAGE_TYPE "FOLDER_STORAGE_TYPE"
/**
- * @brief Folder base name pinyin
+ * @brief Folder base name pinyin.
* @details You can use above define to set the condition of folder filter and order keyword.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks Since 4.0, this keyword is related to the following feature:\n
/**
* @deprecated Deprecated since 4.0.
- * @brief Folder order info
+ * @brief Folder order info.
* @details 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
*/
/**
* @deprecated Deprecated since 4.0.
- * @brief Parent folder id
+ * @brief Parent folder id.
* @details 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
*/
#define FOLDER_PARENT_FOLDER_ID "FOLDER_PARENT_FOLDER_ID"
/**
- * @brief Playlist name
+ * @brief Playlist name.
* @details You can use above define to set the condition of playlist filter and order keyword.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define PLAYLIST_NAME "PLAYLIST_NAME"
/**
- * @brief Playlist id
+ * @brief Playlist id.
* @details You can use above define to set the condition of playlist filter and order keyword.
* @since_tizen 4.0
*/
#define MEDIA_PLAYLIST_ID "PLAYLIST_ID"
/**
- * @brief Playlist name
+ * @brief Playlist member order.
* @details You can use above define to set the condition of playlist filter and order keyword.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define PLAYLIST_MEMBER_ORDER "PLAYLIST_MEMBER_ORDER"
/**
- * @brief Media count in playlist
+ * @brief Media count in playlist.
* @details You can use above define to set the condition of playlist filter and order keyword.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define PLAYLIST_MEDIA_COUNT "PLAYLIST_MEDIA_COUNT"
/**
- * @brief Tag name
+ * @brief Tag name.
* @details You can use above define to set the condition of tag filter and order keyword.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define TAG_NAME "TAG_NAME"
/**
- * @brief Tag id
+ * @brief Tag id.
* @details You can use above define to set the condition of tag filter and order keyword.
* @since_tizen 4.0
*/
#define MEDIA_TAG_ID "TAG_ID"
/**
- * @brief Media count in tag
+ * @brief Media count in tag.
* @details You can use above define to set the condition of tag filter and order keyword.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define TAG_MEDIA_COUNT "TAG_MEDIA_COUNT"
/**
- * @brief Bookmark marked time
+ * @brief Bookmark marked time.
* @details You can use above define to set the condition of bookmark filter and order keyword.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define BOOKMARK_MARKED_TIME "BOOKMARK_MARKED_TIME"
/**
- * @brief Bookmark id
+ * @brief Bookmark id.
* @details You can use above define to set the condition of bookmark filter and order keyword.
* @since_tizen 4.0
*/
#define MEDIA_BOOKMARK_ID "BOOKMARK_ID"
/**
- * @brief Bookmark name
+ * @brief Bookmark name.
* @details You can use above define to set the condition of bookmark filter and order keyword.
* @since_tizen 4.0
*/
#define BOOKMARK_NAME "BOOKMARK_NAME"
/**
- * @brief Storage ID
+ * @brief Storage ID.
* @details You can use above define to set the condition of storage filter and order keyword.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*/
#define MEDIA_STORAGE_ID "STORAGE_ID"
/**
- * @brief Storage path
+ * @brief Storage path.
* @details You can use above define to set the condition of storage filter and order keyword.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*/
#define MEDIA_STORAGE_PATH "STORAGE_PATH"
/**
- * @brief Face tag
+ * @brief Face tag.
* @details You can use above define to set the condition of face filter and order keyword.
* @since_tizen 3.0
*/
#define MEDIA_FACE_TAG "MEDIA_FACE_TAG"
/**
- * @brief Face id
+ * @brief Face id.
* @details You can use above define to set the condition of face filter and order keyword.
* @since_tizen 4.0
*/
#endif /* __cplusplus */
-#endif /*__TIZEN_MEDIA_CONTENT_TYPE_H__*/
+#endif /*__TIZEN_CONTENT_MEDIA_CONTENT_TYPE_H__*/
* limitations under the License.
*/
-#ifndef __TIZEN_MEDIA_IMAGE_FACE_H__
-#define __TIZEN_MEDIA_IMAGE_FACE_H__
+#ifndef __TIZEN_CONTENT_MEDIA_FACE_H__
+#define __TIZEN_CONTENT_MEDIA_FACE_H__
#include <media_content_type.h>
/**
* @file media_face.h
- * @brief This file contains the media face API and related to all operations with the face information of the image in Media DB. \n
- * Functions include cloning and destroying the face handler, getting face information such as face id, face coordinates in file, \n
+ * @brief This file contains the media face function and related to all operations with the face information of the image in Media DB. \n
+ * Functions include cloning and destroying the media face handler, getting face information such as face id, face coordinates in file, \n
* face tag. Face information will be managed by DB. To insert face information, you should use media_face_insert_to_db() \n
- * or media_info_start_face_detection() API. And you can insert,update,delete face information manually.
+ * or media_info_start_face_detection() function. And you can insert,update,delete face information manually.
*/
/**
*/
/**
- * @brief Clones the face handle.
- * @details This function copies the face handle from a source to
+ * @brief Clones the media face handle.
+ * @details This function copies the media face handle from a source to
* destination. There is no media_face_create() function. The media_face_h is created internally and available through
* media face foreach function such as media_face_foreach_face_from_db(). To use this handle outside of these foreach functions,
* use this function.
*
* @since_tizen 3.0
- * @remark The destination handle must be released with media_event_destroy() by you.
+ * @remarks The @a dst should be released using media_face_destroy().
*
- * @param [in] src The source face handle
- * @param [out] dst A destination face handle
+ * @param[out] dst The destination handle to the media face
+ * @param[in] src The source handle to the media face
*
* @return 0 on success, otherwise a negative error value.
*
int media_face_clone(media_face_h *dst, media_face_h src);
/**
- * @brief Destroys the face handle.
- * @details Function frees all resources related to face handle. This
+ * @brief Destroys the media face handle.
+ * @details Function frees all resources related to media face handle. This
* handle no longer can be used to perform any operation. New handle has to
* be created before next usage.
*
* @since_tizen 3.0
*
- * @param [in] face The face handle
+ * @param[in] face The media face handle
*
* @return 0 on success, otherwise a negative error value.
*
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*
- * @see media_face_clone()
- *
- * @pre Get copy of face handle by calling media_face_clone() or Get face handle by calling media_info_foreach_face_from_db()
+ * @pre Get copy of media face handle by calling media_face_clone() or Get media face handle by calling media_info_foreach_face_from_db()
*
+ * @see media_face_clone()
*/
int media_face_destroy(media_face_h face);
/**
- * @brief Gets the face id from the face handle.
+ * @brief Gets the face id from the media face handle.
*
* @since_tizen 3.0
*
- * @remarks You must release @a face_id using free().
+ * @remarks The @a face_id should be released using free().
*
- * @param [in] face The face handle
- * @param [out] face_id The uuid of the face handle
+ * @param[in] face The media face handle
+ * @param[out] face_id The ID of the media face
*
* @return 0 on success, otherwise a negative error value.
*
int media_face_get_face_id(media_face_h face, char **face_id);
/**
- * @brief Gets the media uuid from the face handle.
+ * @brief Gets the media id from the media face handle.
*
* @since_tizen 3.0
*
- * @remarks You must release @a media_id using free().
+ * @remarks The @a media_id should be released using free().
*
- * @param [in] face The face handle
- * @param [out] media_id The media uuid of the face handle
+ * @param[in] face The media face handle
+ * @param[out] media_id The media ID
*
* @return 0 on success, otherwise a negative error value.
*
int media_face_get_media_id(media_face_h face, char **media_id);
/**
- * @brief Gets the face's rectangle from the face handle.
- * @details This API can get the face's rectangle information. returned rectangle information includes the orientation value.
+ * @brief Gets the face's rectangle from the media face handle.
+ * @details This function can get the face's rectangle information. returned rectangle information includes the orientation value.
*
* @since_tizen 3.0
*
- * @param [in] face The face handle
- * @param [out] rect_x The x position of face of the face handle
- * @param [out] rect_y The y position of face of the face handle
- * @param [out] rect_w The width of face of the face handle
- * @param [out] rect_h The height of face of the face handle
+ * @param[in] face The media face handle
+ * @param[out] rect_x The x position of the media face
+ * @param[out] rect_y The y position of the media face
+ * @param[out] rect_w The width of the media face
+ * @param[out] rect_h The height of the media face
*
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
int media_face_get_face_rect(media_face_h face, unsigned int *rect_x, unsigned int *rect_y, unsigned int *rect_w, unsigned int *rect_h);
/**
- * @brief Gets the orientation from the face handle.
- * @details This API can get the orientation value from the original image.
+ * @brief Gets the orientation from the media face handle.
+ * @details This function can get the orientation value from the original image.
*
* @since_tizen 3.0
*
- * @param [in] face The face handle
- * @param [out] orientation The orientation of the face handle
+ * @param[in] face The media face handle
+ * @param[out] orientation The orientation of the media face
*
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
int media_face_get_orientation(media_face_h face, media_content_orientation_e *orientation);
/**
- * @brief Gets the tag from the face handle.
+ * @brief Gets the tag from the media face handle.
*
* @since_tizen 3.0
*
- * @remarks You must release @a tag using free().
+ * @remarks The @a tag should be released using free().
*
- * @param [in] face The face handle
- * @param [out] tag The tag of the face handle
+ * @param[in] face The media face handle
+ * @param[out] tag The tag of the media face
*
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
int media_face_get_tag(media_face_h face, char **tag);
/**
- * @brief Creates the face handle.
+ * @brief Creates the media face handle.
*
* @since_tizen 3.0
*
- * @param [in] media_id The media uuid to create the face handle
- * @param [out] face The face handle
+ * @remarks The @a face should be released using media_face_destroy().
+ *
+ * @param[in] media_id The media ID
+ * @param[out] face The media face handle
*
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
int media_face_create(const char *media_id, media_face_h *face);
/**
- * @brief Sets the face rectangle of the face handle
+ * @brief Sets the face rectangle of the media face handle.
*
* @since_tizen 3.0
*
- * @param[in] face The face handle
+ * @param[in] face The media face handle
* @param[in] rect_x The integer to set as a position x of face rectangle
* @param[in] rect_y The integer to set as a position y of face rectangle
- * @param[in] rect_w The integer to set as a width of face rectangle
+ * @param[in] rect_w The integer to set as a width of face rectangle
* @param[in] rect_h The integer to set as a height of face rectangle
*
* @return 0 on success, otherwise a negative error value.
int media_face_set_face_rect(media_face_h face, unsigned int rect_x, unsigned int rect_y, unsigned int rect_w, unsigned int rect_h);
/**
- * @brief Sets the orientation of the face handle
- * @details This API may set the value of the original image orientation.
+ * @brief Sets the orientation of the media face handle.
+ * @details This function may set the value of the original image orientation.
*
* @since_tizen 3.0
*
- * @param[in] face The face handle
+ * @param[in] face The media face handle
* @param[in] orientation The integer to set as an orientation
*
* @return 0 on success, otherwise a negative error value.
int media_face_set_orientation(media_face_h face, media_content_orientation_e orientation);
/**
- * @brief Sets the tag of the face handle.
+ * @brief Sets the tag of the media face handle.
*
* @since_tizen 3.0
*
- * @param [in] face The face handle
- * @param [in] tag The tag of the face handle
+ * @param[in] face The media face handle
+ * @param[in] tag The tag of the media face
*
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @remarks The created tag handle must be released using media_tag_destroy().
+ * @remarks The @a face should be released using media_face_destroy().
*
- * @param [in] face The face handle
+ * @param[in] face The media face handle
*
* @return 0 on success, otherwise a negative error value.
*
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @param[in] face The face handle to update
+ * @param[in] face The media face handle to update
*
* @return 0 on success, otherwise a negative error value.
*
int media_face_update_to_db(media_face_h face);
/**
- * @brief Deletes the face with given face uuid from the media database.
+ * @brief Deletes the face with given face id from the media database.
*
* @since_tizen 3.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @param [in] face_id The id of media face
+ * @param[in] face_id The ID of the media face
*
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @brief Gets the number of media faces with an optional filter from the media database.
* @since_tizen 4.0
*
- * @param[in] filter The handle to the face filter
- * @param[out] face_count The count of the media faces
+ * @param[in] filter The handle to the media filter
+ * @param[out] face_count The count of the media faces
*
* @return @c 0 on success,
* otherwise a negative error value
* If @c NULL is passed to the @a filter, then no filtering is applied.
* @since_tizen 4.0
*
- * @param[in] filter The handle to the face filter
- * @param[in] callback The callback function to be invoked
- * @param[in] user_data The user data to be passed to the callback function
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
}
#endif /* __cplusplus */
-#endif /* __TIZEN_MEDIA_IMAGE_FACE_H__ */
+#endif /* __TIZEN_CONTENT_MEDIA_FACE_H__ */
-#ifndef __TIZEN_MEDIA_FILTER_H__
-#define __TIZEN_MEDIA_FILTER_H__
+#ifndef __TIZEN_CONTENT_MEDIA_FILTER_H__
+#define __TIZEN_CONTENT_MEDIA_FILTER_H__
#include <media_content_type.h>
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release the @a filter handle using media_info_filter_destroy().
+ * @remarks The @a filter should be released using media_info_filter_destroy().
*
- * @param[out] filter A handle to the media filter
+ * @param[out] filter The handle to the media filter
*
* @return @c 0 on success,
* otherwise a negative error value
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[in] filter The handle to the media filter
- * @param[in] offset The start position of the given filter (Starting from zero)
- * @param[in] count The number of items to be searched with respect to the offset
+ * @param[in] offset The start position of the given media filter (Starting from zero)
+ * @param[in] count The number of items to be searched with respect to the offset
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Sets the @a condition for the given @a filter.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] filter The handle to the media filter
- * @param[in] condition The condition which is used WHERE clause on a query
+ * @param[in] filter The handle to the media filter
+ * @param[in] condition The condition which is used WHERE clause on a query
* @param[in] collate_type The collate type for comparing two strings
*
* @return @c 0 on success,
int media_filter_set_condition(filter_h filter, const char *condition, media_content_collation_e collate_type);
/**
- * @brief Sets the media filter content @a order and order keyword i.e. either descending or ascending.
+ * @brief Sets the media filter content @a order_type and @a order_keyword i.e. either descending or ascending.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] filter The handle to the media filter
- * @param[in] order_type The search order type
+ * @param[in] filter The handle to the media filter
+ * @param[in] order_type The search order type
* @param[in] order_keyword The search order keyword
- * @param[in] collate_type The collate type for comparing two strings
+ * @param[in] collate_type The collate type for comparing two strings
*
* @return @c 0 on success,
* otherwise a negative error value
int media_filter_set_order(filter_h filter, media_content_order_e order_type, const char *order_keyword, media_content_collation_e collate_type);
/**
- * @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
+ * @brief Sets the @a storage_id for the given @a filter.
+ * @details You can use this function when you want to search items only in the specific storage
*
* @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
+ * @param[in] filter The handle to the media filter
+ * @param[in] storage_id The ID of the media storage
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the @a offset and @a count for the given @a filter used to limit the number of items returned.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] filter The handle to the media filter
- * @param[out] offset The start position of the given filter (Starting from zero)
- * @param[out] count The number of items to be searched with respect to the offset
+ * @param[in] filter The handle to the media filter
+ * @param[out] offset The start position of the given media filter (Starting from zero)
+ * @param[out] count The number of items to be searched with respect to the offset
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the @a condition for the given @a filter.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a condition using free().
+ * @remarks The @a condition should be released using free().
*
- * @param[in] filter The handle to the media info filter
- * @param[out] condition The condition which is used WHERE clause on a query
+ * @param[in] filter The handle to the media filter
+ * @param[out] condition The condition which is used WHERE clause on a query
* @param[out] collate_type The collate type for comparing two strings
*
* @return @c 0 on success,
int media_filter_get_condition(filter_h filter, char **condition, media_content_collation_e *collate_type);
/**
- * @brief Gets the media filter's content @a order and order keyword i.e. either descending or ascending.
+ * @brief Gets the media filter's content @a order_type and @a order_keyword i.e. either descending or ascending.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a order_keyword using free().
+ * @remarks The @a order_keyword should be released using free().
*
- * @param[in] filter The handle to the media filter
- * @param[out] order_type The search order type
+ * @param[in] filter The handle to the media filter
+ * @param[out] order_type The search order type
* @param[out] order_keyword The search order keyword
- * @param[out] collate_type The collate type for comparing two strings
+ * @param[out] collate_type The collate type for comparing two strings
*
* @return @c 0 on success,
* otherwise a negative error value
int media_filter_get_order(filter_h filter, media_content_order_e* order_type, char **order_keyword, media_content_collation_e *collate_type);
/**
- * @brief Get the @a storage id for given @a filter.
+ * @brief Gets the @a storage_id for given @a filter.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks You must release @a storage_id using free().
+ * @remarks The @a storage_id should be released using free().
*
- * @param[in] filter The handle to media info filter
- * @param[out] storage_id The storage_id which is used in filter
+ * @param[in] filter The handle to the media filter
+ * @param[out] storage_id The ID of the media storage
*
* @return @c 0 on success,
* otherwise a negative error value
}
#endif /* __cplusplus */
-#endif /* __TIZEN_MEDIA_FILTER_H__ */
+#endif /* __TIZEN_CONTENT_MEDIA_FILTER_H__ */
*/
-#ifndef __TIZEN_MEDIA_FOLDER_H__
-#define __TIZEN_MEDIA_FOLDER_H__
+#ifndef __TIZEN_CONTENT_MEDIA_FOLDER_H__
+#define __TIZEN_CONTENT_MEDIA_FOLDER_H__
#include <media_content_type.h>
* @brief Gets the count of folder for the passed @a filter from the media database.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] filter The handle to filter \n
- * To allow searching over different content types, you should use #filter_h.
+ * @param[in] filter The handle to the media filter
* @param[out] folder_count The count of the media folder
*
* @return @c 0 on success,
* So, your callback function is in read state in SQLite. When you are in read state, sometimes you do not update DB. \n
* We do not recommend you call updating DB function in callback of foreach function.
*
- * @param[in] filter The handle to the media folder filter
- * @param[in] callback The callback function to be invoked
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
int media_folder_foreach_folder_from_db(filter_h filter, media_folder_cb callback, void *user_data);
/**
- * @brief Gets the count of media files for the passed @a filter in the given @a folder from the media database.
+ * @brief Gets the count of media files for the passed @a filter in the given @a folder_id from the media database.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] folder_id The ID of the media folder
- * @param[in] filter The filter of the media content
+ * @param[in] folder_id The ID of the media folder
+ * @param[in] filter The handle to the media filter
* @param[out] media_count The count of media folder items
*
* @return @c 0 on success,
int media_folder_get_media_count_from_db(const char *folder_id, filter_h filter, int *media_count);
/**
- * @brief Iterates through the media files with an optional @a filter in the given @a folder from the media database.
+ * @brief Iterates through the media files with an optional @a filter in the given @a folder_id from the media database.
* @details This function gets all media files associated with the given folder and
* meeting desired filter option and calls @a callback for
* every retrieved media item. If @c NULL is passed to the @a filter, no filtering is applied.
* We do not recommend you call updating DB function in callback of foreach function.
*
* @param[in] folder_id The ID of the media folder
- * @param[in] filter The handle to the media info filter
- * @param[in] callback The callback function to be invoked
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks The destination handle must be released with media_folder_destroy().
+ * @remarks The @a dst should be released using media_folder_destroy().
*
* @param[out] dst The destination handle to the media folder
- * @param[in] src The source handle to the media folder
+ * @param[in] src The source handle to the media folder
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the media folder ID.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a folder_id using free().
+ * @remarks The @a folder_id should be released using free().
*
- * @param[in] folder The handle to the media folder
+ * @param[in] folder The handle to the media folder
* @param[out] folder_id The ID of the media folder
*
* @return @c 0 on success,
* @brief Gets the parent folder ID.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks You must release @a parent_folder_id using free().
+ * @remarks The @a parent_folder_id should be released using free().
*
- * @param[in] folder The handle to the media folder
+ * @param[in] folder The handle to the media folder
* @param[out] parent_folder_id The ID of the upper media folder
*
* @return @c 0 on success,
* @brief Gets the absolute path to the media folder.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a path using free().
+ * @remarks The @a path should be released using free().
*
- * @param[in] folder The handle to the media folder
- * @param[out] path The path of the media folder
+ * @param[in] folder The handle to the media folder
+ * @param[out] path The path of the media folder
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the media folder name.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a folder_name using free().
+ * @remarks The @a folder_name should be released using free().
*
- * @param[in] folder The handle to the media folder
+ * @param[in] folder The handle to the media folder
* @param[out] folder_name The name of the media folder
*
* @return @c 0 on success,
* @brief Gets the modified date of the folder.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] folder The handle to the media folder
- * @param[out] date The modified date of the folder
+ * @param[in] folder The handle to the media folder
+ * @param[out] date The modified date of the media folder
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the folder storage type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] folder The handle to the media folder
+ * @param[in] folder The handle to the media folder
* @param[out] storage_type The storage type of the media folder
*
* @return @c 0 on success,
* @brief Gets the storage id of the folder.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks You must release @a storage_id using free().
+ * @remarks The @a storage_id should be released using free().
*
- * @param[in] folder The handle to the media folder
+ * @param[in] folder The handle to the media folder
* @param[out] storage_id The storage id of the media folder
*
* @return @c 0 on success,
* @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
+ * @param[out] order The viewing order of the media folder
*
* @return @c 0 on success,
* otherwise a negative error value
* Media folder will be created, which is filled with folder information.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a folder using media_folder_destroy().
+ * @remarks The @a folder should be released using media_folder_destroy().
*
- * @param[in] folder_id The ID of the media folder
- * @param[out] folder The media folder handle associated with the folder ID
+ * @param[in] folder_id The ID of the media folder
+ * @param[out] folder The handle to the media folder
*
* @return @c 0 on success,
* otherwise a negative error value
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[in] folder The handle to the media folder
- * @param[in] name The name of the media folder
+ * @param[in] name The name of the media folder
*
* @return @c 0 on success,
* otherwise a negative error value
* If you don't use the filter, the set order value does not effect the folder viewing order.
*
* @param[in] folder The handle to the media folder
- * @param[in] order The viewing order of the media folder
+ * @param[in] order The viewing order of the media folder
*
* @return @c 0 on success,
* otherwise a negative error value
}
#endif /* __cplusplus */
-#endif /* __TIZEN_MEDIA_FOLDER_H__ */
+#endif /* __TIZEN_CONTENT_MEDIA_FOLDER_H__ */
* limitations under the License.
*/
-#ifndef __TIZEN_MEDIA_GROUP_H__
-#define __TIZEN_MEDIA_GROUP_H__
+#ifndef __TIZEN_CONTENT_MEDIA_GROUP_H__
+#define __TIZEN_CONTENT_MEDIA_GROUP_H__
#include <media_content_type.h>
* @brief Gets the number of the album for the passed @a filter from the media database.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] filter The media filter handle
+ * @param[in] filter The handle to the media filter
* @param[out] album_count The count of the media album
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] filter The media filter handle
- * @param[in] callback The callback function to be invoked
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* @brief Gets the number of media info for the given album present in the media database.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] album_id The ID of the media album
- * @param[in] filter The media filter handle
- * @param[out] media_count The count of the album
+ * @param[in] album_id The ID of the media album
+ * @param[in] filter The handle to the media filter
+ * @param[out] media_count The count of the media album
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
* @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
* @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
-
*
* @pre This function requires opened connection to content service by media_content_connect().
*
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] album_id The ID of the media album
- * @param[in] filter The media filter handle
- * @param[in] callback The callback function to be invoked
+ * @param[in] album_id The ID of the media album
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] album The media album handle
+ * @param[in] album The handle to the media album
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release the destination handle using media_album_destroy().
+ * @remarks The @a dst should be released using media_album_destroy().
*
- * @param[in] src The source handle to the media album
- * @param[out] dst The destination handle to the media album
+ * @param[out] dst The destination handle to the media album
+ * @param[in] src The source handle to the media album
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the ID of the album.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] album The media album handle
- * @param[out] album_id The media album ID
+ * @param[in] album The handle to the media album
+ * @param[out] album_id The ID of the media album
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the name of the album.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a album_name using free().
+ * @remarks The @a album_name should be released using free().
*
- * @param[in] album The media album handle
- * @param[out] album_name The name of the media album handle
+ * @param[in] album The handle to the media album
+ * @param[out] album_name The name of the media album handle
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the name of the artist from the given album.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a artist using free().
+ * @remarks The @a artist should be released using free().
*
- * @param[in] album The media album handle
+ * @param[in] album The handle to the media album
* @param[out] artist The name of the media artist
*
* @return @c 0 on success,
* @brief Gets the album art path from the album.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a album_art using free().
+ * @remarks The @a album_art should be released using free().
*
- * @param[in] album The media album handle
+ * @param[in] album The handle to the media album
* @param[out] album_art The path of the media album_art
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a folder using media_album_destroy().
+ * @remarks The @a album should be released using media_album_destroy().
*
- * @param[in] album_id The ID of the media album
- * @param[out] album The album handle associated with the album ID
+ * @param[in] album_id The ID of the media album
+ * @param[out] album The handle to the media album
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the number of the group for the passed @a filter from the media database.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] filter The media filter handle
- * @param[in] group The type of the media group
- * @param[out] group_count The count of the media group
+ * @param[in] filter The handle to the media filter
+ * @param[in] group The type of the media group
+ * @param[out] group_count The count of the media group
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] filter The media filter handle
- * @param[in] group The type of the media group
- * @param[in] callback The callback function to be invoked
+ * @param[in] filter The handle to the media filter
+ * @param[in] group The type of the media group
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* @brief Gets the count of the media info for the given media group present in the media database.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] group_name The name of the media group
- * @param[in] group The type of the media group
- * @param[in] filter The media filter handle
+ * @param[in] group_name The name of the media group
+ * @param[in] group The type of the media group
+ * @param[in] filter The handle to the media filter
* @param[out] media_count The count of the media
*
* @return @c 0 on success,
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[in] group_name The name of the media group
- * @param[in] group The type of the media group
- * @param[in] filter The media filter handle
- * @param[in] callback The callback function to be invoked
- * @param[in] user_data The user data to be passed to the callback function
+ * @param[in] group The type of the media group
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
}
#endif /* __cplusplus */
-#endif /* __TIZEN_MEDIA_GROUP_H__ */
+#endif /* __TIZEN_CONTENT_MEDIA_GROUP_H__ */
-#ifndef __TIZEN_IMAGE_META_H__
-#define __TIZEN_IMAGE_META_H__
+#ifndef __TIZEN_CONTENT_MEDIA_IMAGE_H__
+#define __TIZEN_CONTENT_MEDIA_IMAGE_H__
#include <media_content_type.h>
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks The destination handle must be released with image_meta_destroy().
+ * @remarks The @a dst should be released using image_meta_destroy().
*
- * @param[out] dst The destination handle to the image metadata
- * @param[in] src The source handle to the image metadata
+ * @param[out] dst The destination handle to the image metadata
+ * @param[in] src The source handle to the image metadata
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] image The image metadata handle
+ * @param[in] image The handle to the image metadata
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the ID of an image.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] image The image metadata handle
- * @param[out] media_id The ID of an image
+ * @remarks The @a media_id should be released using free().
+ *
+ * @param[in] image The handle to the image metadata
+ * @param[out] media_id The media ID
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the image width in pixels.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] image The image metadata handle
+ * @param[in] image The handle to the image metadata
* @param[out] width The image width in pixels
*
* @return @c 0 on success,
* @brief Gets the image height in pixels.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] image The image metadata handle
+ * @param[in] image The handle to the image metadata
* @param[out] height The image height in pixels
*
* @return @c 0 on success,
* @brief Gets the image orientation.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] image The image metadata handle
+ * @param[in] image The handle to the image metadata
* @param[out] orientation The image orientation
*
* @return @c 0 on success,
* @brief Gets the image creation time.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] image The image metadata handle
+ * @remarks The @a date_taken should be released using free().
+ *
+ * @param[in] image The handle to the image metadata
* @param[out] date_taken The time, when image was taken (in seconds, since the Epoch)
*
* @return @c 0 on success,
* @brief Gets the burst shot ID.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a burst_id using free().
+ * @remarks The @a burst_id should be released using free().
*
- * @param[in] image The image metadata handle
- * @param[out] burst_id The ID of burst shot\ n
+ * @param[in] image The handle to the image metadata
+ * @param[out] burst_id The ID of the burst shot\ n
* If @a burst_id is @c NULL, this is not burst shot
*
* @return @c 0 on success,
int image_meta_get_burst_id(image_meta_h image, char **burst_id) TIZEN_DEPRECATED_API;
/**
- * @brief Gets the exposure time from exif.
+ * @brief Gets the exposure time from EXIF.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks @a exposure time must be released with free() by you.
+ * @remarks The @a exposure_time should be released using free().
*
- * @param[in] image The image metadata handle
- * @param[out] exposure_time The value of exposure_time, getting from exif
+ * @param[in] image The handle to the image metadata
+ * @param[out] exposure_time The value of exposure_time, getting from EXIF
*
* @return 0 on success,
* otherwise a negative error value
int image_meta_get_exposure_time(image_meta_h image, char **exposure_time);
/**
- * @brief Gets the fnumber from exif.
+ * @brief Gets the fnumber from EXIF.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @param[in] image The image metadata handle
- * @param[out] fnumber The value of fnumber, getting from exif
+ * @param[in] image The handle to the image metadata
+ * @param[out] fnumber The value of fnumber, getting from EXIF
*
* @return 0 on success,
* otherwise a negative error value
int image_meta_get_fnumber(image_meta_h image, double *fnumber);
/**
- * @brief Gets the iso from exif.
+ * @brief Gets the iso from EXIF.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @param[in] image The image metadata handle
- * @param[out] iso The value of iso, getting from exif
+ * @param[in] image The handle to the image metadata
+ * @param[out] iso The value of iso, getting from EXIF
*
* @return 0 on success,
* otherwise a negative error value
int image_meta_get_iso(image_meta_h image, int *iso);
/**
- * @brief Gets the model from exif.
+ * @brief Gets the model from EXIF.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks @a model must be released with free() by you.
+ * @remarks The @a model should be released using free().
*
- * @param[in] image The image metadata handle
- * @param[out] model The value of model, getting from exif
+ * @param[in] image The handle to the image metadata
+ * @param[out] model The value of model, getting from EXIF
*
* @return 0 on success,
* otherwise a negative error value
* @brief Checks whether the media is a burst shot image.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] image The image metadata handle
+ * @param[in] image The handle to the image metadata
* @param[out] is_burst_shot @c true if the media is a burst shot image,
* otherwise @c false if the media is not a burst shot image
*
* @brief Sets an orientation of the image.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] image The image metadata handle
+ * @param[in] image The handle to the image metadata
* @param[in] orientation The image orientation
*
* @return @c 0 on success,
*
* @remarks Do not call this function in callback function of foreach function like media_info_foreach_media_from_db().
*
- * @param[in] image The handle to the image
+ * @param[in] image The handle to the image metadata
*
* @return @c 0 on success,
* otherwise a negative error value
}
#endif /* __cplusplus */
-#endif /*__TIZEN_IMAGE_META_H__*/
+#endif /*__TIZEN_CONTENT_MEDIA_IMAGE_H__*/
*/
-#ifndef __TIZEN_MEDIA_INFORMATION_H__
-#define __TIZEN_MEDIA_INFORMATION_H__
+#ifndef __TIZEN_CONTENT_MEDIA_INFO_H__
+#define __TIZEN_CONTENT_MEDIA_INFO_H__
#include <media_content_type.h>
/**
* @file media_info.h
- * @brief This file contains the media info API and related functions to proceed with it. \n
+ * @brief This file contains the media info function and related functions to proceed with it. \n
* You can use the functions to insert, delete, count and get list of content files from media database. \n
* You can get properties of content file such as size, mime_type, modified_time etc. And you can set properties such as provider, favorite etc. \n
* And you can get bookmark, face, tag info related the content file.
/**
* @brief Inserts the content file into the media database.
- * @details In general, you can use this API to insert content files into the media database. \n
- * You can use media_content_scan_file()/media_content_scan_folder() API instead of this API.
+ * @details In general, you can use this function to insert content files into the media database. \n
+ * You can use media_content_scan_file()/media_content_scan_folder() function instead of this function.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* %http://tizen.org/privilege/mediastorage \n
* %http://tizen.org/privilege/externalstorage
*
- * @remarks You must release the handle using media_info_destroy(). \n
+ * @remarks The @a info should be released using media_info_destroy(). \n
* You must add privilege http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path. \n
- * If you want to access only internal storage by using this API, you should add privilege http://tizen.org/privilege/mediastorage. \n
- * Or if you want to access only external storage by using this API, you should add privilege http://tizen.org/privilege/externalstorage. \n
+ * If you want to access only internal storage by using this function, you should add privilege http://tizen.org/privilege/mediastorage. \n
+ * Or if you want to access only external storage by using this function, you should add privilege http://tizen.org/privilege/externalstorage. \n
* If you can access both storage, you must add all privilege.
* @remarks Since 4.0, this function is related to the following feature:\n
* %http://tizen.org/feature/content.scanning.others\n
* If this feature is not suppported on the device, MEDIA_CONTENT_TYPE_OTHERS type file is not scanned.
*
- * @param[in] path The path of the content file to add
+ * @param[in] path The path of the content file to add
* @param[out] info The handle of the inserted content file
*
* @return @c 0 on success,
* %http://tizen.org/privilege/externalstorage
*
* @remarks You must add privilege http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path. \n
- * If you want to access only internal storage by using this API, you should add privilege http://tizen.org/privilege/mediastorage. \n
- * Or if you want to access only external storage by using this API, you should add privilege http://tizen.org/privilege/externalstorage. \n
+ * If you want to access only internal storage by using this function, you should add privilege http://tizen.org/privilege/mediastorage. \n
+ * Or if you want to access only external storage by using this function, you should add privilege http://tizen.org/privilege/externalstorage. \n
* If you can access both storage, you must add all privilege.
* @remarks Since 4.0, this function is related to the following feature:\n
* %http://tizen.org/feature/content.scanning.others\n
* If this feature is not suppported on the device, MEDIA_CONTENT_TYPE_OTHERS type file is not scanned.
*
- * @param[in] path_array The path array of the content files to add
+ * @param[in] path_array The path array of the content files to add
* @param[in] array_length The length of the array
- * @param[in] callback The callback to be invoked when media items inserted completely
- * @param[in] user_data The user data to be passed to the callback function
+ * @param[in] callback The callback function to be invoked when media items inserted completely
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
* %http://tizen.org/privilege/externalstorage
*
* @remarks You must add privilege http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path. \n
- * If you want to access only internal storage with this API, you should add privilege http://tizen.org/privilege/mediastorage. \n
- * Or if you want to access only external storage with this API, you should add privilege http://tizen.org/privilege/externalstorage. \n
+ * If you want to access only internal storage with this function, you should add privilege http://tizen.org/privilege/mediastorage. \n
+ * Or if you want to access only external storage with this function, you should add privilege http://tizen.org/privilege/externalstorage. \n
* If you can access both storage, you must add all privilege.
*
- * @param[in] path_array The path array of the burst shot images to add
+ * @param[in] path_array The path array of the burst shot images to add
* @param[in] array_length The length of the array
- * @param[in] callback The callback to be invoked when the images are inserted completely
- * @param[in] user_data The user data to be passed to the callback function
+ * @param[in] callback The callback function to be invoked when the images are inserted completely
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Deletes the media information from the media database.
* @details This function only remove media information in the media database. \n
- * You can use media_content_scan_file()/media_content_scan_folder() API instead of this API if file is removed from the file system.
+ * You can use media_content_scan_file()/media_content_scan_folder() function instead of this function if file is removed from the file system.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @param[in] media_id The media ID. It can get from media info handle.
+ * @param[in] media_id The media ID. It can get from media info handle.
*
* @return @c 0 on success,
* otherwise a negative error value
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @param[in] filter The filter handle
+ * @param[in] filter The handle to the media filter
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release the destination handle using media_info_destroy().
+ * @remarks The @a dst should be released using media_info_destroy().
*
- * @param[out] dst The destination handle to the media info
- * @param[in] src The source handle to media info
+ * @param[out] dst The destination handle to the media info
+ * @param[in] src The source handle to the media info
*
* @return @c 0 on success,
* otherwise a negative error value
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
*
- * @param[in] filter The handle to filter
+ * @param[in] filter The handle to the media filter
* @param[out] media_count The count of media
*
* @return @c 0 on success,
* So, your callback function is in read state in SQLite. When you are in read state, sometimes you do not update DB.
* We do not recommend you call updating DB function in callback of foreach function.
*
- * @param[in] filter The media info handle filter
- * @param[in] callback The callback function to be invoked
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media_id The ID of the media info
- * @param[in] filter The handle to the media filter
+ * @param[in] media_id The media ID
+ * @param[in] filter The handle to the media filter
* @param[out] tag_count The count of the media tag
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media_id The ID of the media info
- * @param[in] filter The handle to the media filter
- * @param[in] callback The callback function to be invoked
+ * @param[in] media_id The media ID
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media_id The ID of the media info
- * @param[in] filter The handle to the media filter
- * @param[out] bookmark_count The count of the media tag
+ * @param[in] media_id The media ID
+ * @param[in] filter The handle to the media filter
+ * @param[out] bookmark_count The count of the media tag
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media_id The ID of the media info
- * @param[in] filter The handle to the media filter
- * @param[in] callback The callback function to be invoked
+ * @param[in] media_id The media ID
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
*
* @since_tizen 3.0
*
- * @param[in] media_id media id
- * @param[in] filter The handle to the media filter
+ * @param[in] media_id The media ID
+ * @param[in] filter The handle to the media filter
* @param[out] face_count The count of media face
*
* @return 0 on success, otherwise a negative error value.
int media_info_get_face_count_from_db(const char *media_id, filter_h filter, int *face_count);
/**
- * @brief Iterates through the media files with optional @a media_id in the given @a face @a face from the media database.
+ * @brief Iterates through the media files with optional @a filter in the given @a media_id from the media database.
* @details This function gets all media face info associated with the given media id and
* meeting desired filter option and calls @a callback for
* every retrieved media face info. If NULL is passed to the @a filter, no filtering is applied.
*
* @since_tizen 3.0
*
- * @param [in] media_id media id
- * @param[in] filter The handle to the media filter
- * @param [in] callback The callback function to invoke
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] media_id The media ID
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to invoke
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
*
int media_info_foreach_face_from_db(const char *media_id, filter_h filter, media_face_cb callback, void *user_data);
/**
- * @brief Gets the image metadata handle for a given media info
+ * @brief Gets the image metadata handle for a given media info.
* @details This function returns an image metadata handle retrieved from the media info.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release the @a image handle using image_meta_destroy().
+ * @remarks The @a image should be released using image_meta_destroy().
*
- * @param[in] media The media info handle
- * @param[out] image A handle to image metadata
+ * @param[in] media The handle to the media info
+ * @param[out] image The handle to the image metadata
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release the @a video handle using video_meta_destroy().
+ * @remarks The @a video should be released using video_meta_destroy().
*
- * @param[in] media The media info handle
- * @param[out] video A handle to the video meta
+ * @param[in] media The handle to the media info
+ * @param[out] video The handle to the video metadata
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release the @a audio handle using audio_meta_destroy().
+ * @remarks The @a audio should be released using audio_meta_destroy().
*
- * @param[in] media The media info handle
- * @param[out] audio A handle to the audio meta
+ * @param[in] media The handle to the media info
+ * @param[out] audio The handle to the audio metadata
*
* @return @c 0 on success,
* otherwise a negative error value
int media_info_get_audio(media_info_h media, audio_meta_h *audio);
/**
- * @brief Gets the media ID
+ * @brief Gets the media ID.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @remarks The @a media_id should be released using free().
*
- * @param[in] media The media info handle
- * @param[out] media_id The media ID
+ * @param[in] media The handle to the media info
+ * @param[out] media_id The media ID
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the full path of the content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a path using free().
+ * @remarks The @a path should be released using free().
*
- * @param[in] media The media info handle
- * @param[out] path The full path of the content file
+ * @param[in] media The handle to the media info
+ * @param[out] path The full path of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the file name including the extension of the content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a name using free().
+ * @remarks The @a name should be released using free().
*
- * @param[in] media The media info handle
- * @param[out] name The file name including the extension of the content file
+ * @param[in] media The handle to the media info
+ * @param[out] name The file name including the extension of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the content type of the content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
- * @param[out] type The content type of the content file (#media_content_type_e)
+ * @param[in] media The handle to the media info
+ * @param[out] type The content type of the content file (#media_content_type_e)
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the MIME type of the content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a mime_type using free().
+ * @remarks The @a mime_type should be released using free().
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] mime_type The MIME type of the content file
*
* @return @c 0 on success,
* @brief Gets the content file size.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
- * @param[out] size The content file size
+ * @param[in] media The handle to the media info
+ * @param[out] size The content file size
*
* @return @c 0 on success,
* otherwise a negative error value
* @details The added time refers to the time that content file was first added to media database.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] added_time The added time to the media database
*
* @return @c 0 on success,
* @details The modified time refers to the last modification time provided by the file system.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
- * @param[out] time The last modification time of the content file
+ * @param[in] media The handle to the media info
+ * @param[out] time The last modification time of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
* Otherwise, timeline value is the same as modified time.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
- * @param[out] time The timeline of content file
+ * @param[in] media The handle to the media info
+ * @param[out] time The timeline of content file
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the thumbnail path of content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a path using free(). \n
- * If the thumbnail extraction for the given media has not been requested yet, this API returns NULL. To create a thumbnail, you should use media_info_create_thumbnail() API. \n
+ * @remarks The @a path should be released using free(). \n
+ * If the thumbnail extraction for the given media has not been requested yet, this function returns NULL. To create a thumbnail, you should use media_info_create_thumbnail() function. \n
* Since 3.0, this function returns an empty string if media_info_create_thumbnail() has failed to create a thumbnail for the given media.
*
- * @param[in] media The media info handle
- * @param[out] path The thumbnail path
+ * @param[in] media The handle to the media info
+ * @param[out] path The thumbnail path
*
* @return @c 0 on success,
* otherwise a negative error value
* Since 3.0, if the media info has no description, the method returns empty string.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a description using free().
+ * @remarks The @a description should be released using free().
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] description The description of the content file
*
* @return @c 0 on success,
* @brief Gets the longitude of content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] longitude The longitude of the content file
*
* @return @c 0 on success,
* @brief Gets the latitude of content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] latitude The latitude of the content file
*
* @return @c 0 on success,
* @brief Gets the altitude of content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] altitude The altitude of the content file
*
* @return @c 0 on success,
* @deprecated Deprecated since 4.0.
* @brief Gets the weather of content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @remarks The @a weather should be released using free().
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] weather The weather of the content file
*
* @return @c 0 on success,
* @brief Gets the rating of content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] rating The rating of the content file
*
* @return @c 0 on success,
* @brief Gets the favorite status of content file which User set.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
- * @param[out] favorite @c true if content file is set as favorite,
+ * @param[in] media The handle to the media info
+ * @param[out] favorite @c true if content file is set as favorite,
* otherwise @c false if content file is not set as favorite
*
* @return @c 0 on success,
* @brief Gets the author of content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a author using free().
+ * @remarks The @a author should be released using free().
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] author The author of the content file
*
* @return @c 0 on success,
* @brief Gets the provider of content file which User set.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a provider using free().
+ * @remarks The @a provider should be released using free().
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] provider The provider of the content file
*
* @return @c 0 on success,
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*
- * @see media_info_set_provider()
*/
int media_info_get_provider(media_info_h media, char **provider) TIZEN_DEPRECATED_API;
* @brief Gets the content name of content file which User set.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a content_name using free().
+ * @remarks The @a content_name should be released using free().
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] content_name The content name of the content file
*
* @return @c 0 on success,
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*
- * @see media_info_set_content_name()
*/
int media_info_get_content_name(media_info_h media, char **content_name) TIZEN_DEPRECATED_API;
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a title using free().
+ * @remarks The @a title should be released using free().
*
- * @param[in] media The media info handle
- * @param[out] title The title of the content file
+ * @param[in] media The handle to the media info
+ * @param[out] title The title of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the category of content file which User set.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a category using free().
+ * @remarks The @a category should be released using free().
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] category The category of the content file
*
* @return @c 0 on success,
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*
- * @see media_info_set_category()
*/
int media_info_get_category(media_info_h media, char **category) TIZEN_DEPRECATED_API;
* @brief Gets the location tag of content file which User set.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a location_tag using free().
+ * @remarks The @a location_tag should be released using free().
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] location_tag The location of the content file
*
* @return @c 0 on success,
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*
- * @see media_info_set_location_tag()
*/
int media_info_get_location_tag(media_info_h media, char **location_tag) TIZEN_DEPRECATED_API;
* @brief Gets the age_rating of content file which User set.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a age_rating using free().
+ * @remarks The @a age_rating should be released using free().
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] age_rating The age rating of the content file
*
* @return @c 0 on success,
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*
- * @see media_info_set_age_rating()
*/
int media_info_get_age_rating(media_info_h media, char **age_rating) TIZEN_DEPRECATED_API;
* @brief Gets the keyword of content file which User set.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a keyword using free().
+ * @remarks The @a keyword should be released using free().
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] keyword The keyword of the content file
*
* @return @c 0 on success,
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*
- * @see media_info_set_keyword()
*/
int media_info_get_keyword(media_info_h media, char **keyword) TIZEN_DEPRECATED_API;
* @brief Gets the storage id of content file.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks You must release @a storage_id using free().
+ * @remarks The @a storage_id should be released using free().
*
- * @param[in] media The media info handle
- * @param[out] storage_id The storage id of the content file
+ * @param[in] media The handle to the media info
+ * @param[out] storage_id The ID of the media storage
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Checks whether the media is protected via DRM.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] is_drm @c true if media is DRM media,
* otherwise @c false if media is not DRM media
*
* @brief Checks whether the content file is 360 content.
* @since_tizen 3.0
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] is_360 @c true if media is 360 content,
* otherwise @c false if media is not 360 content
*
* @brief Gets the storage type of content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] storage_type The storage type of the content file
*
* @return @c 0 on success,
* @brief Gets number which represents how many times given content has been played.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @param [in] media The handle to media info
- * @param [out] played_count The counter of content played
+ * @param[in] media The handle to the media info
+ * @param[out] played_count The counter of content played
*
* @return 0 on success,
* otherwise a negative error value
* starting from the beginning of the track.
* @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
+ * @param[in] media The handle to the media info
+ * @param[out] played_time The elapsed time of the content
*
* @return 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a media using media_tag_destroy().
+ * @remarks The @a media should be released using media_info_destroy().
*
- * @param[in] media_id The ID of media info
- * @param[out] media The media handle associated with the media ID
+ * @param[in] media_id The media ID
+ * @param[out] media The handle to the media info
*
* @return @c 0 on success,
* otherwise a negative error value
* @details You can increase the played(opened) count of the content file.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @param [in] media The handle to media info
+ * @param[in] media The handle to the media info
*
* @return 0 on success,
* otherwise a negative error value
* @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
*
- * @param [in] media The handle to media info
+ * @param[in] media The handle to the media info
*
* @return 0 on success,
* otherwise a negative error value
* @brief Sets the file name including the extension of the content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] display_name The file name including the extension of the content file.
*
* @return @c 0 on success,
* @brief Sets the description of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] description The description of the media info
*
* @return @c 0 on success,
* @brief Sets the longitude of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] longitude The longitude of the media info
*
* @return @c 0 on success,
* @brief Sets the latitude of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] latitude The latitude of the media info
*
* @return @c 0 on success,
* @brief Sets the altitude of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] altitude The altitude of the media info
*
* @return @c 0 on success,
* @brief Sets the weather of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] weather The weather of the media info
*
* @return @c 0 on success,
* @brief Sets the rating of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] rating The rating of the media info
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] favorite Set @c true to set the media info as favorite,
* otherwise set @c false to not set the media info as favorite
*
* @brief Sets the author of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] author The author of the media info
*
* @return @c 0 on success,
* @brief Sets the provider of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] provider The provider of the media info
*
* @return @c 0 on success,
* @brief Sets the content name of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] content_name The content name of the media info
*
* @return @c 0 on success,
* @brief Sets the category of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] category The category of the media info
*
* @return @c 0 on success,
* @brief Sets the location tag of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] location_tag The location of the media info
*
* @return @c 0 on success,
* @brief Sets the age rating of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] age_rating The age rating of the media info
*
* @return @c 0 on success,
* @brief Sets the keyword of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] keyword The keyword of the media info
*
* @return @c 0 on success,
* 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.
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @see media_content_connect()
* @see media_info_set_favorite()
- * @see media_info_set_provider()
- * @see media_info_set_category()
- * @see media_info_set_location_tag()
- * @see media_info_set_age_rating()
*/
int media_info_update_to_db(media_info_h media);
* %http://tizen.org/privilege/externalstorage
*
* @remarks You must add privilege http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path. \n
- * If you want to access only internal storage by using this API, you should add privilege http://tizen.org/privilege/mediastorage. \n
- * Or if you want to access only external storage by using this API, you should add privilege http://tizen.org/privilege/externalstorage. \n
+ * If you want to access only internal storage by using this function, you should add privilege http://tizen.org/privilege/mediastorage. \n
+ * Or if you want to access only external storage by using this function, you should add privilege http://tizen.org/privilege/externalstorage. \n
* If you can access both storage, you should add all privilege.
*
- * @param[in] media_id The ID of the media info
+ * @param[in] media_id The media ID
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Sets the added time of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] added_time The added time of the media info
*
* @return @c 0 on success,
/**
* @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. \n
- * If the source path and destination path are the same, then this API does nothing.
- * If you want to refresh media information, you should use media_content_scan_file() API.
+ * If the source path and destination path are the same, then this function does nothing.
+ * If you want to refresh media information, you should use media_content_scan_file() function.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* %http://tizen.org/privilege/externalstorage
*
* @remarks You must add privilege http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path. \n
- * If you want to access only internal storage by using this API, you should add privilege http://tizen.org/privilege/mediastorage. \n
- * Or if you want to access only external storage by using this API, you should add privilege http://tizen.org/privilege/externalstorage. \n
+ * If you want to access only internal storage by using this function, you should add privilege http://tizen.org/privilege/mediastorage. \n
+ * Or if you want to access only external storage by using this function, you should add privilege http://tizen.org/privilege/externalstorage. \n
* If you can access both storage, you should add all privilege. \n
- * This API does not support USB storage.
+ * This function does not support USB storage.
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] dst_path The path of destination
*
* @return @c 0 on success,
* Since 3.0, if creation of a thumbnail is failed, empty string will be passed through media_thumbnail_completed_cb().
* Items in external storage except MMC not supported.
*
- * @param[in] media The media info handle
- * @param[in] callback The callback function to be invoked
+ * @param[in] media The handle to the media info
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @remarks If you request cancel for the already thumbnail created media, this API return MEDIA_CONTENT_ERROR_INVALID_OPERATION
+ * @remarks If you request cancel for the already thumbnail created media, this function return MEDIA_CONTENT_ERROR_INVALID_OPERATION
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
*
* @return @c 0 on success,
* otherwise a negative error value
* If face detection fails, the @a face_count argument in media_face_detection_completed_cb() will be set to 0.
* Media items in external storage are not supported, with the exception of MMC items.
*
- * @param[in] media The media info handle
- * @param[in] callback The callback function to be invoked when detection is completed
+ * @param[in] media The handle to the media info
+ * @param[in] callback The callback function to be invoked when detection is completed
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* @ingroup CAPI_CONTENT_MEDIA_FACE_DETECTION_MODULE
* @brief Cancels face detection of image for the given media.
* @details This function cancels face detection for given media item. \n
- * If you cancel face detection request before callback is invoked, the callback registered by media_info_start_face_detection() API will not be invoked.
+ * If you cancel face detection request before callback is invoked, the callback registered by media_info_start_face_detection() function will not be invoked.
*
* @since_tizen 3.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @remarks If face detection is already done when you request the cancellation, this API return MEDIA_CONTENT_ERROR_INVALID_OPERATION
+ * @remarks If face detection is already done when you request the cancellation, this function return MEDIA_CONTENT_ERROR_INVALID_OPERATION
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
*
* @return @c 0 on success,
* otherwise a negative error value
/**
* @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.
+ * @details If the information about the file that is already known, you can use this function to generate empty handler.
* @since_tizen 3.0
*
*
* @privilege %http://tizen.org/privilege/mediastorage \n
- * %http://tizen.org/privilege/externalstorage
+ * %http://tizen.org/privilege/externalstorage
*
- * @remarks If you want to access only internal storage with this API, you should add privilege http://tizen.org/privilege/mediastorage. \n
- * Or if you want to access only external storage with this API, you should add privilege http://tizen.org/privilege/externalstorage. \n
+ * @remarks The @a media should be released using media_info_destroy().
+ * @remarks If you want to access only internal storage with this function, you should add privilege http://tizen.org/privilege/mediastorage. \n
+ * Or if you want to access only external storage with this function, you should add privilege http://tizen.org/privilege/externalstorage. \n
* If you can access both storage, you must add all privilege.
*
* @param[in] path The path to create the media info handle
- * @param[out] media The media info handle
+ * @param[out] media The handle to the media info
*
* @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_DB_FAILED DB operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB operation failed
* @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
- * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
*
* @see media_info_destroy()
*/
* @brief Inserts media info to database with media info data.
* @since_tizen 3.0
*
- * @remarks You must release @a info using media_info_destroy().
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @param[in] media The media info handle to be inserted
+ * @remarks The @a media should be released using media_info_destroy().
+ *
+ * @param[in] media The handle to the media info
*
* @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_DB_FAILED DB operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB operation failed
* @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
*/
int media_info_insert_to_db_with_data(media_info_h media) TIZEN_DEPRECATED_API;
* @brief Sets the title of media info handle.
* @since_tizen 3.0
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] title The title of media info handle
*
* @return @c 0 on success,
* @brief Sets the album of media info handle.
* @since_tizen 3.0
*
- * @param[in] media The media info handle
- * @param[in] album The album of media info handle
+ * @param[in] media The handle to the media info
+ * @param[in] album The album of the media
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Sets the artist of media info handle.
* @since_tizen 3.0
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] artist The artist of media info handle
*
* @return @c 0 on success,
* @brief Sets the genre of media info handle.
* @since_tizen 3.0
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] genre The genre of media info handle
*
* @return @c 0 on success,
* @brief Sets the recorded date of media info handle.
* @since_tizen 3.0
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] recorded_date The recorded date of media info handle
*
* @return @c 0 on success,
}
#endif /* __cplusplus */
-#endif /* __TIZEN_MEDIA_INFORMATION_H__ */
+#endif /* __TIZEN_CONTENT_MEDIA_INFO_H__ */
*/
-#ifndef __TIZEN_MEDIA_INFO_PRIVATE_H__
-#define __TIZEN_MEDIA_INFO_PRIVATE_H__
+#ifndef __TIZEN_CONTENT_MEDIA_INFO_PRIVATE_H__
+#define __TIZEN_CONTENT_MEDIA_INFO_PRIVATE_H__
#include <unistd.h>
int _media_db_get_storage(filter_h filter, media_storage_cb callback, void *user_data);
int _media_db_get_storage_id_by_media_id(const char *media_id, char *storage_id);
-/**
- * @internal
- * @brief Creates a media filter attribute handle.
- * @details This function creates a media filter attribute handle. The handle can be
- * used to convert to attributes of database from attributes of user.
- * @remarks The @a handle must be released with media_filter_attribute_destory() by you.
- * @param[out] filter A handle to media filter attribute
- * @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
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
- * @see media_filter_attribute_destory()
- *
- */
int _media_filter_attribute_create(attribute_h *attr);
-
-/**
- * @internal
- * @brief Add the attributes to the handle.
- * @details This function add the attribute to handle.
- * @param[in] filter The handle to media filter attribute
- * @param[in] user_attr The user attribute
- * @param[in] platform_attr The platform attribute
- * @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
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
- * @see media_filter_attribute_remove()
- *
- */
int _media_filter_attribute_add(attribute_h atrr, const char *user_attr, const char *platform_attr);
-
-/**
- * @internal
- * @brief Destroys a media filter attribute handle.
- * @details The function frees all resources related to the media filter attribute handle. The filter attribute
- * handle no longer can be used to perform any operation. A new handle
- * has to be created before the next usage.
- *
- * @param[in] filter The handle to media filter attribute
- * @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_PERMISSION_DENIED Permission denied
- * @see media_filter_create()
- *
- */
int _media_filter_attribute_destory(attribute_h attr);
-
-/**
- * @internal
- * @brief Replace to platform attributes from user attributes.
- * @details This function replace to platform attributes from user attributes to generate the WHERE clause
- * @param[in] filter The handle to media filter attribute
- * @param[in] user_attr The user attribute
- * @param[in] platform_attr The platform attribute
- * @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
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
- * @see media_filter_attribute_create()
- * @see media_filter_attribute_destory()
- *
- */
int _media_filter_attribute_generate(attribute_h attr, filter_h filter, char **generated_condition);
-
-/**
- * @internal
- * @brief Replace to platform attributes from user attributes.
- * @details This function replace to platform attributes from user attributes to generate the WHERE clause
- * @param[in] filter The handle to media filter attribute
- * @param[in] attr The attribute
- * @param[in] generated_option The handle to generated option
- * @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_DB_FAILED Filed DB
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
- * @see media_filter_attribute_create()
- * @see media_filter_attribute_destory()
- *
- */
-
int _media_filter_attribute_option_generate(attribute_h attr, filter_h filter, char **generated_option);
-
int _media_filter_attribute_option_generate_with_full_query(attribute_h attr, filter_h filter, char **generated_option);
#ifdef __cplusplus
}
#endif /* __cplusplus */
-#endif /*__TIZEN_MEDIA_INFO_PRIVATE_H__*/
+#endif /*__TIZEN_CONTENT_MEDIA_INFO_PRIVATE_H__*/
* limitations under the License.
*/
-#ifndef __TIZEN_MEDIA_PLAYLIST_H__
-#define __TIZEN_MEDIA_PLAYLIST_H__
+#ifndef __TIZEN_CONTENT_MEDIA_PLAYLIST_H__
+#define __TIZEN_CONTENT_MEDIA_PLAYLIST_H__
#include <media_content_type.h>
* @brief Gets the number of playlists for the passed @a filter from the media database.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] filter The handle to the filter
+ * @param[in] filter The handle to the media filter
* @param[out] playlist_count The count of the media playlist
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] filter The handle to the audio filter
- * @param[in] callback The callback function to be invoked
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* @brief Gets the number of the media info for the given playlist present in the media database.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] playlist_id The ID of the media playlist
- * @param[in] filter The media filter handle
- * @param[out] media_count The number of media items
+ * @param[in] playlist_id The ID of the media playlist
+ * @param[in] filter The handle to the media filter
+ * @param[out] media_count The number of media items
*
* @return @c 0 on success,
* otherwise a negative error value
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[in] playlist_id The ID of the media playlist
- * @param[in] filter The audio filter handle
- * @param[in] callback The callback function to be invoked
- * @param[in] user_data The user data to be passed to the callback function
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @remarks You must release the created handle using media_playlist_destroy().
+ * @remarks The @a playlist should be released using media_playlist_destroy().
*
- * @param[in] name The name of the inserted playlist
- * @param[out] playlist A created handle to media playlist
+ * @param[in] name The name of the inserted playlist
+ * @param[out] playlist The handle to the media playlist
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a playlist using media_playlist_destroy().
+ * @remarksThe @a playlist should be released using media_playlist_destroy().
*
- * @param[in] playlist_id The ID of the media playlist
- * @param[out] playlist The media playlist handle associated with the playlist ID
+ * @param[in] playlist_id The ID of the media playlist
+ * @param[out] playlist The handle to the media playlist
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] playlist The media playlist handle
+ * @param[in] playlist The handle to the media playlist
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks The destination handle must be released using media_playlist_destroy().
+ * @remarks The @ a dst should be released using media_playlist_destroy().
*
- * @param[in] src The source handle of a media playlist
- * @param[out] dst The destination handle to a media playlist
+ * @param[out] dst The destination handle to the media playlist
+ * @param[in] src The source handle to the media playlist
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the media playlist ID.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] playlist The media playlist handle
+ * @param[in] playlist The handle to the media playlist
* @param[out] playlist_id The ID of the media playlist
*
* @return @c 0 on success,
* @brief Gets a name of the playlist.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a playlist_name using free().
+ * @remarks The @a playlist_name should be released using free().
*
- * @param[in] playlist The media playlist handle
+ * @param[in] playlist The handle to the media playlist
* @param[out] playlist_name The playlist name
*
* @return @c 0 on success,
* @brief Sets the name of the playlist.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] playlist The media playlist handle
+ * @param[in] playlist The handle to the media playlist
* @param[in] playlist_name The name of the media playlist
*
* @return @c 0 on success,
* @brief Gets a thumbnail path of the playlist.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a path using free().
+ * @remarks The @a path should be released using free().
*
- * @param[in] playlist The media playlist handle
- * @param[out] path The path of the thumbnail
+ * @param[in] playlist The handle to the media playlist
+ * @param[out] path The path of the thumbnail
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Sets the thumbnail path of the playlist.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] playlist The media playlist handle
- * @param[in] path The path of the thumbnail
+ * @param[in] playlist The handle to the media playlist
+ * @param[in] path The path of the thumbnail
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Sets the playing order in the playlist.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] playlist The media playlist handle
- * @param[in] playlist_member_id The playlist member ID
- * @param[in] play_order The playing order
+ * @param[in] playlist The handle to the media playlist
+ * @param[in] playlist_member_id The ID of the playlist member
+ * @param[in] play_order The playing order
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Adds a new media info to the playlist.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] playlist The media playlist handle
- * @param[in] media_id The ID to the media info which is added
+ * @param[in] playlist The handle to the media playlist
+ * @param[in] media_id The media ID
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Removes the playlist members related with the media from the given playlist.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] playlist The media playlist handle
- * @param[in] playlist_member_id The playlist member ID
+ * @param[in] playlist The handle to the media playlist
+ * @param[in] playlist_member_id The ID of the playlist member
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the played order of the playlist.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] playlist The media playlist handle
- * @param[in] playlist_member_id The playlist member ID
- * @param[out] play_order The played order
+ * @param[in] playlist The handle to the media playlist
+ * @param[in] playlist_member_id The ID of the playlist member
+ * @param[out] play_order The played order
*
* @return @c 0 on success,
* otherwise a negative error value
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @param[in] playlist The media playlist handle
+ * @param[in] playlist The handle to the media playlist
*
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Imports the playlist from m3u playlist file.
- * @details This api reads a playlist from the m3u playlist file and insert into the db.
+ * @details This function reads a playlist from the m3u playlist file and insert into the db.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
+ * @remarks The @ a playlist should be released using media_playlist_destroy().
* @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
- * This api does not support the file of extended m3u playlist.
+ * This function does not support the file of extended m3u playlist.
*
- * @param[in] playlist_name The name of the playlist to save
+ * @param[in] playlist_name The name of the media playlist to save
* @param[in] path The path to import the playlist file
- * @param[out] playlist The media playlist handle
+ * @param[out] playlist The handle to the media playlist
*
* @return @c 0 on success,
* otherwise a negative error value
* @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
*
- * @param[in] playlist The media playlist handle
+ * @param[in] playlist The handle to the media playlist
* @param[in] path path The path to export the playlist
*
* @return @c 0 on success,
#ifdef __cplusplus
}
#endif /* __cplusplus */
-#endif /*__TIZEN_MEDIA_PLAYLIST_H__*/
+#endif /*__TIZEN_CONTENT_MEDIA_PLAYLIST_H__*/
*/
-#ifndef __TIZEN_MEDIA_STORAGE_H__
-#define __TIZEN_MEDIA_STORAGE_H__
+#ifndef __TIZEN_CONTENT_MEDIA_STORAGE_H__
+#define __TIZEN_CONTENT_MEDIA_STORAGE_H__
#include <media_content_type.h>
* @brief Gets media storage from database.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
-* @remarks You must release the handle using media_storage_destroy(). \n
+* @remarks The @a storage should be released using media_storage_destroy().
*
-* @param[in] storage_id The storage id to get media storage info
+* @param[in] storage_id The ID of the media storage
* @param[out] storage The media storage handle
*
* @return @c 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
-* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
-* @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
-* @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
+* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
+* @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
+* @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
* @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
-
*
* @pre This function requires opened connection to content service by media_content_connect().
*
* @brief Gets the count of media storage for the passed @a filter from the media database.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
-* @param[in] filter The handle to filter
+* @param[in] filter The handle to the media filter
* @param[out] storage_count The count of storage
*
* @return @c 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
* @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_DB_FAILED DB Operation failed
+* @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
* @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
*
* @pre This function requires opened connection to content service by media_content_connect().
*
* @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
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
int media_storage_foreach_storage_from_db(filter_h filter, media_storage_cb callback, void *user_data);
/**
- * @brief Gets the count of media files for the passed @a filter in the given @a storage from the media database.
+ * @brief Gets the count of media files for the passed @a filter in the given @a storage_id from the media database.
* @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
+ * @param[in] storage_id The ID of the media storage
+ * @param[in] filter The handle to the media filter
* @param[out] media_count The count of media storage items
*
* @return @c 0 on success,
int media_storage_get_media_count_from_db(const char *storage_id, filter_h filter, int *media_count);
/**
- * @brief Iterates through the media files with an optional @a filter in the given @a storage from the media database.
+ * @brief Iterates through the media files with an optional @a filter in the given @a storage_id from the media database.
* @details This function gets all media files associated with the given storage and
* meeting desired filter option and calls @a callback for
* every retrieved media item. If @c NULL is passed to the @a filter, no filtering is applied.
* We do not recommend you call updating DB function in callback of foreach function.
*
* @param[in] storage_id The ID of the media storage
- * @param[in] filter The handle to the media info filter
- * @param[in] callback The callback function to be invoked
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @param[in] storage The media storage handle
+ * @param[in] storage The media storage handle
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks You must release the destination handle using media_storage_destroy().
+ * @remarksThe @a dst should be released using media_storage_destroy().
*
- * @param[out] dst The destination handle to the media storage
- * @param[in] src The source handle to media storage
+ * @param[out] dst The destination handle to the media storage
+ * @param[in] src The source handle to the media storage
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the storage id of media storage.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks You must release @a storage_id using free().
+ * @remarks The @a storage_id should be released using free().
*
- * @param[in] storage The media storage handle
- * @param[out] storage_id The storage id of the media storage
+ * @param[in] storage The media storage handle
+ * @param[out] storage_id The ID of the media storage
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the storage name of media storage.
* @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.
+ * @remarks The @a storage_name should be released using free().
+ * If the requested storage is not the cloud storage, this function returns NULL.
*
- * @param[in] storage The media storage handle
- * @param[out] storage_name The storage name of the media storage
+ * @param[in] storage The media storage handle
+ * @param[out] storage_name The storage name of the media storage
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the storage path of media storage.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks You must release @a storage_path using free().
+ * @remarks The @a storage_path should be released using free().
*
- * @param[in] storage The media storage handle
- * @param[out] storage_path The storage path of the media storage
+ * @param[in] storage The media storage handle
+ * @param[out] storage_path The storage path of the media storage
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the storage type of media storage.
* @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
+ * @param[in] storage The media storage handle
+ * @param[out] storage_type The storage type of the media storage
*
* @return @c 0 on success,
* otherwise a negative error value
}
#endif /* __cplusplus */
-#endif /* __TIZEN_MEDIA_STORAGE_H__ */
+#endif /* __TIZEN_CONTENT_MEDIA_STORAGE_H__ */
-#ifndef __TIZEN_MEDIA_TAG_H__
-#define __TIZEN_MEDIA_TAG_H__
+#ifndef __TIZEN_CONTENT_MEDIA_TAG_H__
+#define __TIZEN_CONTENT_MEDIA_TAG_H__
#include <media_content_type.h>
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @remarks The created tag handle must be released using media_tag_destroy().
+ * @remarks The @a tag should be released using media_tag_destroy().
*
- * @param[in] tag_name The tag name to be inserted
- * @param[out] tag The created handle to the media tag
+ * @param[in] tag_name The tag name to be inserted
+ * @param[out] tag The handle to the media tag
*
* @return @c 0 on success,
* otherwise a negative error value
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @param[in] tag_id The ID of media tag
+ * @param[in] tag_id The ID of the media tag
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the count of the tag for the passed @a filter from the media database.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] filter The handle to the filter
+ * @param[in] filter The handle to the media filter
* @param[out] tag_count The count of the media tag
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] filter The tag filter handle
- * @param[in] callback The callback function to be invoked
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
int media_tag_foreach_tag_from_db(filter_h filter, media_tag_cb callback, void *user_data);
/**
- * @brief Gets the number of media files for the passed @a filter in the given @a tag from the media database.
+ * @brief Gets the number of media files for the passed @a filter in the given @a tag_id from the media database.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] tag_id The ID of the media tag
- * @param[in] filter The handle to the media filter
+ * @param[in] tag_id The ID of the media tag
+ * @param[in] filter The handle to the media filter
* @param[out] media_count The count of media items
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] tag_id The ID of the media tag
- * @param[in] filter The handle to the media filter
- * @param[in] callback The callback function to be invoked
+ * @param[in] tag_id The ID of the media tag
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release the destination handle using media_tag_destroy().
+ * @remarks The @a dst should be released using media_tag_destroy().
*
* @param[out] dst The destination handle to the media tag
- * @param[in] src The source handle to the media tag
+ * @param[in] src The source handle to the media tag
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] tag The media tag handle
+ * @param[in] tag The handle to the media tag
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the media tag ID.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] tag The media tag handle
- * @param[out] tag_id The ID of the media tag
+ * @param[in] tag The handle to the media tag
+ * @param[out] tag_id The ID of the media tag
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the tag name.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a tag_name using free().
+ * @remarks The @a tag_name should be released using free().
*
- * @param[in] tag The media tag handle
- * @param[out] tag_name The name of the tag
+ * @param[in] tag The handle to the media tag
+ * @param[out] tag_name The name of the media tag
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a folder using media_tag_destroy().
+ * @remarksThe @a tag should be released using media_tag_destroy().
*
- * @param[in] tag_id The ID of the media tag
- * @param[out] tag The media tag handle associated with the tag ID
+ * @param[in] tag_id The ID of the media tag
+ * @param[out] tag The handle to the media tag
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Adds a new media info to the tag.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] tag The media tag handle
- * @param[in] media_id The ID to the media info which is added
+ * @param[in] tag The handle to the media tag
+ * @param[in] media_id The media ID
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Removes the media info from the given tag.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] tag The media tag handle
- * @param[in] media_id The ID to the media info which is removed
+ * @param[in] tag The handle to the media tag
+ * @param[in] media_id The media ID
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Sets the name of the tag.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] tag The media tag handle
+ * @param[in] tag The handle to the media tag
* @param[in] tag_name The name of the media tag
*
* @return @c 0 on success,
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @param[in] tag The media tag handle
+ * @param[in] tag The handle to the media tag
*
* @return @c 0 on success,
* otherwise a negative error value
}
#endif /* __cplusplus */
-#endif /* __TIZEN_MEDIA_TAG_H__ */
+#endif /* __TIZEN_CONTENT_MEDIA_TAG_H__ */
*/
-#ifndef __TIZEN_MEDIA_UTIL_PRIVATE_H__
-#define __TIZEN_MEDIA_UTIL_PRIVATE_H__
+#ifndef __TIZEN_CONTENT_MEDIA_UTIL_PRIVATE_H__
+#define __TIZEN_CONTENT_MEDIA_UTIL_PRIVATE_H__
#ifdef __cplusplus
#ifdef __cplusplus
}
#endif /* __cplusplus */
-#endif /*__TIZEN_MEDIA_UTIL_PRIVATE_H__*/
+#endif /*__TIZEN_CONTENT_MEDIA_UTIL_PRIVATE_H__*/
*/
-#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>
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release the destination handle using video_meta_destroy().
+ * @remarksThe @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
+ * @param[in] src The source handle to the video metadata
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] video The video metadata handle
+ * @param[in] video The handle to the video metadata
*
* @return @c 0 on success,
* otherwise a negative error value
* @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 You must release @a media_id using free().
+ * @remarks The @a media_id should be released using free().
*
- * @param[in] video The video metadata handle
- * @param[out] media_id The ID of the video
+ * @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
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a album using free().
+ * @remarks The @a album should be released using free().
*
- * @param[in] video The video metadata handle
+ * @param[in] video The handle to the video metadata
* @param[out] album The album of the video metadata
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a artist using free().
+ * @remarks The @a artist should be released using free().
*
- * @param[in] video The video metadata handle
+ * @param[in] video The handle to the video metadata
* @param[out] artist The artist of the video metadata
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a album_artist using free().
+ * @remarks The @a album_artist should be released using free().
*
- * @param[in] video The video metadata handle
+ * @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,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a genre using free().
+ * @remarks The @a genre should be released using free().
*
- * @param[in] video The video metadata handle
+ * @param[in] video The handle to the video metadata
* @param[out] genre The genre of the video metadata
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a composer using free().
+ * @remarks The @a composer should be released using free().
*
- * @param[in] video The video metadata handle
+ * @param[in] video The handle to the video metadata
* @param[out] composer The composer of the video metadata
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a year using free().
+ * @remarks The @a year should be released using free().
*
- * @param[in] video The video metadata handle
- * @param[out] year The year of the video metadata
+ * @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
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a recorded_date using free().
+ * @remarks The @a recorded_date should be released using free().
*
- * @param[in] video The video metadata handle
+ * @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,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a copyright using free().
+ * @remarks The @a copyright should be released using free().
*
- * @param[in] video The video metadata handle
+ * @param[in] video The handle to the video metadata
* @param[out] copyright The copyright of the video metadata
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a track_num using free().
+ * @remarks The @a track_num should be released using free().
*
- * @param[in] video The video metadata handle
+ * @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,
* @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[in] video The handle to the video metadata
* @param[out] bit_rate The video bit rate in bit per second [bps]
*
* @return @c 0 on success,
* @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[in] video The handle to the video metadata
* @param[out] duration The video duration in milliseconds
*
* @return @c 0 on success,
* @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[in] video The handle to the video metadata
* @param[out] width The video width in pixels
*
* @return @c 0 on success,
* @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[in] video The handle to the video metadata
* @param[out] height The video height in pixels
*
* @return @c 0 on success,
* @brief Gets the rotation of the given video metadata.
* @since_tizen 4.0
*
- * @param[in] video The video metadata handle
+ * @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)
*
* @return @c 0 on success,
*
* @remarks Do not call this function in callback function of foreach function like media_info_foreach_media_from_db().
*
- * @param[in] video The video metadata handle
+ * @param[in] video The handle to the video metadata
*
* @return @c 0 on success,
* otherwise a negative error value
}
#endif /* __cplusplus */
-#endif /*__TIZEN_VIDEO_META_H__*/
+#endif /*__TIZEN_CONTENT_MEDIA_VIDEO_H__*/
*/
-#ifndef __TIZEN_AUDIO_META_H__
-#define __TIZEN_AUDIO_META_H__
+#ifndef __TIZEN_CONTENT_MEDIA_AUDIO_H__
+#define __TIZEN_CONTENT_MEDIA_AUDIO_H__
#include <media_content_type.h>
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release the destination handle using audio_meta_destroy().
+ * @remarks The @a dst should be released using audio_meta_destroy().
*
* @param[out] dst The destination handle to the audio metadata
- * @param[in] src The source handle to the audio metadata
+ * @param[in] src The source handle to the audio metadata
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the ID of the media of the given audio metadata.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a media_id using free().
+ * @remarks The @a media_id should be released using free().
*
- * @param[in] audio The audio metadata handle
- * @param[out] media_id The ID of the audio
+ * @param[in] audio The handle to the audio metadata
+ * @param[out] media_id The media ID
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a album using free().
+ * @remarks The @a album should be released using free().
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
* @param[out] album The album of the audio metadata
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a artist using free().
+ * @remarks The @a artist should be released using free().
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
* @param[out] artist The artist of the audio metadata
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a album_artist using free().
+ * @remarks The @a album_artist should be released using free().
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
* @param[out] album_artist The album artist of the audio metadata
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a genre using free().
+ * @remarks The @a genre should be released using free().
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
* @param[out] genre The genre of the audio metadata
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a composer using free().
+ * @remarks The @a composer should be released using free().
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
* @param[out] composer The composer of the audio metadata
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a year using free().
+ * @remarks The @a year should be released using free().
*
- * @param[in] audio The audio metadata handle
- * @param[out] year The year of the audio metadata
+ * @param[in] audio The handle to the audio metadata
+ * @param[out] year The year of the audio metadata
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a recorded_date using free().
+ * @remarks The @a recorded_date should be released using free().
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
* @param[out] recorded_date The recorded date of the audio metadata
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a copyright using free().
+ * @remarks The @a copyright should be released using free().
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
* @param[out] copyright The copyright of the audio metadata
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a track_num using free().
+ * @remarks The @a track_num should be released using free().
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
* @param[out] track_num The audio track number of the audio metadata
*
* @return @c 0 on success,
* @brief Gets the bitrate of the given audio metadata in bitrate per second.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
* @param[out] bit_rate The audio bitrate in bit per second [bps]
*
* @return @c 0 on success,
* @brief Gets bit per sample of the given audio metadata.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param [in] audio The handle to the audio metadata
- * @param [out] bitpersample The audio bit per sample
+ * @param[in] audio The handle to the audio metadata
+ * @param[out] bitpersample The audio bit per sample
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the sample rate of the given audio metadata.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
* @param[out] sample_rate The audio sample rate[hz]
*
* @return @c 0 on success,
* @brief Gets the channel of the given audio metadata.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
* @param[out] channel The channel of the audio
*
* @return @c 0 on success,
* @brief Gets the track duration of the given audio metadata.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
* @param[out] duration The audio file duration
*
* @return @c 0 on success,
*
* @remarks Do not call this function in callback function of foreach function like media_info_foreach_media_from_db().
*
- * @param[in] audio The audio metadata handle
+ * @param[in] audio The handle to the audio metadata
*
* @return @c 0 on success,
* otherwise a negative error value
}
#endif /* __cplusplus */
-#endif /*__TIZEN_AUDIO_META_H__*/
+#endif /*__TIZEN_CONTENT_MEDIA_AUDIO_H__*/
-#ifndef __TIZEN_MEDIA_BOOKMARK_H__
-#define __TIZEN_MEDIA_BOOKMARK_H__
+#ifndef __TIZEN_CONTENT_MEDIA_BOOKMARK_H__
+#define __TIZEN_CONTENT_MEDIA_BOOKMARK_H__
#include <media_content_type.h>
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @param[in] media_id The media ID
- * @param[in] time The bookmark time offset (in seconds)
+ * @param[in] media_id The media ID
+ * @param[in] time The bookmark time offset (in seconds)
* @param[in] thumbnail_path The thumbnail path of video bookmark\ n
* If the media type is audio, then thumbnail is null.
*
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @param[in] bookmark_id The ID of media bookmark
+ * @param[in] bookmark_id The ID of the media bookmark
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the number of bookmarks with an optional filter from the media database.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] filter The handle to the media filter
+ * @param[in] filter The handle to the media filter
* @param[out] bookmark_count The count of the media bookmark
*
* @return @c 0 on success,
* If @c NULL is passed to the @a filter, then no filtering is applied.
* @since_tizen 4.0
*
- * @param[in] filter The handle to the bookmark filter
- * @param[in] callback The callback function to be invoked
- * @param[in] user_data The user data to be passed to the callback function
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks The destination handle must be released using media_bookmark_destroy().
+ * @remarks The @a dst should be released using media_bookmark_destroy().
*
- * @param[out] dst The destination handle to media bookmark
- * @param[in] src The source handle to media bookmark
+ * @param[out] dst The destination handle to the media bookmark
+ * @param[in] src The source handle to the media bookmark
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] bookmark The handle to media bookmark
+ * @param[in] bookmark The handle to the media bookmark
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the bookmark ID.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] bookmark The handle to media bookmark
- * @param[out] bookmark_id The media bookmark ID
+ * @param[in] bookmark The handle to the media bookmark
+ * @param[out] bookmark_id The ID of the media bookmark
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] bookmark The handle to media bookmark
+ * @param[in] bookmark The handle to the media bookmark
* @param[out] marked_time The bookmark time offset (in seconds)
*
* @return @c 0 on success,
* @brief Gets the media bookmark thumbnail.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a path using free().
+ * @remarks The @a path should be released using free().
*
- * @param[in] bookmark The handle to media bookmark
- * @param[out] path The thumbnail path of media bookmark
+ * @param[in] bookmark The handle to the media bookmark
+ * @param[out] path The thumbnail path of media bookmark
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the media bookmark name which user set.
* @since_tizen 4.0
*
- * @remarks You must release @a name using free().
+ * @remarks The @a name should be released using free().
*
- * @param[in] bookmark The handle to media bookmark
- * @param[out] name The name of media bookmark. If name was not set, empty string is returned.
+ * @param[in] bookmark The handle to the media bookmark
+ * @param[out] name The name of media bookmark. If name was not set, empty string is returned.
* If User set bookmark name to NULL, name will be empty string also.
*
* @return @c 0 on success,
* @brief Sets the media bookmark name.
* @since_tizen 4.0
*
- * @param[in] bookmark The handle to media bookmark
- * @param[in] name The name of media bookmark. Can be NULL, empty or non-empty string.
+ * @param[in] bookmark The handle to the media bookmark
+ * @param[in] name The name of media bookmark. Can be NULL, empty or non-empty string.
*
* @return @c 0 on success,
* otherwise a negative error value
* @privilege %http://tizen.org/privilege/content.write
*
* @remarks Do not call this function in callback function of foreach function like media_info_foreach_bookmark_from_db().
- * @param[in] bookmark The handle to media bookmark
+ * @param[in] bookmark The handle to the media bookmark
*
* @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_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 when Application has no privilege
+ * @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 when Application has no privilege
*
* @pre This function requires opened connection to content service by media_content_connect().
*
#ifdef __cplusplus
}
#endif /* __cplusplus */
-#endif /*__TIZEN_MEDIA_BOOKMARK_H__*/
+#endif /*__TIZEN_CONTENT_MEDIA_BOOKMARK_H__*/
* limitations under the License.
*/
-#ifndef __TIZEN_MEDIA_CONTENT_H__
-#define __TIZEN_MEDIA_CONTENT_H__
+#ifndef __TIZEN_CONTENT_MEDIA_CONTENT_H__
+#define __TIZEN_CONTENT_MEDIA_CONTENT_H__
#include <media_audio.h>
#include <media_content_type.h>
* @details This function requests to scan a media file to the media server.
* If media file is not registered to DB yet, that media file information will be added to the media DB. If it is already registered to the DB, then this tries to refresh information. \n
* If requested file does not exist on file system, information of the media file will be removed from the media DB. \n
- * If file information does not exist in DB, this API will be return #MEDIA_CONTENT_ERROR_INVALID_PARAMETER.
+ * If file information does not exist in DB, this function will be return #MEDIA_CONTENT_ERROR_INVALID_PARAMETER.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* %http://tizen.org/privilege/externalstorage
*
* @remarks You must add privilege http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path. \n
- * If you want to access only internal storage by using this API, you should add privilege http://tizen.org/privilege/mediastorage. \n
- * Or if you want to access only external storage by using this API, you should add privilege http://tizen.org/privilege/externalstorage. \n
+ * If you want to access only internal storage by using this function, you should add privilege http://tizen.org/privilege/mediastorage. \n
+ * Or if you want to access only external storage by using this function, you should add privilege http://tizen.org/privilege/externalstorage. \n
* If you can access both storage, you must add all privilege.
* @remarks Since 4.0, this function is related to the following feature:\n
* %http://tizen.org/feature/content.scanning.others\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
+ * Alternatively, you can call this function 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
* %http://tizen.org/privilege/externalstorage
*
* @remarks You must add privilege http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path. \n
- * If you want to access only internal storage by using this API, you should add privilege http://tizen.org/privilege/mediastorage. \n
- * Or if you want to access only external storage by using this API, you should add privilege http://tizen.org/privilege/externalstorage. \n
+ * If you want to access only internal storage by using this function, you should add privilege http://tizen.org/privilege/mediastorage. \n
+ * Or if you want to access only external storage by using this function, you should add privilege http://tizen.org/privilege/externalstorage. \n
* If you can access both storage, you must add all privilege.
*
- * @param[in] path The folder path
+ * @param[in] path The folder path
* @param[in] is_recursive Set @c true to scan recursively subdirectories,
* otherwise @c false to scan only the current directory
- * @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
+ * @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
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @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
*
* @pre This function requires opened connection to content service by media_content_connect().
* @see media_scan_completed_cb()
* @brief Requests to cancel the media folder scanning.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @param[in] path The folder path
+ * @param[in] path The folder path
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Subscribes notifications of the media DB change.
* @details This function subscribes notifications of the media DB change which are published by the media server or other apps. \n
* media_content_db_update_cb() function will be called when notification of the media DB change is subscribed. \n
- * Using this API, multiple callback is possible to register in one process.
+ * Using this function, multiple callback is possible to register in one process.
*
* @since_tizen 3.0
*
- * @remarks To release the registered callback, you must use media_content_remove_db_updated_cb() API. \n
- * If you set the same callback that you previously added, this API returns MEDIA_CONTENT_ERROR_INVALID_OPERATION error. \n
+ * @remarks The @a noti_handle should be released using media_content_remove_db_updated_cb(). \n
+ * If you set the same callback that you previously added, this function returns MEDIA_CONTENT_ERROR_INVALID_OPERATION error. \n
*
- * @param[in] callback The callback to be invoked when the scanning is finished
+ * @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
* @param[out] noti_handle The handle to db updated notification
*
*/
int media_content_add_db_updated_cb(media_content_db_update_cb callback, void *user_data, media_content_noti_h *noti_handle);
-
/**
- * @brief Unsubscribes notifications of the media DB change.
+ * @brief Removes 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 3.0
}
#endif /* __cplusplus */
-#endif /* __TIZEN_MEDIA_CONTENT_H__ */
+#endif /* __TIZEN_CONTENT_MEDIA_CONTENT_H__ */
-#ifndef __TIZEN_MEDIA_CONTENT_INTERNAL_H__
-#define __TIZEN_MEDIA_CONTENT_INTERNAL_H__
+#ifndef __TIZEN_CONTENT_MEDIA_CONTENT_INTERNAL_H__
+#define __TIZEN_CONTENT_MEDIA_CONTENT_INTERNAL_H__
#include <media_content_type.h>
#ifdef __cplusplus
}
#endif /* __cplusplus */
-#endif /*__TIZEN_MEDIA_CONTENT_INTERNAL_H__*/
+#endif /*__TIZEN_CONTENT_MEDIA_CONTENT_INTERNAL_H__*/
*
* @remarks You must release @a title using free().
*
- * @param[in] media The media info handle
+ * @param[in] media The media info handle
* @param[out] extract_flag The extract_flag of the media info
*
* @return @c 0 on success,
* @details Function returns content's elapsed playback position parameter as period
* starting from the beginning of the track.
*
- * @param [in] media The handle to media info
- * @param [out] played_position The elapsed time of the content
+ * @param[in] media The handle to media info
+ * @param[out] played_position The elapsed time of the content
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
/**
* @brief Gets the provider to media info.
*
- * @remarks @a modified_month must be released with free() by you.
+ * @remarks @a modified_month should be released with free() by you.
*
* @param[in] media The handle to media info
* @param[out] category The modified month of media info
/**
* @brief Sets the played count to content meta handle.
*
- * @param [in] media The handle to media info
- * @param [in] played_count The played count of content
+ * @param[in] media The handle to media info
+ * @param[in] played_count The played count of content
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
/**
* @brief Sets the played position to content meta handle.
*
- * @param [in] media The handle to media info
- * @param [in] played_position The played position of content
+ * @param[in] media The handle to media info
+ * @param[in] played_position The played position of content
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* The callback function will be invoked for every retrieved media group.
* If NULL is passed to the filter, no filtering is applied.
*
- * @param [in] filter The handle to media filter
- * @param [in] group The type of media group
- * @param [in] callback The callback function to invoke
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] filter The handle to media filter
+ * @param[in] group The type of media group
+ * @param[in] callback The callback function to invoke
+ * @param[in] user_data The user data to be passed to the callback function
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* @brief Gets the storage scan status of media storage.
* @since_tizen 2.4
*
- * @param[in] storage The media storage handle
+ * @param[in] storage The media storage handle
* @param[out] scan_status The storage type of the media storage
*
* @return @c 0 on success,
*/
-#ifndef __TIZEN_MEDIA_CONTENT_TYPE_H__
-#define __TIZEN_MEDIA_CONTENT_TYPE_H__
+#ifndef __TIZEN_CONTENT_MEDIA_CONTENT_TYPE_H__
+#define __TIZEN_CONTENT_MEDIA_CONTENT_TYPE_H__
#include <time.h>
#include <tizen.h>
* @brief Enumeration for the media file format.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks Since 4.0, #MEDIA_CONTENT_TYPE_OTHERS is related to the following feature:\n
- * %http://tizen.org/feature/content.scanning.others
+ * %http://tizen.org/feature/content.scanning.others\n
* If this feature is not suppported on the device, MEDIA_CONTENT_TYPE_OTHERS type file is not scanned.
*/
typedef enum {
typedef enum {
MEDIA_CONTENT_ORDER_ASC = 0, /**< Ascending order*/
MEDIA_CONTENT_ORDER_DESC = 1, /**< Descending order*/
- MEDIA_CONTENT_ORDER_OTHER = 2, /** order by order key**/
+ MEDIA_CONTENT_ORDER_OTHER = 2, /**< order by order key**/
} media_content_order_e;
/**
MEDIA_CONTENT_COLLATE_LOCALIZED = 3, /**< Collation LOCALIZATION, NOCASE also applied */
} media_content_collation_e;
+/**
+* @brief Error class.
+* @details Class for Media Content error
+* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+*
+*/
#define MEDIA_CONTENT_ERROR_CLASS TIZEN_ERROR_MEDIA_CONTENT
/**
/**
* @ingroup CAPI_MEDIA_CONTENT_MODULE
* @brief Called when the media scanning is finished.
+ * @details The following error codes can be received: \n
+ * #MEDIA_CONTENT_ERROR_NONE : Success \n
+ * #MEDIA_CONTENT_ERROR_INVALID_PARAMETER : Invalid parameter \n
+ * #MEDIA_CONTENT_ERROR_INVALID_OPERATION : Invalid operation \n
+ * #MEDIA_CONTENT_ERROR_PERMISSION_DENIED : Permission denied \n
+ * #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY : Out of memory \n
+ * #MEDIA_CONTENT_ERROR_DB_FAILED : DB Operation failed \n
+ * #MEDIA_CONTENT_ERROR_DB_BUSY : DB Operation busy \n
+ * #MEDIA_CONTENT_ERROR_NETWORK : Network fail \n
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks The callback is called in a separate thread(not in the main loop).
*
- * @param[in] error The error code
+ * @param[in] error The error code
* @param[in] user_data The user data passed from the foreach function
*
* @pre media_content_scan_folder().
/**
* @ingroup CAPI_MEDIA_CONTENT_MODULE
* @brief Called when the notification of the media DB change is subscribed.
+ * @details The following error codes can be received: \n
+ * #MEDIA_CONTENT_ERROR_NONE : Success \n
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @remarks The callback is called in a separate thread(not in the main loop).
*
- * @param[in] error The error code
- * @param[in] pid The PID which publishes notification
+ * @param[in] error The error code
+ * @param[in] pid The PID which publishes notification
* @param[in] update_item The update item of notification
* @param[in] update_type The update type of notification
- * @param[in] media_type The type of the media content (#media_content_type_e)
- * @param[in] uuid The UUID of media or directory, which is updated
- * @param[in] path The path of the media or directory
- * @param[in] mime_type The mime type of the media info
- * @param[in] user_data The user data passed from the foreach function
+ * @param[in] media_type The type of the media content (#media_content_type_e)
+ * @param[in] uuid The UUID of media or directory, which is updated
+ * @param[in] path The path of the media or directory
+ * @param[in] mime_type The MIME of the media info
+ * @param[in] user_data The user data passed from the foreach function
*
* @pre media_content_add_db_updated_cb().
* @see media_content_add_db_updated_cb()
* @remarks To use the @a media outside this function, copy the handle with media_info_clone() function. \n
* The callback is called in the main loop.
*
- * @param[in] media The handle to the media info
+ * @param[in] media The handle to the media info
* @param[in] user_data The user data passed from the foreach function
*
* @return @c true to continue with the next iteration of the loop,
/**
* @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
* @brief Called when media items are inserted completely.
+ * @details The following error codes can be received: \n
+ * #MEDIA_CONTENT_ERROR_NONE : Success \n
+ * #MEDIA_CONTENT_ERROR_INVALID_PARAMETER : Invalid parameter \n
+ * #MEDIA_CONTENT_ERROR_INVALID_OPERATION : Invalid operation \n
+ * #MEDIA_CONTENT_ERROR_PERMISSION_DENIED : Permission denied \n
+ * #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY : Out of memory \n
+ * #MEDIA_CONTENT_ERROR_DB_FAILED : DB Operation failed \n
+ * #MEDIA_CONTENT_ERROR_DB_BUSY : DB Operation busy \n
+ * #MEDIA_CONTENT_ERROR_NETWORK : Network fail \n
+ * #MEDIA_CONTENT_ERROR_NOT_SUPPORTED : Not supported \n
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @remarks The callback is called in a separate thread(not in the main loop).
*
- * @param[in] media The handle to the media info
+ * @param[in] error The error code
* @param[in] user_data The user data passed from the foreach function
*
* @pre media_info_insert_batch_to_db()
* @deprecated Deprecated since 4.0.
* @ingroup CAPI_CONTENT_MEDIA_INFO_MODULE
* @brief Called when the burst shot is inserted completely.
+ * @details The following error codes can be received: \n
+ * #MEDIA_CONTENT_ERROR_NONE : Success \n
+ * #MEDIA_CONTENT_ERROR_INVALID_PARAMETER : Invalid parameter \n
+ * #MEDIA_CONTENT_ERROR_INVALID_OPERATION : Invalid operation \n
+ * #MEDIA_CONTENT_ERROR_PERMISSION_DENIED : Permission denied \n
+ * #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY : Out of memory \n
+ * #MEDIA_CONTENT_ERROR_DB_FAILED : DB Operation failed \n
+ * #MEDIA_CONTENT_ERROR_DB_BUSY : DB Operation busy \n
+ * #MEDIA_CONTENT_ERROR_NETWORK : Network fail \n
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @remarks The callback is called in a separate thread(not in the main loop).
*
- * @param[in] media The handle to the media info
+ * @param[in] error The error code
* @param[in] user_data The user data passed from the foreach function
*
* @pre media_info_insert_burst_shot_to_db()
*
* @remarks The callback is called in a separate thread(not in the main loop).
*
- * @param[in] error The error code
- * @param[in] path The path of the thumbnail which is generated
+ * @param[in] error The error code
+ * @param[in] path The path of the thumbnail which is generated
* @param[in] user_data The user data passed from the foreach function
*
* @pre media_info_create_thumbnail()
*
* @remarks The callback is called in a separate thread(not in the main loop).
*
- * @param[in] error The error code
- * @param[in] face_count The number of all detected faces
+ * @param[in] error The error code
+ * @param[in] face_count The number of all detected faces
* @param[in] user_data The user data passed from the foreach function
*
* @pre media_info_start_face_detection()
* @remarks To use the @a folder outside this function, copy the handle with the media_folder_clone() function. \n
* The callback is called in the main loop.
*
- * @param[in] folder The handle to the media folder
+ * @param[in] folder The handle to the media folder
* @param[in] user_data The user data passed from the foreach function
*
* @return @c true to continue with the next iteration of the loop,
* @remarks To use the @a playlist outside this function, copy the handle with the media_playlist_clone() function. \n
* The callback is called in the main loop.
*
- * @param[in] playlist The handle to the media playlist
+ * @param[in] playlist The handle to the media playlist
* @param[in] user_data The user data passed from the foreach function
*
* @return @c true to continue with the next iteration of the loop,
* @remarks To use the @a media outside this function, copy the handle with the media_info_clone() function. \n
* The callback is called in the main loop.
*
- * @param[in] playlist_member_id The ID to member of the playlist
- * @param[in] media The handle to the media info
- * @param[in] user_data The user data passed from the foreach function
+ * @param[in] playlist_member_id The ID of the playlist member
+ * @param[in] media The handle to the media info
+ * @param[in] user_data The user data passed from the foreach function
*
* @return @c true to continue with the next iteration of the loop,
* otherwise @c false to break out of the loop
* @remarks To use the @a tag outside this function, copy the handle with the media_tag_clone() function. \n
* The callback is called in the main loop.
*
- * @param[in] tag The handle to the media tag
+ * @param[in] tag The handle to the media tag
* @param[in] user_data The user data passed from the foreach function
*
* @return @c true to continue with the next iteration of the loop,
* @remarks To use the @a bookmark outside this function, copy the handle with the media_bookmark_clone() function. \n
* The callback is called in the main loop.
*
- * @param[in] bookmark The handle to the video bookmark
+ * @param[in] bookmark The handle to the media bookmark
* @param[in] user_data The user data passed from the foreach function
*
* @return @c true to continue with the next iteration of the loop,
* @remarks To use the @a album outside this function, copy the handle with the media_album_clone() function. \n
* The callback is called in the main loop.
*
- * @param[in] album The handle to the media album
+ * @param[in] album The handle to the media album
* @param[in] user_data The user data passed from the foreach function
*
* @return @c true to continue with the next iteration of the loop,
* The callback is called in the main loop.
*
* @param[in] group_name The name of the media group
- * @param[in] user_data The user data passed from the foreach function
+ * @param[in] user_data The user data passed from the foreach function
*
* @return @c true to continue with the next iteration of the loop,
* otherwise @c false to break out of the loop
* @remarks You should not destroy @a storage returned by this function. \n
* The callback is called in the main loop.
*
- * @param[in] storage The handle of the media storage
- * @param[in] user_data The user data passed from the foreach function
+ * @param[in] storage The handle of the media storage
+ * @param[in] user_data The user data passed from the foreach function
*
* @return @c true to continue with the next iteration of the loop,
* otherwise @c false to break out of the loop
* @remarks You should not destroy @a face returned by this function. \n
* The callback is called in the main loop.
*
- * @param[in] face The handle of the media face
- * @param[in] user_data The user data passed from the foreach function
+ * @param[in] face The handle of the media face
+ * @param[in] user_data The user data passed from the foreach function
*
* @return @c true to continue with the next iteration of the loop,
* otherwise @c false to break out of the loop
*/
/**
- * @brief Media ID
+ * @brief Media ID.
* @details 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
*
#define MEDIA_ID "MEDIA_ID"
/**
- * @brief Media full path
+ * @brief Media full path.
* @details 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
*
#define MEDIA_PATH "MEDIA_PATH"
/**
- * @brief The file name including the extension
+ * @brief The file name including the extension.
* @details 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
*
#define MEDIA_DISPLAY_NAME "MEDIA_DISPLAY_NAME"
/**
- * @brief Media type
+ * @brief Media type.
* @details There are 5 media types:\n
* 0-image, 1-video, 2-sound, 3-music, 4-other\n
* You can use above define to set the condition of media filter and order keyword.
#define MEDIA_TYPE "MEDIA_TYPE"
/**
- * @brief Media MIME type
+ * @brief Media MIME type.
* @details 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
*
/**
- * @brief Media file size
+ * @brief Media file size.
* @details 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
*
#define MEDIA_SIZE "MEDIA_SIZE"
/**
- * @brief The time that content file was first added to media database
+ * @brief The time that content file was first added to media database.
* @details 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
*
#define MEDIA_ADDED_TIME "MEDIA_ADDED_TIME"
/**
- * @brief The last modification time provided by the file system
+ * @brief The last modification time provided by the file system.
* @details 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
*
#define MEDIA_MODIFIED_TIME "MEDIA_MODIFIED_TIME"
/**
- * @brief Media created time
+ * @brief Media created time.
* @details 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
*
#define MEDIA_TIMELINE "MEDIA_TIMELINE"
/**
- * @brief Media thumbnail path
+ * @brief Media thumbnail path.
* @details 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
*
#define MEDIA_THUMBNAIL_PATH "MEDIA_THUMBNAIL_PATH"
/**
- * @brief Media title get from tag or file name
+ * @brief Media title get from tag or file name.
* @details 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
*
#define MEDIA_TITLE "MEDIA_TITLE"
/**
- * @brief Media album name
+ * @brief Media album name.
* @details 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
*
#define MEDIA_ALBUM "MEDIA_ALBUM"
/**
- * @brief Media artist
+ * @brief Media artist.
* @details 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
*
#define MEDIA_ARTIST "MEDIA_ARTIST"
/**
- * @brief Media album artist
+ * @brief Media album artist.
* @details 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
*
#define MEDIA_ALBUM_ARTIST "MEDIA_ALBUM_ARTIST"
/**
- * @brief Media genre
+ * @brief Media genre.
* @details 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
*
#define MEDIA_GENRE "MEDIA_GENRE"
/**
- * @brief Media composer
+ * @brief Media composer.
* @details 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
*
#define MEDIA_COMPOSER "MEDIA_COMPOSER"
/**
- * @brief Media year
+ * @brief Media year.
* @details 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
*
#define MEDIA_YEAR "MEDIA_YEAR"
/**
- * @brief Media recorded date
+ * @brief Media recorded date.
* @details 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
*
#define MEDIA_RECORDED_DATE "MEDIA_RECORDED_DATE"
/**
- * @brief Media copyright
+ * @brief Media copyright.
* @details 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
*
#define MEDIA_COPYRIGHT "MEDIA_COPYRIGHT"
/**
- * @brief Media track number
+ * @brief Media track number.
* @details 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
*
#define MEDIA_TRACK_NUM "MEDIA_TRACK_NUM"
/**
- * @brief Media description
+ * @brief Media description.
* @details 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
*
#define MEDIA_DESCRIPTION "MEDIA_DESCRIPTION"
/**
- * @brief Media bitrate
+ * @brief Media bitrate.
* @details 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
*
#define MEDIA_BITRATE "MEDIA_BITRATE"
/**
- * @brief Media bit per sample
+ * @brief Media bit per sample.
* @details 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
*
#define MEDIA_BITPERSAMPLE "MEDIA_BITPERSAMPLE"
/**
- * @brief Media sample rate
+ * @brief Media sample rate.
* @details 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
*
#define MEDIA_SAMPLERATE "MEDIA_SAMPLERATE"
/**
- * @brief Media channel
+ * @brief Media channel.
* @details 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
*
#define MEDIA_CHANNEL "MEDIA_CHANNEL"
/**
- * @brief Media duration
+ * @brief Media duration.
* @details 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
*
#define MEDIA_DURATION "MEDIA_DURATION"
/**
- * @brief Media longitude
+ * @brief Media longitude.
* @details 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
*
#define MEDIA_LONGITUDE "MEDIA_LONGITUDE"
/**
- * @brief Media latitude
+ * @brief Media latitude.
* @details 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
*
#define MEDIA_LATITUDE "MEDIA_LATITUDE"
/**
- * @brief Media altitude
+ * @brief Media altitude.
* @details 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
*
#define MEDIA_ALTITUDE "MEDIA_ALTITUDE"
/**
- * @brief Media width
+ * @brief Media width.
* @details 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
*
#define MEDIA_WIDTH "MEDIA_WIDTH"
/**
- * @brief Media height
+ * @brief Media height.
* @details 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
*
#define MEDIA_HEIGHT "MEDIA_HEIGHT"
/**
- * @brief Media datetaken
+ * @brief Media datetaken.
* @details 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
*
#define MEDIA_DATETAKEN "MEDIA_DATETAKEN"
/**
- * @brief Media orientation
+ * @brief Media orientation.
* @details 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
*
/**
* @deprecated Deprecated since 4.0.
- * @brief Media burst ID
+ * @brief Media burst ID.
* @details 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
*
/**
* @deprecated Deprecated since 4.0.
- * @brief Media playedcount
+ * @brief Media playedcount.
* @details 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
*
/**
* @deprecated Deprecated since 4.0.
- * @brief Media last played time
+ * @brief Media last played time.
* @details 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
*
/**
* @deprecated Deprecated since 4.0.
- * @brief Media last played position of file
+ * @brief Media last played position of file.
* @details 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
*
#define MEDIA_LAST_PLAYED_POSITION "MEDIA_LAST_PLAYED_POSITION"
/**
- * @brief Media rating
+ * @brief Media rating.
* @details 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
*
#define MEDIA_RATING "MEDIA_RATING"
/**
- * @brief The time to register favourite
+ * @brief The time to register favourite.
* @details 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
*
/**
* @deprecated Deprecated since 4.0.
- * @brief Media author
+ * @brief Media author.
* @details 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
*
/**
* @deprecated Deprecated since 4.0.
- * @brief Media provider
+ * @brief Media provider.
* @details 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
*
/**
* @deprecated Deprecated since 4.0.
- * @brief Media content name
+ * @brief Media content name.
* @details 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
*
/**
* @deprecated Deprecated since 4.0.
- * @brief Media category
+ * @brief Media category.
* @details 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
*
/**
* @deprecated Deprecated since 4.0.
- * @brief Media location tag
+ * @brief Media location tag.
* @details 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
*
/**
* @deprecated Deprecated since 4.0.
- * @brief Media age rating
+ * @brief Media age rating.
* @details 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
*
/**
* @deprecated Deprecated since 4.0.
- * @brief Media keyword
+ * @brief Media keyword.
* @details 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
*
/**
* @deprecated Deprecated since 4.0.
- * @brief Media weather
+ * @brief Media weather.
* @details 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
*
#define MEDIA_WEATHER "MEDIA_WEATHER"
/**
- * @brief Is DRM
+ * @brief Is DRM.
* @details There are 2 types:\n
* 0-not drm, 1-drm\n
* You can use above define to set the condition of media filter and order keyword.
#define MEDIA_IS_DRM "MEDIA_IS_DRM"
/**
- * @brief Media storage
+ * @brief Media storage.
* @details There are 2 types:\n
* 0-internal storage, 1-external storage\n
* You can use above define to set the condition of media filter and order keyword.
#define MEDIA_STORAGE_TYPE "MEDIA_STORAGE_TYPE"
/**
- * @brief Media exposure time
+ * @brief Media exposure time.
* @details You can use above define to set the condition of media filter and order keyword.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
#define MEDIA_EXPOSURE_TIME "MEDIA_EXPOSURE_TIME"
/**
- * @brief Media fnumber
+ * @brief Media fnumber.
* @details You can use above define to set the condition of media filter and order keyword.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
#define MEDIA_FNUMBER "MEDIA_FNUMBER"
/**
- * @brief Media ISO
+ * @brief Media ISO.
* @details You can use above define to set the condition of media filter and order keyword.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
#define MEDIA_ISO "MEDIA_ISO"
/**
- * @brief Media model
+ * @brief Media model.
* @details You can use above define to set the condition of media filter and order keyword.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
#define MEDIA_MODEL "MEDIA_MODEL"
/**
- * @brief Media file name pinyin
+ * @brief Media file name pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
* - %http://tizen.org/feature/content.filter.pinyin\n
- * If this feature is not supported on the device, PINYIN search does not work.
+ * If this feature is not supported on the device, PINYIN search does not work.
*
*/
#define MEDIA_FILE_NAME_PINYIN "MEDIA_FILE_NAME_PINYIN"
/**
- * @brief Media title pinyin
+ * @brief Media title pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
* - %http://tizen.org/feature/content.filter.pinyin\n
- * If this feature is not supported on the device, PINYIN search does not work.
+ * If this feature is not supported on the device, PINYIN search does not work.
*
*/
#define MEDIA_TITLE_PINYIN "MEDIA_TITLE_PINYIN"
/**
- * @brief Media album pinyin
+ * @brief Media album pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
#define MEDIA_ALBUM_PINYIN "MEDIA_ALBUM_PINYIN"
/**
- * @brief Media artist pinyin
+ * @brief Media artist pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
* - %http://tizen.org/feature/content.filter.pinyin\n
- * If this feature is not supported on the device, PINYIN search does not work.
+ * If this feature is not supported on the device, PINYIN search does not work.
*
*/
#define MEDIA_ARTIST_PINYIN "MEDIA_ARTIST_PINYIN"
/**
- * @brief Media album artist pinyin
+ * @brief Media album artist pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
#define MEDIA_ALBUM_ARTIST_PINYIN "MEDIA_ALBUM_ARTIST_PINYIN"
/**
- * @brief Media genre pinyin
+ * @brief Media genre pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
#define MEDIA_GENRE_PINYIN "MEDIA_GENRE_PINYIN"
/**
- * @brief Media composer pinyin
+ * @brief Media composer pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
#define MEDIA_COMPOSER_PINYIN "MEDIA_COMPOSER_PINYIN"
/**
- * @brief Media copyright pinyin
+ * @brief Media copyright pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
#define MEDIA_COPYRIGHT_PINYIN "MEDIA_COPYRIGHT_PINYIN"
/**
- * @brief Media description pinyin
+ * @brief Media description pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
/**
* @deprecated Deprecated since 4.0.
- * @brief Media author pinyin
+ * @brief Media author pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
/**
* @deprecated Deprecated since 4.0.
- * @brief Media provider pinyin
+ * @brief Media provider pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
/**
* @deprecated Deprecated since 4.0.
- * @brief Media content name pinyin
+ * @brief Media content name pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
/**
* @deprecated Deprecated since 4.0.
- * @brief Media category pinyin
+ * @brief Media category pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
/**
* @deprecated Deprecated since 4.0.
- * @brief Media location tag pinyin
+ * @brief Media location tag pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
/**
* @deprecated Deprecated since 4.0.
- * @brief Media age rating pinyin
+ * @brief Media age rating pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
/**
* @deprecated Deprecated since 4.0.
- * @brief Media keyword pinyin
+ * @brief Media keyword pinyin.
* @details 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
* @remarks Since 4.0, this keyword is related to the following feature:\n
#define MEDIA_KEYWORD_PINYIN "MEDIA_KEYWORD_PINYIN"
/**
- * @brief Virtual Reality content
+ * @brief Virtual Reality content.
* @details You can use above define to set the condition of media filter and order keyword.
* @since_tizen 3.0
*
#define MEDIA_360 "MEDIA_360"
/**
- * @brief Folder ID
+ * @brief Folder ID.
* @details You can use above define to set the condition of folder filter and order keyword.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define FOLDER_ID "FOLDER_ID"
/**
- * @brief Folder full path
+ * @brief Folder full path.
* @details You can use above define to set the condition of folder filter and order keyword.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define FOLDER_PATH "FOLDER_PATH"
/**
- * @brief Folder base name
+ * @brief Folder base name.
* @details You can use above define to set the condition of folder filter and order keyword.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
/**
* @deprecated Deprecated since 4.0.
- * @brief Folder modified time
+ * @brief Folder modified time.
* @details You can use above define to set the condition of folder filter and order keyword.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define FOLDER_MODIFIED_TIME "FOLDER_MODIFIED_TIME"
/**
- * @brief Folder storage
+ * @brief Folder storage.
* @details There are 2 types:\n
* 0-internal storage, 1-external storage\n
* You can use above define to set the condition of folder filter and order keyword.
#define FOLDER_STORAGE_TYPE "FOLDER_STORAGE_TYPE"
/**
- * @brief Folder base name pinyin
+ * @brief Folder base name pinyin.
* @details You can use above define to set the condition of folder filter and order keyword.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks Since 4.0, this keyword is related to the following feature:\n
/**
* @deprecated Deprecated since 4.0.
- * @brief Folder order info
+ * @brief Folder order info.
* @details 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
*/
/**
* @deprecated Deprecated since 4.0.
- * @brief Parent folder id
+ * @brief Parent folder id.
* @details 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
*/
#define FOLDER_PARENT_FOLDER_ID "FOLDER_PARENT_FOLDER_ID"
/**
- * @brief Playlist name
+ * @brief Playlist name.
* @details You can use above define to set the condition of playlist filter and order keyword.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define PLAYLIST_NAME "PLAYLIST_NAME"
/**
- * @brief Playlist id
+ * @brief Playlist id.
* @details You can use above define to set the condition of playlist filter and order keyword.
* @since_tizen 4.0
*/
#define MEDIA_PLAYLIST_ID "PLAYLIST_ID"
/**
- * @brief Playlist name
+ * @brief Playlist member order.
* @details You can use above define to set the condition of playlist filter and order keyword.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define PLAYLIST_MEMBER_ORDER "PLAYLIST_MEMBER_ORDER"
/**
- * @brief Media count in playlist
+ * @brief Media count in playlist.
* @details You can use above define to set the condition of playlist filter and order keyword.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define PLAYLIST_MEDIA_COUNT "PLAYLIST_MEDIA_COUNT"
/**
- * @brief Tag name
+ * @brief Tag name.
* @details You can use above define to set the condition of tag filter and order keyword.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define TAG_NAME "TAG_NAME"
/**
- * @brief Tag id
+ * @brief Tag id.
* @details You can use above define to set the condition of tag filter and order keyword.
* @since_tizen 4.0
*/
#define MEDIA_TAG_ID "TAG_ID"
/**
- * @brief Media count in tag
+ * @brief Media count in tag.
* @details You can use above define to set the condition of tag filter and order keyword.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define TAG_MEDIA_COUNT "TAG_MEDIA_COUNT"
/**
- * @brief Bookmark marked time
+ * @brief Bookmark marked time.
* @details You can use above define to set the condition of bookmark filter and order keyword.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define BOOKMARK_MARKED_TIME "BOOKMARK_MARKED_TIME"
/**
- * @brief Bookmark id
+ * @brief Bookmark id.
* @details You can use above define to set the condition of bookmark filter and order keyword.
* @since_tizen 4.0
*/
#define MEDIA_BOOKMARK_ID "BOOKMARK_ID"
/**
- * @brief Bookmark name
+ * @brief Bookmark name.
* @details You can use above define to set the condition of bookmark filter and order keyword.
* @since_tizen 4.0
*/
#define BOOKMARK_NAME "BOOKMARK_NAME"
/**
- * @brief Storage ID
+ * @brief Storage ID.
* @details You can use above define to set the condition of storage filter and order keyword.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*/
#define MEDIA_STORAGE_ID "STORAGE_ID"
/**
- * @brief Storage path
+ * @brief Storage path.
* @details You can use above define to set the condition of storage filter and order keyword.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*/
#define MEDIA_STORAGE_PATH "STORAGE_PATH"
/**
- * @brief Face tag
+ * @brief Face tag.
* @details You can use above define to set the condition of face filter and order keyword.
* @since_tizen 3.0
*/
#define MEDIA_FACE_TAG "MEDIA_FACE_TAG"
/**
- * @brief Face id
+ * @brief Face id.
* @details You can use above define to set the condition of face filter and order keyword.
* @since_tizen 4.0
*/
#endif /* __cplusplus */
-#endif /*__TIZEN_MEDIA_CONTENT_TYPE_H__*/
+#endif /*__TIZEN_CONTENT_MEDIA_CONTENT_TYPE_H__*/
* limitations under the License.
*/
-#ifndef __TIZEN_MEDIA_IMAGE_FACE_H__
-#define __TIZEN_MEDIA_IMAGE_FACE_H__
+#ifndef __TIZEN_CONTENT_MEDIA_FACE_H__
+#define __TIZEN_CONTENT_MEDIA_FACE_H__
#include <media_content_type.h>
/**
* @file media_face.h
- * @brief This file contains the media face API and related to all operations with the face information of the image in Media DB. \n
- * Functions include cloning and destroying the face handler, getting face information such as face id, face coordinates in file, \n
+ * @brief This file contains the media face function and related to all operations with the face information of the image in Media DB. \n
+ * Functions include cloning and destroying the media face handler, getting face information such as face id, face coordinates in file, \n
* face tag. Face information will be managed by DB. To insert face information, you should use media_face_insert_to_db() \n
- * or media_info_start_face_detection() API. And you can insert,update,delete face information manually.
+ * or media_info_start_face_detection() function. And you can insert,update,delete face information manually.
*/
/**
*/
/**
- * @brief Clones the face handle.
- * @details This function copies the face handle from a source to
+ * @brief Clones the media face handle.
+ * @details This function copies the media face handle from a source to
* destination. There is no media_face_create() function. The media_face_h is created internally and available through
* media face foreach function such as media_face_foreach_face_from_db(). To use this handle outside of these foreach functions,
* use this function.
*
* @since_tizen 3.0
- * @remark The destination handle must be released with media_event_destroy() by you.
+ * @remarks The @a dst should be released using media_face_destroy().
*
- * @param [in] src The source face handle
- * @param [out] dst A destination face handle
+ * @param[out] dst The destination handle to the media face
+ * @param[in] src The source handle to the media face
*
* @return 0 on success, otherwise a negative error value.
*
int media_face_clone(media_face_h *dst, media_face_h src);
/**
- * @brief Destroys the face handle.
- * @details Function frees all resources related to face handle. This
+ * @brief Destroys the media face handle.
+ * @details Function frees all resources related to media face handle. This
* handle no longer can be used to perform any operation. New handle has to
* be created before next usage.
*
* @since_tizen 3.0
*
- * @param [in] face The face handle
+ * @param[in] face The media face handle
*
* @return 0 on success, otherwise a negative error value.
*
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*
- * @see media_face_clone()
- *
- * @pre Get copy of face handle by calling media_face_clone() or Get face handle by calling media_info_foreach_face_from_db()
+ * @pre Get copy of media face handle by calling media_face_clone() or Get media face handle by calling media_info_foreach_face_from_db()
*
+ * @see media_face_clone()
*/
int media_face_destroy(media_face_h face);
/**
- * @brief Gets the face id from the face handle.
+ * @brief Gets the face id from the media face handle.
*
* @since_tizen 3.0
*
- * @remarks You must release @a face_id using free().
+ * @remarks The @a face_id should be released using free().
*
- * @param [in] face The face handle
- * @param [out] face_id The uuid of the face handle
+ * @param[in] face The media face handle
+ * @param[out] face_id The ID of the media face
*
* @return 0 on success, otherwise a negative error value.
*
int media_face_get_face_id(media_face_h face, char **face_id);
/**
- * @brief Gets the media uuid from the face handle.
+ * @brief Gets the media id from the media face handle.
*
* @since_tizen 3.0
*
- * @remarks You must release @a media_id using free().
+ * @remarks The @a media_id should be released using free().
*
- * @param [in] face The face handle
- * @param [out] media_id The media uuid of the face handle
+ * @param[in] face The media face handle
+ * @param[out] media_id The media ID
*
* @return 0 on success, otherwise a negative error value.
*
int media_face_get_media_id(media_face_h face, char **media_id);
/**
- * @brief Gets the face's rectangle from the face handle.
- * @details This API can get the face's rectangle information. returned rectangle information includes the orientation value.
+ * @brief Gets the face's rectangle from the media face handle.
+ * @details This function can get the face's rectangle information. returned rectangle information includes the orientation value.
*
* @since_tizen 3.0
*
- * @param [in] face The face handle
- * @param [out] rect_x The x position of face of the face handle
- * @param [out] rect_y The y position of face of the face handle
- * @param [out] rect_w The width of face of the face handle
- * @param [out] rect_h The height of face of the face handle
+ * @param[in] face The media face handle
+ * @param[out] rect_x The x position of the media face
+ * @param[out] rect_y The y position of the media face
+ * @param[out] rect_w The width of the media face
+ * @param[out] rect_h The height of the media face
*
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
int media_face_get_face_rect(media_face_h face, unsigned int *rect_x, unsigned int *rect_y, unsigned int *rect_w, unsigned int *rect_h);
/**
- * @brief Gets the orientation from the face handle.
- * @details This API can get the orientation value from the original image.
+ * @brief Gets the orientation from the media face handle.
+ * @details This function can get the orientation value from the original image.
*
* @since_tizen 3.0
*
- * @param [in] face The face handle
- * @param [out] orientation The orientation of the face handle
+ * @param[in] face The media face handle
+ * @param[out] orientation The orientation of the media face
*
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
int media_face_get_orientation(media_face_h face, media_content_orientation_e *orientation);
/**
- * @brief Gets the tag from the face handle.
+ * @brief Gets the tag from the media face handle.
*
* @since_tizen 3.0
*
- * @remarks You must release @a tag using free().
+ * @remarks The @a tag should be released using free().
*
- * @param [in] face The face handle
- * @param [out] tag The tag of the face handle
+ * @param[in] face The media face handle
+ * @param[out] tag The tag of the media face
*
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
int media_face_get_tag(media_face_h face, char **tag);
/**
- * @brief Creates the face handle.
+ * @brief Creates the media face handle.
*
* @since_tizen 3.0
*
- * @param [in] media_id The media uuid to create the face handle
- * @param [out] face The face handle
+ * @remarks The @a face should be released using media_face_destroy().
+ *
+ * @param[in] media_id The media ID
+ * @param[out] face The media face handle
*
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
int media_face_create(const char *media_id, media_face_h *face);
/**
- * @brief Sets the face rectangle of the face handle
+ * @brief Sets the face rectangle of the media face handle.
*
* @since_tizen 3.0
*
- * @param[in] face The face handle
+ * @param[in] face The media face handle
* @param[in] rect_x The integer to set as a position x of face rectangle
* @param[in] rect_y The integer to set as a position y of face rectangle
- * @param[in] rect_w The integer to set as a width of face rectangle
+ * @param[in] rect_w The integer to set as a width of face rectangle
* @param[in] rect_h The integer to set as a height of face rectangle
*
* @return 0 on success, otherwise a negative error value.
int media_face_set_face_rect(media_face_h face, unsigned int rect_x, unsigned int rect_y, unsigned int rect_w, unsigned int rect_h);
/**
- * @brief Sets the orientation of the face handle
- * @details This API may set the value of the original image orientation.
+ * @brief Sets the orientation of the media face handle.
+ * @details This function may set the value of the original image orientation.
*
* @since_tizen 3.0
*
- * @param[in] face The face handle
+ * @param[in] face The media face handle
* @param[in] orientation The integer to set as an orientation
*
* @return 0 on success, otherwise a negative error value.
int media_face_set_orientation(media_face_h face, media_content_orientation_e orientation);
/**
- * @brief Sets the tag of the face handle.
+ * @brief Sets the tag of the media face handle.
*
* @since_tizen 3.0
*
- * @param [in] face The face handle
- * @param [in] tag The tag of the face handle
+ * @param[in] face The media face handle
+ * @param[in] tag The tag of the media face
*
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @remarks The created tag handle must be released using media_tag_destroy().
+ * @remarks The @a face should be released using media_face_destroy().
*
- * @param [in] face The face handle
+ * @param[in] face The media face handle
*
* @return 0 on success, otherwise a negative error value.
*
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @param[in] face The face handle to update
+ * @param[in] face The media face handle to update
*
* @return 0 on success, otherwise a negative error value.
*
int media_face_update_to_db(media_face_h face);
/**
- * @brief Deletes the face with given face uuid from the media database.
+ * @brief Deletes the face with given face id from the media database.
*
* @since_tizen 3.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @param [in] face_id The id of media face
+ * @param[in] face_id The ID of the media face
*
* @return 0 on success, otherwise a negative error value.
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @brief Gets the number of media faces with an optional filter from the media database.
* @since_tizen 4.0
*
- * @param[in] filter The handle to the face filter
- * @param[out] face_count The count of the media faces
+ * @param[in] filter The handle to the media filter
+ * @param[out] face_count The count of the media faces
*
* @return @c 0 on success,
* otherwise a negative error value
* If @c NULL is passed to the @a filter, then no filtering is applied.
* @since_tizen 4.0
*
- * @param[in] filter The handle to the face filter
- * @param[in] callback The callback function to be invoked
- * @param[in] user_data The user data to be passed to the callback function
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
}
#endif /* __cplusplus */
-#endif /* __TIZEN_MEDIA_IMAGE_FACE_H__ */
+#endif /* __TIZEN_CONTENT_MEDIA_FACE_H__ */
-#ifndef __TIZEN_MEDIA_FILTER_H__
-#define __TIZEN_MEDIA_FILTER_H__
+#ifndef __TIZEN_CONTENT_MEDIA_FILTER_H__
+#define __TIZEN_CONTENT_MEDIA_FILTER_H__
#include <media_content_type.h>
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release the @a filter handle using media_info_filter_destroy().
+ * @remarks The @a filter should be released using media_info_filter_destroy().
*
- * @param[out] filter A handle to the media filter
+ * @param[out] filter The handle to the media filter
*
* @return @c 0 on success,
* otherwise a negative error value
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[in] filter The handle to the media filter
- * @param[in] offset The start position of the given filter (Starting from zero)
- * @param[in] count The number of items to be searched with respect to the offset
+ * @param[in] offset The start position of the given media filter (Starting from zero)
+ * @param[in] count The number of items to be searched with respect to the offset
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Sets the @a condition for the given @a filter.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] filter The handle to the media filter
- * @param[in] condition The condition which is used WHERE clause on a query
+ * @param[in] filter The handle to the media filter
+ * @param[in] condition The condition which is used WHERE clause on a query
* @param[in] collate_type The collate type for comparing two strings
*
* @return @c 0 on success,
int media_filter_set_condition(filter_h filter, const char *condition, media_content_collation_e collate_type);
/**
- * @brief Sets the media filter content @a order and order keyword i.e. either descending or ascending.
+ * @brief Sets the media filter content @a order_type and @a order_keyword i.e. either descending or ascending.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] filter The handle to the media filter
- * @param[in] order_type The search order type
+ * @param[in] filter The handle to the media filter
+ * @param[in] order_type The search order type
* @param[in] order_keyword The search order keyword
- * @param[in] collate_type The collate type for comparing two strings
+ * @param[in] collate_type The collate type for comparing two strings
*
* @return @c 0 on success,
* otherwise a negative error value
int media_filter_set_order(filter_h filter, media_content_order_e order_type, const char *order_keyword, media_content_collation_e collate_type);
/**
- * @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
+ * @brief Sets the @a storage_id for the given @a filter.
+ * @details You can use this function when you want to search items only in the specific storage
*
* @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
+ * @param[in] filter The handle to the media filter
+ * @param[in] storage_id The ID of the media storage
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the @a offset and @a count for the given @a filter used to limit the number of items returned.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] filter The handle to the media filter
- * @param[out] offset The start position of the given filter (Starting from zero)
- * @param[out] count The number of items to be searched with respect to the offset
+ * @param[in] filter The handle to the media filter
+ * @param[out] offset The start position of the given media filter (Starting from zero)
+ * @param[out] count The number of items to be searched with respect to the offset
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the @a condition for the given @a filter.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a condition using free().
+ * @remarks The @a condition should be released using free().
*
- * @param[in] filter The handle to the media info filter
- * @param[out] condition The condition which is used WHERE clause on a query
+ * @param[in] filter The handle to the media filter
+ * @param[out] condition The condition which is used WHERE clause on a query
* @param[out] collate_type The collate type for comparing two strings
*
* @return @c 0 on success,
int media_filter_get_condition(filter_h filter, char **condition, media_content_collation_e *collate_type);
/**
- * @brief Gets the media filter's content @a order and order keyword i.e. either descending or ascending.
+ * @brief Gets the media filter's content @a order_type and @a order_keyword i.e. either descending or ascending.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a order_keyword using free().
+ * @remarks The @a order_keyword should be released using free().
*
- * @param[in] filter The handle to the media filter
- * @param[out] order_type The search order type
+ * @param[in] filter The handle to the media filter
+ * @param[out] order_type The search order type
* @param[out] order_keyword The search order keyword
- * @param[out] collate_type The collate type for comparing two strings
+ * @param[out] collate_type The collate type for comparing two strings
*
* @return @c 0 on success,
* otherwise a negative error value
int media_filter_get_order(filter_h filter, media_content_order_e* order_type, char **order_keyword, media_content_collation_e *collate_type);
/**
- * @brief Get the @a storage id for given @a filter.
+ * @brief Gets the @a storage_id for given @a filter.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks You must release @a storage_id using free().
+ * @remarks The @a storage_id should be released using free().
*
- * @param[in] filter The handle to media info filter
- * @param[out] storage_id The storage_id which is used in filter
+ * @param[in] filter The handle to the media filter
+ * @param[out] storage_id The ID of the media storage
*
* @return @c 0 on success,
* otherwise a negative error value
}
#endif /* __cplusplus */
-#endif /* __TIZEN_MEDIA_FILTER_H__ */
+#endif /* __TIZEN_CONTENT_MEDIA_FILTER_H__ */
*/
-#ifndef __TIZEN_MEDIA_FOLDER_H__
-#define __TIZEN_MEDIA_FOLDER_H__
+#ifndef __TIZEN_CONTENT_MEDIA_FOLDER_H__
+#define __TIZEN_CONTENT_MEDIA_FOLDER_H__
#include <media_content_type.h>
* @brief Gets the count of folder for the passed @a filter from the media database.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] filter The handle to filter \n
- * To allow searching over different content types, you should use #filter_h.
+ * @param[in] filter The handle to the media filter
* @param[out] folder_count The count of the media folder
*
* @return @c 0 on success,
* So, your callback function is in read state in SQLite. When you are in read state, sometimes you do not update DB. \n
* We do not recommend you call updating DB function in callback of foreach function.
*
- * @param[in] filter The handle to the media folder filter
- * @param[in] callback The callback function to be invoked
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
int media_folder_foreach_folder_from_db(filter_h filter, media_folder_cb callback, void *user_data);
/**
- * @brief Gets the count of media files for the passed @a filter in the given @a folder from the media database.
+ * @brief Gets the count of media files for the passed @a filter in the given @a folder_id from the media database.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] folder_id The ID of the media folder
- * @param[in] filter The filter of the media content
+ * @param[in] folder_id The ID of the media folder
+ * @param[in] filter The handle to the media filter
* @param[out] media_count The count of media folder items
*
* @return @c 0 on success,
int media_folder_get_media_count_from_db(const char *folder_id, filter_h filter, int *media_count);
/**
- * @brief Iterates through the media files with an optional @a filter in the given @a folder from the media database.
+ * @brief Iterates through the media files with an optional @a filter in the given @a folder_id from the media database.
* @details This function gets all media files associated with the given folder and
* meeting desired filter option and calls @a callback for
* every retrieved media item. If @c NULL is passed to the @a filter, no filtering is applied.
* We do not recommend you call updating DB function in callback of foreach function.
*
* @param[in] folder_id The ID of the media folder
- * @param[in] filter The handle to the media info filter
- * @param[in] callback The callback function to be invoked
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks The destination handle must be released with media_folder_destroy().
+ * @remarks The @a dst should be released using media_folder_destroy().
*
* @param[out] dst The destination handle to the media folder
- * @param[in] src The source handle to the media folder
+ * @param[in] src The source handle to the media folder
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the media folder ID.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a folder_id using free().
+ * @remarks The @a folder_id should be released using free().
*
- * @param[in] folder The handle to the media folder
+ * @param[in] folder The handle to the media folder
* @param[out] folder_id The ID of the media folder
*
* @return @c 0 on success,
* @brief Gets the parent folder ID.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks You must release @a parent_folder_id using free().
+ * @remarks The @a parent_folder_id should be released using free().
*
- * @param[in] folder The handle to the media folder
+ * @param[in] folder The handle to the media folder
* @param[out] parent_folder_id The ID of the upper media folder
*
* @return @c 0 on success,
* @brief Gets the absolute path to the media folder.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a path using free().
+ * @remarks The @a path should be released using free().
*
- * @param[in] folder The handle to the media folder
- * @param[out] path The path of the media folder
+ * @param[in] folder The handle to the media folder
+ * @param[out] path The path of the media folder
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the media folder name.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a folder_name using free().
+ * @remarks The @a folder_name should be released using free().
*
- * @param[in] folder The handle to the media folder
+ * @param[in] folder The handle to the media folder
* @param[out] folder_name The name of the media folder
*
* @return @c 0 on success,
* @brief Gets the modified date of the folder.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] folder The handle to the media folder
- * @param[out] date The modified date of the folder
+ * @param[in] folder The handle to the media folder
+ * @param[out] date The modified date of the media folder
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the folder storage type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] folder The handle to the media folder
+ * @param[in] folder The handle to the media folder
* @param[out] storage_type The storage type of the media folder
*
* @return @c 0 on success,
* @brief Gets the storage id of the folder.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks You must release @a storage_id using free().
+ * @remarks The @a storage_id should be released using free().
*
- * @param[in] folder The handle to the media folder
+ * @param[in] folder The handle to the media folder
* @param[out] storage_id The storage id of the media folder
*
* @return @c 0 on success,
* @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
+ * @param[out] order The viewing order of the media folder
*
* @return @c 0 on success,
* otherwise a negative error value
* Media folder will be created, which is filled with folder information.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a folder using media_folder_destroy().
+ * @remarks The @a folder should be released using media_folder_destroy().
*
- * @param[in] folder_id The ID of the media folder
- * @param[out] folder The media folder handle associated with the folder ID
+ * @param[in] folder_id The ID of the media folder
+ * @param[out] folder The handle to the media folder
*
* @return @c 0 on success,
* otherwise a negative error value
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[in] folder The handle to the media folder
- * @param[in] name The name of the media folder
+ * @param[in] name The name of the media folder
*
* @return @c 0 on success,
* otherwise a negative error value
* If you don't use the filter, the set order value does not effect the folder viewing order.
*
* @param[in] folder The handle to the media folder
- * @param[in] order The viewing order of the media folder
+ * @param[in] order The viewing order of the media folder
*
* @return @c 0 on success,
* otherwise a negative error value
}
#endif /* __cplusplus */
-#endif /* __TIZEN_MEDIA_FOLDER_H__ */
+#endif /* __TIZEN_CONTENT_MEDIA_FOLDER_H__ */
* limitations under the License.
*/
-#ifndef __TIZEN_MEDIA_GROUP_H__
-#define __TIZEN_MEDIA_GROUP_H__
+#ifndef __TIZEN_CONTENT_MEDIA_GROUP_H__
+#define __TIZEN_CONTENT_MEDIA_GROUP_H__
#include <media_content_type.h>
* @brief Gets the number of the album for the passed @a filter from the media database.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] filter The media filter handle
+ * @param[in] filter The handle to the media filter
* @param[out] album_count The count of the media album
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] filter The media filter handle
- * @param[in] callback The callback function to be invoked
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* @brief Gets the number of media info for the given album present in the media database.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] album_id The ID of the media album
- * @param[in] filter The media filter handle
- * @param[out] media_count The count of the album
+ * @param[in] album_id The ID of the media album
+ * @param[in] filter The handle to the media filter
+ * @param[out] media_count The count of the media album
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
* @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
* @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
-
*
* @pre This function requires opened connection to content service by media_content_connect().
*
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] album_id The ID of the media album
- * @param[in] filter The media filter handle
- * @param[in] callback The callback function to be invoked
+ * @param[in] album_id The ID of the media album
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] album The media album handle
+ * @param[in] album The handle to the media album
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release the destination handle using media_album_destroy().
+ * @remarks The @a dst should be released using media_album_destroy().
*
- * @param[in] src The source handle to the media album
- * @param[out] dst The destination handle to the media album
+ * @param[out] dst The destination handle to the media album
+ * @param[in] src The source handle to the media album
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the ID of the album.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] album The media album handle
- * @param[out] album_id The media album ID
+ * @param[in] album The handle to the media album
+ * @param[out] album_id The ID of the media album
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the name of the album.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a album_name using free().
+ * @remarks The @a album_name should be released using free().
*
- * @param[in] album The media album handle
- * @param[out] album_name The name of the media album handle
+ * @param[in] album The handle to the media album
+ * @param[out] album_name The name of the media album handle
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the name of the artist from the given album.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a artist using free().
+ * @remarks The @a artist should be released using free().
*
- * @param[in] album The media album handle
+ * @param[in] album The handle to the media album
* @param[out] artist The name of the media artist
*
* @return @c 0 on success,
* @brief Gets the album art path from the album.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a album_art using free().
+ * @remarks The @a album_art should be released using free().
*
- * @param[in] album The media album handle
+ * @param[in] album The handle to the media album
* @param[out] album_art The path of the media album_art
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a folder using media_album_destroy().
+ * @remarks The @a album should be released using media_album_destroy().
*
- * @param[in] album_id The ID of the media album
- * @param[out] album The album handle associated with the album ID
+ * @param[in] album_id The ID of the media album
+ * @param[out] album The handle to the media album
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the number of the group for the passed @a filter from the media database.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] filter The media filter handle
- * @param[in] group The type of the media group
- * @param[out] group_count The count of the media group
+ * @param[in] filter The handle to the media filter
+ * @param[in] group The type of the media group
+ * @param[out] group_count The count of the media group
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] filter The media filter handle
- * @param[in] group The type of the media group
- * @param[in] callback The callback function to be invoked
+ * @param[in] filter The handle to the media filter
+ * @param[in] group The type of the media group
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* @brief Gets the count of the media info for the given media group present in the media database.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] group_name The name of the media group
- * @param[in] group The type of the media group
- * @param[in] filter The media filter handle
+ * @param[in] group_name The name of the media group
+ * @param[in] group The type of the media group
+ * @param[in] filter The handle to the media filter
* @param[out] media_count The count of the media
*
* @return @c 0 on success,
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[in] group_name The name of the media group
- * @param[in] group The type of the media group
- * @param[in] filter The media filter handle
- * @param[in] callback The callback function to be invoked
- * @param[in] user_data The user data to be passed to the callback function
+ * @param[in] group The type of the media group
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
}
#endif /* __cplusplus */
-#endif /* __TIZEN_MEDIA_GROUP_H__ */
+#endif /* __TIZEN_CONTENT_MEDIA_GROUP_H__ */
-#ifndef __TIZEN_IMAGE_META_H__
-#define __TIZEN_IMAGE_META_H__
+#ifndef __TIZEN_CONTENT_MEDIA_IMAGE_H__
+#define __TIZEN_CONTENT_MEDIA_IMAGE_H__
#include <media_content_type.h>
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks The destination handle must be released with image_meta_destroy().
+ * @remarks The @a dst should be released using image_meta_destroy().
*
- * @param[out] dst The destination handle to the image metadata
- * @param[in] src The source handle to the image metadata
+ * @param[out] dst The destination handle to the image metadata
+ * @param[in] src The source handle to the image metadata
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] image The image metadata handle
+ * @param[in] image The handle to the image metadata
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the ID of an image.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] image The image metadata handle
- * @param[out] media_id The ID of an image
+ * @remarks The @a media_id should be released using free().
+ *
+ * @param[in] image The handle to the image metadata
+ * @param[out] media_id The media ID
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the image width in pixels.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] image The image metadata handle
+ * @param[in] image The handle to the image metadata
* @param[out] width The image width in pixels
*
* @return @c 0 on success,
* @brief Gets the image height in pixels.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] image The image metadata handle
+ * @param[in] image The handle to the image metadata
* @param[out] height The image height in pixels
*
* @return @c 0 on success,
* @brief Gets the image orientation.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] image The image metadata handle
+ * @param[in] image The handle to the image metadata
* @param[out] orientation The image orientation
*
* @return @c 0 on success,
* @brief Gets the image creation time.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] image The image metadata handle
+ * @remarks The @a date_taken should be released using free().
+ *
+ * @param[in] image The handle to the image metadata
* @param[out] date_taken The time, when image was taken (in seconds, since the Epoch)
*
* @return @c 0 on success,
* @brief Gets the burst shot ID.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a burst_id using free().
+ * @remarks The @a burst_id should be released using free().
*
- * @param[in] image The image metadata handle
- * @param[out] burst_id The ID of burst shot\ n
+ * @param[in] image The handle to the image metadata
+ * @param[out] burst_id The ID of the burst shot\ n
* If @a burst_id is @c NULL, this is not burst shot
*
* @return @c 0 on success,
int image_meta_get_burst_id(image_meta_h image, char **burst_id) TIZEN_DEPRECATED_API;
/**
- * @brief Gets the exposure time from exif.
+ * @brief Gets the exposure time from EXIF.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks @a exposure time must be released with free() by you.
+ * @remarks The @a exposure_time should be released using free().
*
- * @param[in] image The image metadata handle
- * @param[out] exposure_time The value of exposure_time, getting from exif
+ * @param[in] image The handle to the image metadata
+ * @param[out] exposure_time The value of exposure_time, getting from EXIF
*
* @return 0 on success,
* otherwise a negative error value
int image_meta_get_exposure_time(image_meta_h image, char **exposure_time);
/**
- * @brief Gets the fnumber from exif.
+ * @brief Gets the fnumber from EXIF.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @param[in] image The image metadata handle
- * @param[out] fnumber The value of fnumber, getting from exif
+ * @param[in] image The handle to the image metadata
+ * @param[out] fnumber The value of fnumber, getting from EXIF
*
* @return 0 on success,
* otherwise a negative error value
int image_meta_get_fnumber(image_meta_h image, double *fnumber);
/**
- * @brief Gets the iso from exif.
+ * @brief Gets the iso from EXIF.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @param[in] image The image metadata handle
- * @param[out] iso The value of iso, getting from exif
+ * @param[in] image The handle to the image metadata
+ * @param[out] iso The value of iso, getting from EXIF
*
* @return 0 on success,
* otherwise a negative error value
int image_meta_get_iso(image_meta_h image, int *iso);
/**
- * @brief Gets the model from exif.
+ * @brief Gets the model from EXIF.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks @a model must be released with free() by you.
+ * @remarks The @a model should be released using free().
*
- * @param[in] image The image metadata handle
- * @param[out] model The value of model, getting from exif
+ * @param[in] image The handle to the image metadata
+ * @param[out] model The value of model, getting from EXIF
*
* @return 0 on success,
* otherwise a negative error value
* @brief Checks whether the media is a burst shot image.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] image The image metadata handle
+ * @param[in] image The handle to the image metadata
* @param[out] is_burst_shot @c true if the media is a burst shot image,
* otherwise @c false if the media is not a burst shot image
*
* @brief Sets an orientation of the image.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] image The image metadata handle
+ * @param[in] image The handle to the image metadata
* @param[in] orientation The image orientation
*
* @return @c 0 on success,
*
* @remarks Do not call this function in callback function of foreach function like media_info_foreach_media_from_db().
*
- * @param[in] image The handle to the image
+ * @param[in] image The handle to the image metadata
*
* @return @c 0 on success,
* otherwise a negative error value
}
#endif /* __cplusplus */
-#endif /*__TIZEN_IMAGE_META_H__*/
+#endif /*__TIZEN_CONTENT_MEDIA_IMAGE_H__*/
*/
-#ifndef __TIZEN_MEDIA_INFORMATION_H__
-#define __TIZEN_MEDIA_INFORMATION_H__
+#ifndef __TIZEN_CONTENT_MEDIA_INFO_H__
+#define __TIZEN_CONTENT_MEDIA_INFO_H__
#include <media_content_type.h>
/**
* @file media_info.h
- * @brief This file contains the media info API and related functions to proceed with it. \n
+ * @brief This file contains the media info function and related functions to proceed with it. \n
* You can use the functions to insert, delete, count and get list of content files from media database. \n
* You can get properties of content file such as size, mime_type, modified_time etc. And you can set properties such as provider, favorite etc. \n
* And you can get bookmark, face, tag info related the content file.
/**
* @brief Inserts the content file into the media database.
- * @details In general, you can use this API to insert content files into the media database. \n
- * You can use media_content_scan_file()/media_content_scan_folder() API instead of this API.
+ * @details In general, you can use this function to insert content files into the media database. \n
+ * You can use media_content_scan_file()/media_content_scan_folder() function instead of this function.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* %http://tizen.org/privilege/mediastorage \n
* %http://tizen.org/privilege/externalstorage
*
- * @remarks You must release the handle using media_info_destroy(). \n
+ * @remarks The @a info should be released using media_info_destroy(). \n
* You must add privilege http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path. \n
- * If you want to access only internal storage by using this API, you should add privilege http://tizen.org/privilege/mediastorage. \n
- * Or if you want to access only external storage by using this API, you should add privilege http://tizen.org/privilege/externalstorage. \n
+ * If you want to access only internal storage by using this function, you should add privilege http://tizen.org/privilege/mediastorage. \n
+ * Or if you want to access only external storage by using this function, you should add privilege http://tizen.org/privilege/externalstorage. \n
* If you can access both storage, you must add all privilege.
* @remarks Since 4.0, this function is related to the following feature:\n
* %http://tizen.org/feature/content.scanning.others\n
* If this feature is not suppported on the device, MEDIA_CONTENT_TYPE_OTHERS type file is not scanned.
*
- * @param[in] path The path of the content file to add
+ * @param[in] path The path of the content file to add
* @param[out] info The handle of the inserted content file
*
* @return @c 0 on success,
* %http://tizen.org/privilege/externalstorage
*
* @remarks You must add privilege http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path. \n
- * If you want to access only internal storage by using this API, you should add privilege http://tizen.org/privilege/mediastorage. \n
- * Or if you want to access only external storage by using this API, you should add privilege http://tizen.org/privilege/externalstorage. \n
+ * If you want to access only internal storage by using this function, you should add privilege http://tizen.org/privilege/mediastorage. \n
+ * Or if you want to access only external storage by using this function, you should add privilege http://tizen.org/privilege/externalstorage. \n
* If you can access both storage, you must add all privilege.
* @remarks Since 4.0, this function is related to the following feature:\n
* %http://tizen.org/feature/content.scanning.others\n
* If this feature is not suppported on the device, MEDIA_CONTENT_TYPE_OTHERS type file is not scanned.
*
- * @param[in] path_array The path array of the content files to add
+ * @param[in] path_array The path array of the content files to add
* @param[in] array_length The length of the array
- * @param[in] callback The callback to be invoked when media items inserted completely
- * @param[in] user_data The user data to be passed to the callback function
+ * @param[in] callback The callback function to be invoked when media items inserted completely
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
* %http://tizen.org/privilege/externalstorage
*
* @remarks You must add privilege http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path. \n
- * If you want to access only internal storage with this API, you should add privilege http://tizen.org/privilege/mediastorage. \n
- * Or if you want to access only external storage with this API, you should add privilege http://tizen.org/privilege/externalstorage. \n
+ * If you want to access only internal storage with this function, you should add privilege http://tizen.org/privilege/mediastorage. \n
+ * Or if you want to access only external storage with this function, you should add privilege http://tizen.org/privilege/externalstorage. \n
* If you can access both storage, you must add all privilege.
*
- * @param[in] path_array The path array of the burst shot images to add
+ * @param[in] path_array The path array of the burst shot images to add
* @param[in] array_length The length of the array
- * @param[in] callback The callback to be invoked when the images are inserted completely
- * @param[in] user_data The user data to be passed to the callback function
+ * @param[in] callback The callback function to be invoked when the images are inserted completely
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Deletes the media information from the media database.
* @details This function only remove media information in the media database. \n
- * You can use media_content_scan_file()/media_content_scan_folder() API instead of this API if file is removed from the file system.
+ * You can use media_content_scan_file()/media_content_scan_folder() function instead of this function if file is removed from the file system.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @param[in] media_id The media ID. It can get from media info handle.
+ * @param[in] media_id The media ID. It can get from media info handle.
*
* @return @c 0 on success,
* otherwise a negative error value
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @param[in] filter The filter handle
+ * @param[in] filter The handle to the media filter
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release the destination handle using media_info_destroy().
+ * @remarks The @a dst should be released using media_info_destroy().
*
- * @param[out] dst The destination handle to the media info
- * @param[in] src The source handle to media info
+ * @param[out] dst The destination handle to the media info
+ * @param[in] src The source handle to the media info
*
* @return @c 0 on success,
* otherwise a negative error value
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
*
- * @param[in] filter The handle to filter
+ * @param[in] filter The handle to the media filter
* @param[out] media_count The count of media
*
* @return @c 0 on success,
* So, your callback function is in read state in SQLite. When you are in read state, sometimes you do not update DB.
* We do not recommend you call updating DB function in callback of foreach function.
*
- * @param[in] filter The media info handle filter
- * @param[in] callback The callback function to be invoked
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media_id The ID of the media info
- * @param[in] filter The handle to the media filter
+ * @param[in] media_id The media ID
+ * @param[in] filter The handle to the media filter
* @param[out] tag_count The count of the media tag
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media_id The ID of the media info
- * @param[in] filter The handle to the media filter
- * @param[in] callback The callback function to be invoked
+ * @param[in] media_id The media ID
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media_id The ID of the media info
- * @param[in] filter The handle to the media filter
- * @param[out] bookmark_count The count of the media tag
+ * @param[in] media_id The media ID
+ * @param[in] filter The handle to the media filter
+ * @param[out] bookmark_count The count of the media tag
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media_id The ID of the media info
- * @param[in] filter The handle to the media filter
- * @param[in] callback The callback function to be invoked
+ * @param[in] media_id The media ID
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
*
* @since_tizen 3.0
*
- * @param[in] media_id media id
- * @param[in] filter The handle to the media filter
+ * @param[in] media_id The media ID
+ * @param[in] filter The handle to the media filter
* @param[out] face_count The count of media face
*
* @return 0 on success, otherwise a negative error value.
int media_info_get_face_count_from_db(const char *media_id, filter_h filter, int *face_count);
/**
- * @brief Iterates through the media files with optional @a media_id in the given @a face @a face from the media database.
+ * @brief Iterates through the media files with optional @a filter in the given @a media_id from the media database.
* @details This function gets all media face info associated with the given media id and
* meeting desired filter option and calls @a callback for
* every retrieved media face info. If NULL is passed to the @a filter, no filtering is applied.
*
* @since_tizen 3.0
*
- * @param [in] media_id media id
- * @param[in] filter The handle to the media filter
- * @param [in] callback The callback function to invoke
- * @param [in] user_data The user data to be passed to the callback function
+ * @param[in] media_id The media ID
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to invoke
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return 0 on success, otherwise a negative error value.
*
int media_info_foreach_face_from_db(const char *media_id, filter_h filter, media_face_cb callback, void *user_data);
/**
- * @brief Gets the image metadata handle for a given media info
+ * @brief Gets the image metadata handle for a given media info.
* @details This function returns an image metadata handle retrieved from the media info.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release the @a image handle using image_meta_destroy().
+ * @remarks The @a image should be released using image_meta_destroy().
*
- * @param[in] media The media info handle
- * @param[out] image A handle to image metadata
+ * @param[in] media The handle to the media info
+ * @param[out] image The handle to the image metadata
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release the @a video handle using video_meta_destroy().
+ * @remarks The @a video should be released using video_meta_destroy().
*
- * @param[in] media The media info handle
- * @param[out] video A handle to the video meta
+ * @param[in] media The handle to the media info
+ * @param[out] video The handle to the video metadata
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release the @a audio handle using audio_meta_destroy().
+ * @remarks The @a audio should be released using audio_meta_destroy().
*
- * @param[in] media The media info handle
- * @param[out] audio A handle to the audio meta
+ * @param[in] media The handle to the media info
+ * @param[out] audio The handle to the audio metadata
*
* @return @c 0 on success,
* otherwise a negative error value
int media_info_get_audio(media_info_h media, audio_meta_h *audio);
/**
- * @brief Gets the media ID
+ * @brief Gets the media ID.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @remarks The @a media_id should be released using free().
*
- * @param[in] media The media info handle
- * @param[out] media_id The media ID
+ * @param[in] media The handle to the media info
+ * @param[out] media_id The media ID
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the full path of the content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a path using free().
+ * @remarks The @a path should be released using free().
*
- * @param[in] media The media info handle
- * @param[out] path The full path of the content file
+ * @param[in] media The handle to the media info
+ * @param[out] path The full path of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the file name including the extension of the content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a name using free().
+ * @remarks The @a name should be released using free().
*
- * @param[in] media The media info handle
- * @param[out] name The file name including the extension of the content file
+ * @param[in] media The handle to the media info
+ * @param[out] name The file name including the extension of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the content type of the content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
- * @param[out] type The content type of the content file (#media_content_type_e)
+ * @param[in] media The handle to the media info
+ * @param[out] type The content type of the content file (#media_content_type_e)
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the MIME type of the content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a mime_type using free().
+ * @remarks The @a mime_type should be released using free().
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] mime_type The MIME type of the content file
*
* @return @c 0 on success,
* @brief Gets the content file size.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
- * @param[out] size The content file size
+ * @param[in] media The handle to the media info
+ * @param[out] size The content file size
*
* @return @c 0 on success,
* otherwise a negative error value
* @details The added time refers to the time that content file was first added to media database.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] added_time The added time to the media database
*
* @return @c 0 on success,
* @details The modified time refers to the last modification time provided by the file system.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
- * @param[out] time The last modification time of the content file
+ * @param[in] media The handle to the media info
+ * @param[out] time The last modification time of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
* Otherwise, timeline value is the same as modified time.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
- * @param[out] time The timeline of content file
+ * @param[in] media The handle to the media info
+ * @param[out] time The timeline of content file
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the thumbnail path of content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a path using free(). \n
- * If the thumbnail extraction for the given media has not been requested yet, this API returns NULL. To create a thumbnail, you should use media_info_create_thumbnail() API. \n
+ * @remarks The @a path should be released using free(). \n
+ * If the thumbnail extraction for the given media has not been requested yet, this function returns NULL. To create a thumbnail, you should use media_info_create_thumbnail() function. \n
* Since 3.0, this function returns an empty string if media_info_create_thumbnail() has failed to create a thumbnail for the given media.
*
- * @param[in] media The media info handle
- * @param[out] path The thumbnail path
+ * @param[in] media The handle to the media info
+ * @param[out] path The thumbnail path
*
* @return @c 0 on success,
* otherwise a negative error value
* Since 3.0, if the media info has no description, the method returns empty string.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a description using free().
+ * @remarks The @a description should be released using free().
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] description The description of the content file
*
* @return @c 0 on success,
* @brief Gets the longitude of content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] longitude The longitude of the content file
*
* @return @c 0 on success,
* @brief Gets the latitude of content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] latitude The latitude of the content file
*
* @return @c 0 on success,
* @brief Gets the altitude of content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] altitude The altitude of the content file
*
* @return @c 0 on success,
* @deprecated Deprecated since 4.0.
* @brief Gets the weather of content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @remarks The @a weather should be released using free().
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] weather The weather of the content file
*
* @return @c 0 on success,
* @brief Gets the rating of content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] rating The rating of the content file
*
* @return @c 0 on success,
* @brief Gets the favorite status of content file which User set.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
- * @param[out] favorite @c true if content file is set as favorite,
+ * @param[in] media The handle to the media info
+ * @param[out] favorite @c true if content file is set as favorite,
* otherwise @c false if content file is not set as favorite
*
* @return @c 0 on success,
* @brief Gets the author of content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a author using free().
+ * @remarks The @a author should be released using free().
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] author The author of the content file
*
* @return @c 0 on success,
* @brief Gets the provider of content file which User set.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a provider using free().
+ * @remarks The @a provider should be released using free().
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] provider The provider of the content file
*
* @return @c 0 on success,
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*
- * @see media_info_set_provider()
*/
int media_info_get_provider(media_info_h media, char **provider) TIZEN_DEPRECATED_API;
* @brief Gets the content name of content file which User set.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a content_name using free().
+ * @remarks The @a content_name should be released using free().
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] content_name The content name of the content file
*
* @return @c 0 on success,
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*
- * @see media_info_set_content_name()
*/
int media_info_get_content_name(media_info_h media, char **content_name) TIZEN_DEPRECATED_API;
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a title using free().
+ * @remarks The @a title should be released using free().
*
- * @param[in] media The media info handle
- * @param[out] title The title of the content file
+ * @param[in] media The handle to the media info
+ * @param[out] title The title of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the category of content file which User set.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a category using free().
+ * @remarks The @a category should be released using free().
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] category The category of the content file
*
* @return @c 0 on success,
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*
- * @see media_info_set_category()
*/
int media_info_get_category(media_info_h media, char **category) TIZEN_DEPRECATED_API;
* @brief Gets the location tag of content file which User set.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a location_tag using free().
+ * @remarks The @a location_tag should be released using free().
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] location_tag The location of the content file
*
* @return @c 0 on success,
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*
- * @see media_info_set_location_tag()
*/
int media_info_get_location_tag(media_info_h media, char **location_tag) TIZEN_DEPRECATED_API;
* @brief Gets the age_rating of content file which User set.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a age_rating using free().
+ * @remarks The @a age_rating should be released using free().
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] age_rating The age rating of the content file
*
* @return @c 0 on success,
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*
- * @see media_info_set_age_rating()
*/
int media_info_get_age_rating(media_info_h media, char **age_rating) TIZEN_DEPRECATED_API;
* @brief Gets the keyword of content file which User set.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a keyword using free().
+ * @remarks The @a keyword should be released using free().
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] keyword The keyword of the content file
*
* @return @c 0 on success,
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
*
- * @see media_info_set_keyword()
*/
int media_info_get_keyword(media_info_h media, char **keyword) TIZEN_DEPRECATED_API;
* @brief Gets the storage id of content file.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks You must release @a storage_id using free().
+ * @remarks The @a storage_id should be released using free().
*
- * @param[in] media The media info handle
- * @param[out] storage_id The storage id of the content file
+ * @param[in] media The handle to the media info
+ * @param[out] storage_id The ID of the media storage
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Checks whether the media is protected via DRM.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] is_drm @c true if media is DRM media,
* otherwise @c false if media is not DRM media
*
* @brief Checks whether the content file is 360 content.
* @since_tizen 3.0
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] is_360 @c true if media is 360 content,
* otherwise @c false if media is not 360 content
*
* @brief Gets the storage type of content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[out] storage_type The storage type of the content file
*
* @return @c 0 on success,
* @brief Gets number which represents how many times given content has been played.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @param [in] media The handle to media info
- * @param [out] played_count The counter of content played
+ * @param[in] media The handle to the media info
+ * @param[out] played_count The counter of content played
*
* @return 0 on success,
* otherwise a negative error value
* starting from the beginning of the track.
* @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
+ * @param[in] media The handle to the media info
+ * @param[out] played_time The elapsed time of the content
*
* @return 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a media using media_tag_destroy().
+ * @remarks The @a media should be released using media_info_destroy().
*
- * @param[in] media_id The ID of media info
- * @param[out] media The media handle associated with the media ID
+ * @param[in] media_id The media ID
+ * @param[out] media The handle to the media info
*
* @return @c 0 on success,
* otherwise a negative error value
* @details You can increase the played(opened) count of the content file.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @param [in] media The handle to media info
+ * @param[in] media The handle to the media info
*
* @return 0 on success,
* otherwise a negative error value
* @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
*
- * @param [in] media The handle to media info
+ * @param[in] media The handle to the media info
*
* @return 0 on success,
* otherwise a negative error value
* @brief Sets the file name including the extension of the content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] display_name The file name including the extension of the content file.
*
* @return @c 0 on success,
* @brief Sets the description of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] description The description of the media info
*
* @return @c 0 on success,
* @brief Sets the longitude of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] longitude The longitude of the media info
*
* @return @c 0 on success,
* @brief Sets the latitude of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] latitude The latitude of the media info
*
* @return @c 0 on success,
* @brief Sets the altitude of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] altitude The altitude of the media info
*
* @return @c 0 on success,
* @brief Sets the weather of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] weather The weather of the media info
*
* @return @c 0 on success,
* @brief Sets the rating of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] rating The rating of the media info
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] favorite Set @c true to set the media info as favorite,
* otherwise set @c false to not set the media info as favorite
*
* @brief Sets the author of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] author The author of the media info
*
* @return @c 0 on success,
* @brief Sets the provider of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] provider The provider of the media info
*
* @return @c 0 on success,
* @brief Sets the content name of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] content_name The content name of the media info
*
* @return @c 0 on success,
* @brief Sets the category of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] category The category of the media info
*
* @return @c 0 on success,
* @brief Sets the location tag of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] location_tag The location of the media info
*
* @return @c 0 on success,
* @brief Sets the age rating of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] age_rating The age rating of the media info
*
* @return @c 0 on success,
* @brief Sets the keyword of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] keyword The keyword of the media info
*
* @return @c 0 on success,
* 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.
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @see media_content_connect()
* @see media_info_set_favorite()
- * @see media_info_set_provider()
- * @see media_info_set_category()
- * @see media_info_set_location_tag()
- * @see media_info_set_age_rating()
*/
int media_info_update_to_db(media_info_h media);
* %http://tizen.org/privilege/externalstorage
*
* @remarks You must add privilege http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path. \n
- * If you want to access only internal storage by using this API, you should add privilege http://tizen.org/privilege/mediastorage. \n
- * Or if you want to access only external storage by using this API, you should add privilege http://tizen.org/privilege/externalstorage. \n
+ * If you want to access only internal storage by using this function, you should add privilege http://tizen.org/privilege/mediastorage. \n
+ * Or if you want to access only external storage by using this function, you should add privilege http://tizen.org/privilege/externalstorage. \n
* If you can access both storage, you should add all privilege.
*
- * @param[in] media_id The ID of the media info
+ * @param[in] media_id The media ID
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Sets the added time of media info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] added_time The added time of the media info
*
* @return @c 0 on success,
/**
* @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. \n
- * If the source path and destination path are the same, then this API does nothing.
- * If you want to refresh media information, you should use media_content_scan_file() API.
+ * If the source path and destination path are the same, then this function does nothing.
+ * If you want to refresh media information, you should use media_content_scan_file() function.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* %http://tizen.org/privilege/externalstorage
*
* @remarks You must add privilege http://tizen.org/privilege/content.write. And You add more privilege depending on your choice of contents path. \n
- * If you want to access only internal storage by using this API, you should add privilege http://tizen.org/privilege/mediastorage. \n
- * Or if you want to access only external storage by using this API, you should add privilege http://tizen.org/privilege/externalstorage. \n
+ * If you want to access only internal storage by using this function, you should add privilege http://tizen.org/privilege/mediastorage. \n
+ * Or if you want to access only external storage by using this function, you should add privilege http://tizen.org/privilege/externalstorage. \n
* If you can access both storage, you should add all privilege. \n
- * This API does not support USB storage.
+ * This function does not support USB storage.
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] dst_path The path of destination
*
* @return @c 0 on success,
* Since 3.0, if creation of a thumbnail is failed, empty string will be passed through media_thumbnail_completed_cb().
* Items in external storage except MMC not supported.
*
- * @param[in] media The media info handle
- * @param[in] callback The callback function to be invoked
+ * @param[in] media The handle to the media info
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @remarks If you request cancel for the already thumbnail created media, this API return MEDIA_CONTENT_ERROR_INVALID_OPERATION
+ * @remarks If you request cancel for the already thumbnail created media, this function return MEDIA_CONTENT_ERROR_INVALID_OPERATION
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
*
* @return @c 0 on success,
* otherwise a negative error value
* If face detection fails, the @a face_count argument in media_face_detection_completed_cb() will be set to 0.
* Media items in external storage are not supported, with the exception of MMC items.
*
- * @param[in] media The media info handle
- * @param[in] callback The callback function to be invoked when detection is completed
+ * @param[in] media The handle to the media info
+ * @param[in] callback The callback function to be invoked when detection is completed
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* @ingroup CAPI_CONTENT_MEDIA_FACE_DETECTION_MODULE
* @brief Cancels face detection of image for the given media.
* @details This function cancels face detection for given media item. \n
- * If you cancel face detection request before callback is invoked, the callback registered by media_info_start_face_detection() API will not be invoked.
+ * If you cancel face detection request before callback is invoked, the callback registered by media_info_start_face_detection() function will not be invoked.
*
* @since_tizen 3.0
*
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @remarks If face detection is already done when you request the cancellation, this API return MEDIA_CONTENT_ERROR_INVALID_OPERATION
+ * @remarks If face detection is already done when you request the cancellation, this function return MEDIA_CONTENT_ERROR_INVALID_OPERATION
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
*
* @return @c 0 on success,
* otherwise a negative error value
/**
* @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.
+ * @details If the information about the file that is already known, you can use this function to generate empty handler.
* @since_tizen 3.0
*
*
* @privilege %http://tizen.org/privilege/mediastorage \n
- * %http://tizen.org/privilege/externalstorage
+ * %http://tizen.org/privilege/externalstorage
*
- * @remarks If you want to access only internal storage with this API, you should add privilege http://tizen.org/privilege/mediastorage. \n
- * Or if you want to access only external storage with this API, you should add privilege http://tizen.org/privilege/externalstorage. \n
+ * @remarks The @a media should be released using media_info_destroy().
+ * @remarks If you want to access only internal storage with this function, you should add privilege http://tizen.org/privilege/mediastorage. \n
+ * Or if you want to access only external storage with this function, you should add privilege http://tizen.org/privilege/externalstorage. \n
* If you can access both storage, you must add all privilege.
*
* @param[in] path The path to create the media info handle
- * @param[out] media The media info handle
+ * @param[out] media The handle to the media info
*
* @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_DB_FAILED DB operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB operation failed
* @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
- * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
+ * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
*
* @see media_info_destroy()
*/
* @brief Inserts media info to database with media info data.
* @since_tizen 3.0
*
- * @remarks You must release @a info using media_info_destroy().
- *
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @param[in] media The media info handle to be inserted
+ * @remarks The @a media should be released using media_info_destroy().
+ *
+ * @param[in] media The handle to the media info
*
* @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_DB_FAILED DB operation failed
+ * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB operation failed
* @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
*/
int media_info_insert_to_db_with_data(media_info_h media) TIZEN_DEPRECATED_API;
* @brief Sets the title of media info handle.
* @since_tizen 3.0
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] title The title of media info handle
*
* @return @c 0 on success,
* @brief Sets the album of media info handle.
* @since_tizen 3.0
*
- * @param[in] media The media info handle
- * @param[in] album The album of media info handle
+ * @param[in] media The handle to the media info
+ * @param[in] album The album of the media
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Sets the artist of media info handle.
* @since_tizen 3.0
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] artist The artist of media info handle
*
* @return @c 0 on success,
* @brief Sets the genre of media info handle.
* @since_tizen 3.0
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] genre The genre of media info handle
*
* @return @c 0 on success,
* @brief Sets the recorded date of media info handle.
* @since_tizen 3.0
*
- * @param[in] media The media info handle
+ * @param[in] media The handle to the media info
* @param[in] recorded_date The recorded date of media info handle
*
* @return @c 0 on success,
}
#endif /* __cplusplus */
-#endif /* __TIZEN_MEDIA_INFORMATION_H__ */
+#endif /* __TIZEN_CONTENT_MEDIA_INFO_H__ */
*/
-#ifndef __TIZEN_MEDIA_INFO_PRIVATE_H__
-#define __TIZEN_MEDIA_INFO_PRIVATE_H__
+#ifndef __TIZEN_CONTENT_MEDIA_INFO_PRIVATE_H__
+#define __TIZEN_CONTENT_MEDIA_INFO_PRIVATE_H__
#include <unistd.h>
int _media_db_get_uhd(filter_h filter, media_uhd_cb callback, void *user_data);
void _media_uhd_item_get_detail(sqlite3_stmt* stmt, media_uhd_h uhd);
-/**
- * @internal
- * @brief Creates a media filter attribute handle.
- * @details This function creates a media filter attribute handle. The handle can be
- * used to convert to attributes of database from attributes of user.
- * @remarks The @a handle must be released with media_filter_attribute_destory() by you.
- * @param[out] filter A handle to media filter attribute
- * @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
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
- * @see media_filter_attribute_destory()
- *
- */
int _media_filter_attribute_create(attribute_h *attr);
-
-/**
- * @internal
- * @brief Add the attributes to the handle.
- * @details This function add the attribute to handle.
- * @param[in] filter The handle to media filter attribute
- * @param[in] user_attr The user attribute
- * @param[in] platform_attr The platform attribute
- * @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
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
- * @see media_filter_attribute_remove()
- *
- */
int _media_filter_attribute_add(attribute_h atrr, const char *user_attr, const char *platform_attr);
-
-/**
- * @internal
- * @brief Destroys a media filter attribute handle.
- * @details The function frees all resources related to the media filter attribute handle. The filter attribute
- * handle no longer can be used to perform any operation. A new handle
- * has to be created before the next usage.
- *
- * @param[in] filter The handle to media filter attribute
- * @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_PERMISSION_DENIED Permission denied
- * @see media_filter_create()
- *
- */
int _media_filter_attribute_destory(attribute_h attr);
-
-/**
- * @internal
- * @brief Replace to platform attributes from user attributes.
- * @details This function replace to platform attributes from user attributes to generate the WHERE clause
- * @param[in] filter The handle to media filter attribute
- * @param[in] user_attr The user attribute
- * @param[in] platform_attr The platform attribute
- * @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
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
- * @see media_filter_attribute_create()
- * @see media_filter_attribute_destory()
- *
- */
int _media_filter_attribute_generate(attribute_h attr, filter_h filter, char **generated_condition);
-
-/**
- * @internal
- * @brief Replace to platform attributes from user attributes.
- * @details This function replace to platform attributes from user attributes to generate the WHERE clause
- * @param[in] filter The handle to media filter attribute
- * @param[in] attr The attribute
- * @param[in] generated_option The handle to generated option
- * @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_DB_FAILED Filed DB
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
- * @see media_filter_attribute_create()
- * @see media_filter_attribute_destory()
- *
- */
-
int _media_filter_attribute_option_generate(attribute_h attr, filter_h filter, char **generated_option);
-
int _media_filter_attribute_option_generate_with_full_query(attribute_h attr, filter_h filter, char **generated_option);
GMutex* _content_get_db_mutex(void);
#ifdef __cplusplus
}
#endif /* __cplusplus */
-#endif /*__TIZEN_MEDIA_INFO_PRIVATE_H__*/
+#endif /*__TIZEN_CONTENT_MEDIA_INFO_PRIVATE_H__*/
* limitations under the License.
*/
-#ifndef __TIZEN_MEDIA_PLAYLIST_H__
-#define __TIZEN_MEDIA_PLAYLIST_H__
+#ifndef __TIZEN_CONTENT_MEDIA_PLAYLIST_H__
+#define __TIZEN_CONTENT_MEDIA_PLAYLIST_H__
#include <media_content_type.h>
* @brief Gets the number of playlists for the passed @a filter from the media database.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] filter The handle to the filter
+ * @param[in] filter The handle to the media filter
* @param[out] playlist_count The count of the media playlist
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] filter The handle to the audio filter
- * @param[in] callback The callback function to be invoked
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* @brief Gets the number of the media info for the given playlist present in the media database.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] playlist_id The ID of the media playlist
- * @param[in] filter The media filter handle
- * @param[out] media_count The number of media items
+ * @param[in] playlist_id The ID of the media playlist
+ * @param[in] filter The handle to the media filter
+ * @param[out] media_count The number of media items
*
* @return @c 0 on success,
* otherwise a negative error value
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[in] playlist_id The ID of the media playlist
- * @param[in] filter The audio filter handle
- * @param[in] callback The callback function to be invoked
- * @param[in] user_data The user data to be passed to the callback function
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
+ * @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
* otherwise a negative error value
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @remarks You must release the created handle using media_playlist_destroy().
+ * @remarks The @a playlist should be released using media_playlist_destroy().
*
- * @param[in] name The name of the inserted playlist
- * @param[out] playlist A created handle to media playlist
+ * @param[in] name The name of the inserted playlist
+ * @param[out] playlist The handle to the media playlist
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a playlist using media_playlist_destroy().
+ * @remarksThe @a playlist should be released using media_playlist_destroy().
*
- * @param[in] playlist_id The ID of the media playlist
- * @param[out] playlist The media playlist handle associated with the playlist ID
+ * @param[in] playlist_id The ID of the media playlist
+ * @param[out] playlist The handle to the media playlist
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] playlist The media playlist handle
+ * @param[in] playlist The handle to the media playlist
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks The destination handle must be released using media_playlist_destroy().
+ * @remarks The @ a dst should be released using media_playlist_destroy().
*
- * @param[in] src The source handle of a media playlist
- * @param[out] dst The destination handle to a media playlist
+ * @param[out] dst The destination handle to the media playlist
+ * @param[in] src The source handle to the media playlist
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the media playlist ID.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] playlist The media playlist handle
+ * @param[in] playlist The handle to the media playlist
* @param[out] playlist_id The ID of the media playlist
*
* @return @c 0 on success,
* @brief Gets a name of the playlist.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a playlist_name using free().
+ * @remarks The @a playlist_name should be released using free().
*
- * @param[in] playlist The media playlist handle
+ * @param[in] playlist The handle to the media playlist
* @param[out] playlist_name The playlist name
*
* @return @c 0 on success,
* @brief Sets the name of the playlist.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] playlist The media playlist handle
+ * @param[in] playlist The handle to the media playlist
* @param[in] playlist_name The name of the media playlist
*
* @return @c 0 on success,
* @brief Gets a thumbnail path of the playlist.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a path using free().
+ * @remarks The @a path should be released using free().
*
- * @param[in] playlist The media playlist handle
- * @param[out] path The path of the thumbnail
+ * @param[in] playlist The handle to the media playlist
+ * @param[out] path The path of the thumbnail
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Sets the thumbnail path of the playlist.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] playlist The media playlist handle
- * @param[in] path The path of the thumbnail
+ * @param[in] playlist The handle to the media playlist
+ * @param[in] path The path of the thumbnail
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Sets the playing order in the playlist.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] playlist The media playlist handle
- * @param[in] playlist_member_id The playlist member ID
- * @param[in] play_order The playing order
+ * @param[in] playlist The handle to the media playlist
+ * @param[in] playlist_member_id The ID of the playlist member
+ * @param[in] play_order The playing order
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Adds a new media info to the playlist.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] playlist The media playlist handle
- * @param[in] media_id The ID to the media info which is added
+ * @param[in] playlist The handle to the media playlist
+ * @param[in] media_id The media ID
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Removes the playlist members related with the media from the given playlist.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] playlist The media playlist handle
- * @param[in] playlist_member_id The playlist member ID
+ * @param[in] playlist The handle to the media playlist
+ * @param[in] playlist_member_id The ID of the playlist member
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the played order of the playlist.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] playlist The media playlist handle
- * @param[in] playlist_member_id The playlist member ID
- * @param[out] play_order The played order
+ * @param[in] playlist The handle to the media playlist
+ * @param[in] playlist_member_id The ID of the playlist member
+ * @param[out] play_order The played order
*
* @return @c 0 on success,
* otherwise a negative error value
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @param[in] playlist The media playlist handle
+ * @param[in] playlist The handle to the media playlist
*
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Imports the playlist from m3u playlist file.
- * @details This api reads a playlist from the m3u playlist file and insert into the db.
+ * @details This function reads a playlist from the m3u playlist file and insert into the db.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
+ * @remarks The @ a playlist should be released using media_playlist_destroy().
* @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
- * This api does not support the file of extended m3u playlist.
+ * This function does not support the file of extended m3u playlist.
*
- * @param[in] playlist_name The name of the playlist to save
+ * @param[in] playlist_name The name of the media playlist to save
* @param[in] path The path to import the playlist file
- * @param[out] playlist The media playlist handle
+ * @param[out] playlist The handle to the media playlist
*
* @return @c 0 on success,
* otherwise a negative error value
* @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
*
- * @param[in] playlist The media playlist handle
+ * @param[in] playlist The handle to the media playlist
* @param[in] path path The path to export the playlist
*
* @return @c 0 on success,
#ifdef __cplusplus
}
#endif /* __cplusplus */
-#endif /*__TIZEN_MEDIA_PLAYLIST_H__*/
+#endif /*__TIZEN_CONTENT_MEDIA_PLAYLIST_H__*/
*/
-#ifndef __TIZEN_MEDIA_STORAGE_H__
-#define __TIZEN_MEDIA_STORAGE_H__
+#ifndef __TIZEN_CONTENT_MEDIA_STORAGE_H__
+#define __TIZEN_CONTENT_MEDIA_STORAGE_H__
#include <media_content_type.h>
* @brief Gets media storage from database.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
-* @remarks You must release the handle using media_storage_destroy(). \n
+* @remarks The @a storage should be released using media_storage_destroy().
*
-* @param[in] storage_id The storage id to get media storage info
+* @param[in] storage_id The ID of the media storage
* @param[out] storage The media storage handle
*
* @return @c 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
-* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
-* @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
-* @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
+* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
+* @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
+* @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
* @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
-
*
* @pre This function requires opened connection to content service by media_content_connect().
*
* @brief Gets the count of media storage for the passed @a filter from the media database.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
-* @param[in] filter The handle to filter
+* @param[in] filter The handle to the media filter
* @param[out] storage_count The count of storage
*
* @return @c 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
* @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_DB_FAILED DB Operation failed
+* @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
* @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
*
* @pre This function requires opened connection to content service by media_content_connect().
*
* @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
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
int media_storage_foreach_storage_from_db(filter_h filter, media_storage_cb callback, void *user_data);
/**
- * @brief Gets the count of media files for the passed @a filter in the given @a storage from the media database.
+ * @brief Gets the count of media files for the passed @a filter in the given @a storage_id from the media database.
* @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
+ * @param[in] storage_id The ID of the media storage
+ * @param[in] filter The handle to the media filter
* @param[out] media_count The count of media storage items
*
* @return @c 0 on success,
int media_storage_get_media_count_from_db(const char *storage_id, filter_h filter, int *media_count);
/**
- * @brief Iterates through the media files with an optional @a filter in the given @a storage from the media database.
+ * @brief Iterates through the media files with an optional @a filter in the given @a storage_id from the media database.
* @details This function gets all media files associated with the given storage and
* meeting desired filter option and calls @a callback for
* every retrieved media item. If @c NULL is passed to the @a filter, no filtering is applied.
* We do not recommend you call updating DB function in callback of foreach function.
*
* @param[in] storage_id The ID of the media storage
- * @param[in] filter The handle to the media info filter
- * @param[in] callback The callback function to be invoked
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @param[in] storage The media storage handle
+ * @param[in] storage The media storage handle
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks You must release the destination handle using media_storage_destroy().
+ * @remarksThe @a dst should be released using media_storage_destroy().
*
- * @param[out] dst The destination handle to the media storage
- * @param[in] src The source handle to media storage
+ * @param[out] dst The destination handle to the media storage
+ * @param[in] src The source handle to the media storage
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the storage id of media storage.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks You must release @a storage_id using free().
+ * @remarks The @a storage_id should be released using free().
*
- * @param[in] storage The media storage handle
- * @param[out] storage_id The storage id of the media storage
+ * @param[in] storage The media storage handle
+ * @param[out] storage_id The ID of the media storage
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the storage name of media storage.
* @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.
+ * @remarks The @a storage_name should be released using free().
+ * If the requested storage is not the cloud storage, this function returns NULL.
*
- * @param[in] storage The media storage handle
- * @param[out] storage_name The storage name of the media storage
+ * @param[in] storage The media storage handle
+ * @param[out] storage_name The storage name of the media storage
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the storage path of media storage.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks You must release @a storage_path using free().
+ * @remarks The @a storage_path should be released using free().
*
- * @param[in] storage The media storage handle
- * @param[out] storage_path The storage path of the media storage
+ * @param[in] storage The media storage handle
+ * @param[out] storage_path The storage path of the media storage
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the storage type of media storage.
* @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
+ * @param[in] storage The media storage handle
+ * @param[out] storage_type The storage type of the media storage
*
* @return @c 0 on success,
* otherwise a negative error value
}
#endif /* __cplusplus */
-#endif /* __TIZEN_MEDIA_STORAGE_H__ */
+#endif /* __TIZEN_CONTENT_MEDIA_STORAGE_H__ */
-#ifndef __TIZEN_MEDIA_TAG_H__
-#define __TIZEN_MEDIA_TAG_H__
+#ifndef __TIZEN_CONTENT_MEDIA_TAG_H__
+#define __TIZEN_CONTENT_MEDIA_TAG_H__
#include <media_content_type.h>
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @remarks The created tag handle must be released using media_tag_destroy().
+ * @remarks The @a tag should be released using media_tag_destroy().
*
- * @param[in] tag_name The tag name to be inserted
- * @param[out] tag The created handle to the media tag
+ * @param[in] tag_name The tag name to be inserted
+ * @param[out] tag The handle to the media tag
*
* @return @c 0 on success,
* otherwise a negative error value
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @param[in] tag_id The ID of media tag
+ * @param[in] tag_id The ID of the media tag
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the count of the tag for the passed @a filter from the media database.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] filter The handle to the filter
+ * @param[in] filter The handle to the media filter
* @param[out] tag_count The count of the media tag
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] filter The tag filter handle
- * @param[in] callback The callback function to be invoked
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
int media_tag_foreach_tag_from_db(filter_h filter, media_tag_cb callback, void *user_data);
/**
- * @brief Gets the number of media files for the passed @a filter in the given @a tag from the media database.
+ * @brief Gets the number of media files for the passed @a filter in the given @a tag_id from the media database.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] tag_id The ID of the media tag
- * @param[in] filter The handle to the media filter
+ * @param[in] tag_id The ID of the media tag
+ * @param[in] filter The handle to the media filter
* @param[out] media_count The count of media items
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] tag_id The ID of the media tag
- * @param[in] filter The handle to the media filter
- * @param[in] callback The callback function to be invoked
+ * @param[in] tag_id The ID of the media tag
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
* @param[in] user_data The user data to be passed to the callback function
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release the destination handle using media_tag_destroy().
+ * @remarks The @a dst should be released using media_tag_destroy().
*
* @param[out] dst The destination handle to the media tag
- * @param[in] src The source handle to the media tag
+ * @param[in] src The source handle to the media tag
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] tag The media tag handle
+ * @param[in] tag The handle to the media tag
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the media tag ID.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] tag The media tag handle
- * @param[out] tag_id The ID of the media tag
+ * @param[in] tag The handle to the media tag
+ * @param[out] tag_id The ID of the media tag
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Gets the tag name.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a tag_name using free().
+ * @remarks The @a tag_name should be released using free().
*
- * @param[in] tag The media tag handle
- * @param[out] tag_name The name of the tag
+ * @param[in] tag The handle to the media tag
+ * @param[out] tag_name The name of the media tag
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a folder using media_tag_destroy().
+ * @remarksThe @a tag should be released using media_tag_destroy().
*
- * @param[in] tag_id The ID of the media tag
- * @param[out] tag The media tag handle associated with the tag ID
+ * @param[in] tag_id The ID of the media tag
+ * @param[out] tag The handle to the media tag
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Adds a new media info to the tag.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] tag The media tag handle
- * @param[in] media_id The ID to the media info which is added
+ * @param[in] tag The handle to the media tag
+ * @param[in] media_id The media ID
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Removes the media info from the given tag.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] tag The media tag handle
- * @param[in] media_id The ID to the media info which is removed
+ * @param[in] tag The handle to the media tag
+ * @param[in] media_id The media ID
*
* @return @c 0 on success,
* otherwise a negative error value
* @brief Sets the name of the tag.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] tag The media tag handle
+ * @param[in] tag The handle to the media tag
* @param[in] tag_name The name of the media tag
*
* @return @c 0 on success,
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @param[in] tag The media tag handle
+ * @param[in] tag The handle to the media tag
*
* @return @c 0 on success,
* otherwise a negative error value
}
#endif /* __cplusplus */
-#endif /* __TIZEN_MEDIA_TAG_H__ */
+#endif /* __TIZEN_CONTENT_MEDIA_TAG_H__ */
*/
-#ifndef __TIZEN_MEDIA_UTIL_PRIVATE_H__
-#define __TIZEN_MEDIA_UTIL_PRIVATE_H__
+#ifndef __TIZEN_CONTENT_MEDIA_UTIL_PRIVATE_H__
+#define __TIZEN_CONTENT_MEDIA_UTIL_PRIVATE_H__
#ifdef __cplusplus
#ifdef __cplusplus
}
#endif /* __cplusplus */
-#endif /*__TIZEN_MEDIA_UTIL_PRIVATE_H__*/
+#endif /*__TIZEN_CONTENT_MEDIA_UTIL_PRIVATE_H__*/
*/
-#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>
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release the destination handle using video_meta_destroy().
+ * @remarksThe @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
+ * @param[in] src The source handle to the video metadata
*
* @return @c 0 on success,
* otherwise a negative error value
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @param[in] video The video metadata handle
+ * @param[in] video The handle to the video metadata
*
* @return @c 0 on success,
* otherwise a negative error value
* @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 You must release @a media_id using free().
+ * @remarks The @a media_id should be released using free().
*
- * @param[in] video The video metadata handle
- * @param[out] media_id The ID of the video
+ * @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
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a album using free().
+ * @remarks The @a album should be released using free().
*
- * @param[in] video The video metadata handle
+ * @param[in] video The handle to the video metadata
* @param[out] album The album of the video metadata
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a artist using free().
+ * @remarks The @a artist should be released using free().
*
- * @param[in] video The video metadata handle
+ * @param[in] video The handle to the video metadata
* @param[out] artist The artist of the video metadata
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a album_artist using free().
+ * @remarks The @a album_artist should be released using free().
*
- * @param[in] video The video metadata handle
+ * @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,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a genre using free().
+ * @remarks The @a genre should be released using free().
*
- * @param[in] video The video metadata handle
+ * @param[in] video The handle to the video metadata
* @param[out] genre The genre of the video metadata
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a composer using free().
+ * @remarks The @a composer should be released using free().
*
- * @param[in] video The video metadata handle
+ * @param[in] video The handle to the video metadata
* @param[out] composer The composer of the video metadata
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a year using free().
+ * @remarks The @a year should be released using free().
*
- * @param[in] video The video metadata handle
- * @param[out] year The year of the video metadata
+ * @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
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a recorded_date using free().
+ * @remarks The @a recorded_date should be released using free().
*
- * @param[in] video The video metadata handle
+ * @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,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a copyright using free().
+ * @remarks The @a copyright should be released using free().
*
- * @param[in] video The video metadata handle
+ * @param[in] video The handle to the video metadata
* @param[out] copyright The copyright of the video metadata
*
* @return @c 0 on success,
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
- * @remarks You must release @a track_num using free().
+ * @remarks The @a track_num should be released using free().
*
- * @param[in] video The video metadata handle
+ * @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,
* @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[in] video The handle to the video metadata
* @param[out] bit_rate The video bit rate in bit per second [bps]
*
* @return @c 0 on success,
* @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[in] video The handle to the video metadata
* @param[out] duration The video duration in milliseconds
*
* @return @c 0 on success,
* @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[in] video The handle to the video metadata
* @param[out] width The video width in pixels
*
* @return @c 0 on success,
* @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[in] video The handle to the video metadata
* @param[out] height The video height in pixels
*
* @return @c 0 on success,
* @brief Gets the rotation of the given video metadata.
* @since_tizen 4.0
*
- * @param[in] video The video metadata handle
+ * @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)
*
* @return @c 0 on success,
*
* @remarks Do not call this function in callback function of foreach function like media_info_foreach_media_from_db().
*
- * @param[in] video The video metadata handle
+ * @param[in] video The handle to the video metadata
*
* @return @c 0 on success,
* otherwise a negative error value
}
#endif /* __cplusplus */
-#endif /*__TIZEN_VIDEO_META_H__*/
+#endif /*__TIZEN_CONTENT_MEDIA_VIDEO_H__*/
projects / platform / core / api / media-content.git / commitdiff