/**
* @file media_info.h
* @brief This file contains the media info API and related functions to proceed with it. \n
- * You can use the functions to insert, clone, delete, get the number and content of files from DB. \n
- * You can get and set properties and parameters such as storage type, provider, and category of media info, \n
- * handling with thumbnail and updating media info to DB.
+ * 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 a media file into the media database.
- * @details This function inserts a media item into the content storage.
- * Normally, inserting a media file in database is done automatically by the media server, without calling this function.
- * This function is only called when the media server is busy and the user needs to get quick result of inserting
- * e.g. Taking a photo while media server is busy and the user wants to see the quick snapshot of the photo taken.
+ * @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.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* 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 can access both storage, you must add all privilege.
*
- * @param[in] path The path to the media file
- * @param[out] info The handle to the media info
+ * @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,
* otherwise a negative error value
* @pre This function requires opened connection to content service by media_content_connect().
*
* @see media_content_connect()
+ * @see media_content_scan_file()
+ * @see media_content_scan_folder()
*/
int media_info_insert_to_db(const char *path, media_info_h *info);
/**
- * @brief Inserts media files into the media database, asynchronously.
- * @details This function inserts media items into the content storage.
- * Normally, inserting a media file in database is done automatically by the media server, without calling this function.
- * This function invokes media_insert_completed_cb() callback function when insertion to the media database is finished.
+ * @brief Inserts content files into the media database, asynchronously.
+ * @details This function can insert multiple content files into the media database.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* 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 can access both storage, you must add all privilege.
*
- * @param[in] path_array The path array to the media files
+ * @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
/**
* @brief Inserts the burst shot images into the media database, asynchronously.
- * @details This function inserts burst images into the content storage.
+ * @details This function inserts burst images into the media database.
* media_insert_burst_shot_completed_cb() will be called when insertion to media database is finished.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* Or if you want to access only external storage with this API, 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 to the burst shot images
+ * @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
int media_info_insert_burst_shot_to_db(const char **path_array, unsigned int array_length, media_insert_burst_shot_completed_cb callback, void *user_data);
/**
- * @brief Deletes a media file from the media database.
- * @details This function deletes a media item from the content storage.
- * Normally, deleting a media file in the database is done automatically by the media server, without calling this function.
- * This function is only called when the media server is busy and user needs to get quick result of deleting.
+ * @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.
*
* @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 ID to the media file
+ * @param[in] media_id The media ID. It can get from media info handle.
*
* @return @c 0 on success,
* otherwise a negative error value
* @pre This function requires opened connection to content service by media_content_connect().
*
* @see media_content_connect()
+ * @see media_content_scan_file()
+ * @see media_content_scan_folder()
*/
int media_info_delete_from_db(const char *media_id);
/**
- * @brief Deletes media files from the media database.
- * The media files for deletion can be specified as a condition in a filter.
- * @details This function deletes the media items from the content storage.
- * Normally, deleting media files in the database are done automatically by the media server, without calling this function.
- * This function is only called when the media server is busy and user needs to get quick result of deleting.
+ * @brief Deletes media information that meets the conditions of the filter from the media database.
+ * @details This function can delete multiple media information from the media database.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @privlevel public
* @privilege %http://tizen.org/privilege/content.write
*
- * @param[in] filter The handle to filter
+ * @param[in] filter The filter handle
*
* @return @c 0 on success,
* otherwise a negative error value
* @pre This function requires opened connection to content service by media_content_connect().
*
* @see media_content_connect()
+ * @see media_filter_create()
*/
int media_info_delete_batch_from_db(filter_h filter);
*
* @details This function copies the media info handle from a source to the destination.
* There is no media_info_create() function. The media_info_h is created internally and
- * available through media info foreach function such as media_info_foreach_media_from_db().
+ * available through media info foreach function such as media_info_foreach_media_from_db() or media_info_insert_to_db().
* To use this handle outside of these foreach functions, use this function.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @see media_info_destroy()
* @see media_album_foreach_media_from_db()
* @see media_playlist_foreach_media_from_db()
- * @see media_group_foreach_media_from_db
+ * @see media_group_foreach_media_from_db()
* @see media_tag_foreach_media_from_db()
* @see media_info_foreach_media_from_db()
+ * @see media_info_insert_to_db()
* @see media_folder_foreach_media_from_db()
*/
int media_info_clone(media_info_h *dst, media_info_h src);
/**
* @brief Gets the count of media info for the passed @a filter from the media database.
+ * @details If @c NULL is passed to the @a filter, then no filtering is applied.
+ *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
+ *
* @param[in] filter The handle to filter
* @param[out] media_count The count of media
*
* @pre This function requires opened connection to content service by media_content_connect().
*
* @see media_content_connect()
+ * @see media_filter_create()
*/
int media_info_get_media_count_from_db(filter_h filter, int *media_count);
/**
* @brief Gets the count of media tags for the passed @a filter in the given @a media_id from the media database.
+ * @details If @c NULL is passed to the @a filter, then no filtering is applied.
+ *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[in] media_id The ID of the media info
* @pre This function requires opened connection to content service by media_content_connect().
*
* @see media_content_connect()
+ * @see media_filter_create()
*/
int media_info_get_tag_count_from_db(const char *media_id, filter_h filter, int *tag_count);
/**
* @brief Iterates through the media tag in the given media info from the media database.
- * @details This function gets all the media tags associated with the given @a media_id and calls registered callback function for every retrieved media tag.
+ * @details This function gets all the media tags associated with the given @a media_id and calls registered callback function for every retrieved media tag. \n
+ * If @c NULL is passed to the @a filter, then no filtering is applied.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
*
* @see media_content_connect()
* @see #media_tag_cb
+ * @see media_filter_create()
*/
int media_info_foreach_tag_from_db(const char *media_id, filter_h filter, media_tag_cb callback, void *user_data);
/**
* @brief Gets the number of bookmarks for the passed @a filter in the given media ID from the media database.
+ * @defails If @c NULL is passed to the @a filter, then no filtering is applied.
+ *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[in] media_id The ID of the media info
* @pre This function requires opened connection to content service by media_content_connect().
*
* @see media_content_connect()
+ * @see media_filter_create()
*/
int media_info_get_bookmark_count_from_db(const char *media_id, filter_h filter, int *bookmark_count);
/**
* @brief Iterates through the media bookmark in the given media info from the media database.
* @details This function gets all media bookmarks associated with the given media and calls registered callback function for every retrieved media bookmark.
+ * If @c NULL is passed to the @a filter, then no filtering is applied.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
*
* @see media_content_connect()
* @see media_bookmark_cb()
+ * @see media_filter_create()
*/
int media_info_foreach_bookmark_from_db(const char *media_id, filter_h filter, media_bookmark_cb callback, void *user_data);
/**
* @brief Gets the number of face for the passed @a media_id from the media database.
+ * @defails If @c NULL is passed to the @a filter, then no filtering is applied.
+ *
* @since_tizen 3.0
+ *
* @param[in] media_id 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.
+ *
* @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_PERMISSION_DENIED Permission denied
+ *
* @pre This function requires opened connection to content service by media_content_connect().
* @see media_content_connect()
+ * @see media_filter_create()
*
*/
int media_info_get_face_count_from_db(const char *media_id, filter_h filter, int *face_count);
* @details This function gets all media face info associated with the given media id and
* meeting desired filter option and calls registered callback function 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
+ *
* @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
+ *
* @pre This function requires opened connection to content service by media_content_connect().
* @see media_content_connect()
* @see media_filter_create()
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 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
int media_info_get_image(media_info_h media, image_meta_h *image);
/**
- * @brief Gets a video metadata for a given media info.
+ * @brief Gets a video metadata handle for a given media info.
* @details This function returns a video metadata handle retrieved from the media info handle.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
int media_info_get_video(media_info_h media, video_meta_h *video);
/**
- * @brief Gets an audio metadata for a given media info.
+ * @brief Gets an audio metadata handle for a given media info.
* @details This function returns an audio metadata handle retrieved from the media info handle.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
int media_info_get_audio(media_info_h media, audio_meta_h *audio);
/**
- * @brief Gets the tag ID for the media info.
+ * @brief Gets the media ID
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[in] media The media info handle
- * @param[out] media_id The ID of the media info
+ * @param[out] media_id The media ID
*
* @return @c 0 on success,
* otherwise a negative error value
int media_info_get_media_id(media_info_h media, char **media_id);
/**
- * @brief Gets the path to the media info.
+ * @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().
*
* @param[in] media The media info handle
- * @param[out] path The path of the media info
+ * @param[out] path The full path of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
int media_info_get_file_path(media_info_h media, char **path);
/**
- * @brief Gets the name of the media info.
+ * @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().
*
* @param[in] media The media info handle
- * @param[out] name The name of 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
int media_info_get_display_name(media_info_h media, char **name);
/**
- * @brief Gets the content type of the media info.
+ * @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 type of the media content (#media_content_type_e)
+ * @param[out] type The content type of the content file (#media_content_type_e)
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTENT_ERROR_NONE Successful
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
+ *
+ * @see #media_content_type_e
*/
int media_info_get_media_type(media_info_h media, media_content_type_e *type);
/**
- * @brief Gets the MIME type from the media info.
+ * @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().
*
* @param[in] media The media info handle
- * @param[out] mime_type The MIME type of the media info
+ * @param[out] mime_type The MIME type of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
int media_info_get_mime_type(media_info_h media, char **mime_type);
/**
- * @brief Gets the media file size.
+ * @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 type of the media content
+ * @param[out] size The content file size
*
* @return @c 0 on success,
* otherwise a negative error value
int media_info_get_size(media_info_h media, unsigned long long *size);
/**
- * @brief Gets the addition time of the media.
+ * @brief Gets the added time of the content file.
+ * @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[out] added_time The added time to the DB
+ * @param[out] added_time The added time to the media database
*
* @return @c 0 on success,
* otherwise a negative error value
int media_info_get_added_time(media_info_h media, time_t *added_time);
/**
- * @brief Gets the date of modification of media info.
+ * @brief Gets the modified time of the content file.
+ * @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 date of modification of the file \n
- * Get from the file.
+ * @param[out] time The last modification time of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
int media_info_get_modified_time(media_info_h media, time_t *time);
/**
- * @brief Gets the timeline of media info.
- * @details If the image file has the creation time, the value of the timeline is the creation time.\n
- * Otherwise, the value of the timeline is the same as modified time.
+ * @brief Gets the timeline of content file.
+ * @details If the content file has the creation time information (like Content recored date or Image creation date), that value is timeline. \n
+ * 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 date of the timeline
+ * @param[out] time The timeline of content file
*
* @return @c 0 on success,
* otherwise a negative error value
int media_info_get_timeline(media_info_h media, time_t *time);
/**
- * @brief Gets the thumbnail of media info.
+ * @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
* 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 path to the thumbnail of the media info
+ * @param[out] path The thumbnail path
*
* @return @c 0 on success,
* otherwise a negative error value
int media_info_get_thumbnail_path(media_info_h media, char **path);
/**
- * @brief Gets the description of media info.
+ * @brief Gets the description of content file.
* @details If the value is an empty string, the method returns "Unknown". \n
* 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().
*
* @param[in] media The media info handle
- * @param[out] description The description of the media info
+ * @param[out] description The description of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
int media_info_get_description(media_info_h media, char **description);
/**
- * @brief Gets the longitude of media info.
+ * @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[out] longitude The longitude of the media info
+ * @param[out] longitude The longitude of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
int media_info_get_longitude(media_info_h media, double* longitude);
/**
- * @brief Gets the latitude of media info.
+ * @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[out] latitude The latitude of the media info
+ * @param[out] latitude The latitude of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
int media_info_get_latitude(media_info_h media, double* latitude);
/**
- * @brief Gets the altitude of media info.
+ * @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[out] altitude The altitude of the media info
+ * @param[out] altitude The altitude of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
int media_info_get_altitude(media_info_h media, double* altitude);
/**
- * @brief Gets the weather of media info.
+ * @brief Gets the weather of content file.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @param[in] media The media info handle
- * @param[out] weather The weather of the media info
+ * @param[out] weather The weather of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
int media_info_get_weather(media_info_h media, char **weather);
/**
- * @brief Gets the rating of media info.
+ * @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[out] rating The rating of the media info
+ * @param[out] rating The rating of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
int media_info_get_rating(media_info_h media, int *rating);
/**
- * @brief Gets the favorite status of media info.
+ * @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 media info is set as favorite,
- * otherwise @c false if media info is not set as favorite
+ * @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,
* 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_info_set_favorite()
*/
int media_info_get_favorite(media_info_h media, bool* favorite);
/**
- * @brief Gets the author of media info.
+ * @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().
*
* @param[in] media The media info handle
- * @param[out] author The author of the media info
+ * @param[out] author The author of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
int media_info_get_author(media_info_h media, char **author);
/**
- * @brief Gets the provider of media info.
+ * @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().
*
* @param[in] media The media info handle
- * @param[out] provider The provider of the media info
+ * @param[out] provider The provider of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
+ *
+ * @see media_info_set_provider()
*/
int media_info_get_provider(media_info_h media, char **provider);
/**
- * @brief Gets the content name of media info.
+ * @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().
*
* @param[in] media The media info handle
- * @param[out] content_name The content name of the media info
+ * @param[out] content_name The content name of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
+ *
+ * @see media_info_set_content_name()
*/
int media_info_get_content_name(media_info_h media, char **content_name);
/**
- * @brief Gets the title of media info.
+ * @brief Gets the title of content file.
* @details If the value is an empty string, the method returns "Unknown". \n
- * Since 3.0, if the media info has no title, the method returns empty string.
+ * Since 3.0, if the content file has no title, the method returns empty string.
*
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @remarks You must release @a title using free().
*
* @param[in] media The media info handle
- * @param[out] title The title of the media info
+ * @param[out] title The title of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
int media_info_get_title(media_info_h media, char **title);
/**
- * @brief Gets the category of media info.
+ * @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().
*
* @param[in] media The media info handle
- * @param[out] category The category of the media info
+ * @param[out] category The category of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
+ *
+ * @see media_info_set_category()
*/
int media_info_get_category(media_info_h media, char **category);
/**
- * @brief Gets the location tag of media info.
+ * @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().
*
* @param[in] media The media info handle
- * @param[out] location_tag The location of the media info
+ * @param[out] location_tag The location of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
+ *
+ * @see media_info_set_location_tag()
*/
int media_info_get_location_tag(media_info_h media, char **location_tag);
/**
- * @brief Gets the age_rating of media info.
+ * @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().
*
* @param[in] media The media info handle
- * @param[out] age_rating The age rating of the media info
+ * @param[out] age_rating The age rating of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
+ *
+ * @see media_info_set_age_rating()
*/
int media_info_get_age_rating(media_info_h media, char **age_rating);
/**
- * @brief Gets the keyword of media info.
+ * @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().
*
* @param[in] media The media info handle
- * @param[out] keyword The keyword of the media info
+ * @param[out] keyword The keyword of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
* @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY Out of memory
* @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
+ *
+ * @see media_info_set_keyword()
*/
int media_info_get_keyword(media_info_h media, char **keyword);
/**
- * @brief Gets the storage id of media info.
+ * @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().
*
* @param[in] media The media info handle
- * @param[out] storage_id The storage id of the media info
+ * @param[out] storage_id The storage id of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
int media_info_is_drm(media_info_h media, bool *is_drm);
/**
- * @brief Checks whether the media is 360 content.
+ * @brief Checks whether the content file is 360 content.
* @since_tizen 3.0
*
* @param[in] media The media info handle
int media_info_is_360_content(media_info_h media, bool *is_360);
/**
- * @brief Gets the storage type of media info.
+ * @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[out] storage_type The storage type of the media info
+ * @param[out] storage_type The storage type of the content file
*
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Increments the played count to content meta handle.
- * @details You can increase the played(opened) count of the media file.
+ * @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
/**
* @brief Sets the played time to content meta handle.
- * @details You can set the latest played(opened) time of the media file. the latest played time to be set the current time on the system.
+ * @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
int media_info_set_played_time(media_info_h media);
/**
- * @brief Sets the display name of media info.
+ * @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] display_name The display name of the media info
+ * @param[in] display_name The file name including the extension of the content file.
*
* @return @c 0 on success,
* otherwise a negative error value
int media_info_move_to_db(media_info_h media, const char* dst_path);
/**
- * @brief Creates a thumbnail image for the given media, asynchronously.
- * @details This function creates an thumbnail image for given media item and calls registered callback function for completion of creating the thumbnail.
+ * @brief Creates a thumbnail file for the given media, asynchronously.
+ * @details This function creates an thumbnail file for given media item and calls registered callback function for completion of creating the thumbnail.
* If a thumbnail already exists for the given media, then the path of thumbnail will be returned in callback function. \n
* Since 3.0, a thumbnail is not automatically extracted during media scanning. \n
* Therefore, if there exists no thumbnail for the given media, you MUST call this function to create a thumbnail.
int media_info_create_thumbnail(media_info_h media, media_thumbnail_completed_cb callback, void *user_data);
/**
- * @brief Cancels the creation of image's thumbnail for the given media.
+ * @brief Cancels the creation of thumbnail file for the given media.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*
* @privlevel public
projects / platform / core / api / media-content.git / commitdiff