* @retval #METADATA_EDITOR_ERROR_PERMISSION_DENIED Permission denied
* @retval #METADATA_EDITOR_ERROR_OPERATION_FAILED Internal Operation Fail
* @pre Create metadata handle by calling metadata_editor_create()
- * @see metadata_editor_create(), metadata_editor_destroy()
+ * @see metadata_editor_create()
+ * @see metadata_editor_destroy()
*/
int metadata_editor_set_path(metadata_editor_h metadata, const char *path);
* @retval #METADATA_EDITOR_ERROR_PERMISSION_DENIED Permission denied
* @retval #METADATA_EDITOR_ERROR_OPERATION_FAILED Internal Operation Fail
* @pre Set path to read or write metadata by calling metadata_editor_set_path()
- * @see metadata_editor_create(), metadata_editor_destroy()
+ * @see metadata_editor_create()
+ * @see metadata_editor_set_path()
+ * @see metadata_editor_destroy()
*/
int metadata_editor_get_metadata(metadata_editor_h metadata, metadata_editor_attr_e attribute, char **value);
/**
* @brief Sets the attribute of the metadata.
* @details This function set the attribute of the metadata for updating the metadata. \n
+ * If @a attribute is #METADATA_EDITOR_ATTR_PICTURE_NUM, this function returns #METADATA_EDITOR_ERROR_INVALID_PARAMETER.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
* @remarks The @a value should be released using free(). \n
- * You must call metadata_editor_update_metadata() for applying to the metadata of the media file. if not, you will see the existing metadata when you call metadata_editor_get_metadata().
+ * You must call metadata_editor_update_metadata() to apply metadata changes to the media file. Otherwise, the previous metadata will be returned when you call metadata_editor_get_metadata().
*
* @param[in] metadata The handle to metadata
* @param[in] attribute key attribute name to get
* @retval #METADATA_EDITOR_ERROR_OUT_OF_MEMORY Out of memory
* @retval #METADATA_EDITOR_ERROR_OPERATION_FAILED Internal Operation Fail
* @pre Set path to read or write metadata by calling metadata_editor_set_path()
- * @see metadata_editor_create(), metadata_editor_update_metadata(), metadata_editor_destroy()
+ * @see metadata_editor_create()
+ * @see metadata_editor_set_path()
+ * @see metadata_editor_update_metadata()
+ * @see metadata_editor_destroy()
*/
int metadata_editor_set_metadata(metadata_editor_h metadata, metadata_editor_attr_e attribute, const char *value);
* @retval #METADATA_EDITOR_ERROR_PERMISSION_DENIED Permission denied
* @retval #METADATA_EDITOR_ERROR_OPERATION_FAILED Internal Operation Fail
* @pre Set path to read or write metadata by calling metadata_editor_set_path()
- * @see metadata_editor_create(), metadata_editor_destroy()
+ * @see metadata_editor_create()
+ * @see metadata_editor_set_path()
+ * @see metadata_editor_destroy()
*/
int metadata_editor_update_metadata(metadata_editor_h metadata);
/**
* @brief Gets the picture in the media file.
+ * @details If there is no picture or if the @a index is invalid, this function returns #METADATA_EDITOR_ERROR_INVALID_PARAMETER.\n
+ * You can get picture number by using metadata_editor_get_metadata() and index starts with 0.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
* @remarks The @a picture and @a mime_type should be released using free(). \n
* For example, if you get the specific path by using storage_get_directory(). you should add privilege http://tizen.org/privilege/mediastorage or http://tizen.org/privilege/externalstorage.
*
* @param[in] metadata The handle to metadata
- * @param[in] index picture order
+ * @param[in] index picture order (starts with 0)
* @param[out] picture encoded picture
* @param[out] size encoded picture size
* @param[out] mime_type the MIME of the picture
* @retval #METADATA_EDITOR_ERROR_OPERATION_FAILED Internal Operation Fail
* @retval #METADATA_EDITOR_ERROR_PERMISSION_DENIED Permission denied
* @pre Set path to read or write metadata by calling metadata_editor_set_path()
- * @see metadata_editor_create(), metadata_editor_destroy()
+ * @see metadata_editor_create()
+ * @see metadata_editor_set_path()
+ * @see metadata_editor_destroy()
*/
int metadata_editor_get_picture(metadata_editor_h metadata, int index, void **picture, int *size, char **mime_type);
* @brief Appends the picture to the media file.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks You must call metadata_editor_update_metadata() for applying to the metadata of the media file. if not, you will see the existing metadata when you call metadata_editor_get_metadata(). \n
+ * @remarks You must call metadata_editor_update_metadata() to apply metadata changes to the media file. Otherwise, the previous metadata will be returned when you call metadata_editor_get_metadata(). \n
* Image type of the metadata supports jpeg and png. \n
* In case of accessing specific path in internal storage or external storage, you may add the privilege for accessing the path. \n
* For example, if you get the specific path by using storage_get_directory(). you should add privilege http://tizen.org/privilege/mediastorage or http://tizen.org/privilege/externalstorage.
* @retval #METADATA_EDITOR_ERROR_OPERATION_FAILED Internal Operation Fail
* @retval #METADATA_EDITOR_ERROR_PERMISSION_DENIED Permission denied
* @pre Set path to read or write metadata by calling metadata_editor_set_path()
- * @see metadata_editor_create(), metadata_editor_destroy()
+ * @see metadata_editor_create()
+ * @see metadata_editor_set_path()
+ * @see metadata_editor_update_metadata()
+ * @see metadata_editor_destroy()
*/
int metadata_editor_append_picture(metadata_editor_h metadata, const char *picture_path);
* @brief Removes artwork image from media file.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*
- * @remarks You must call metadata_editor_update_metadata() for applying to the metadata of the media file. if not, you will see the existing metadata when you call metadata_editor_get_metadata(). \n
+ * @remarks You must call metadata_editor_update_metadata() to apply metadata changes to the media file. Otherwise, the previous metadata will be returned when you call metadata_editor_get_metadata(). \n
* In case of accessing specific path in internal storage or external storage, you may add the privilege for accessing the path. \n
* For example, if you get the specific path by using storage_get_directory(). you should add privilege http://tizen.org/privilege/mediastorage or http://tizen.org/privilege/externalstorage.
*
* @retval #METADATA_EDITOR_ERROR_OPERATION_FAILED Internal Operation Fail
* @retval #METADATA_EDITOR_ERROR_PERMISSION_DENIED Permission denied
* @pre Set path to read or write metadata by calling metadata_editor_set_path()
- * @see metadata_editor_create(), metadata_editor_destroy()
+ * @see metadata_editor_create()
+ * @see metadata_editor_set_path()
+ * @see metadata_editor_update_metadata()
+ * @see metadata_editor_destroy()
*/
int metadata_editor_remove_picture(metadata_editor_h metadata, int index);