From cc10d23d7c3ff336ae84874397f8ff09006e69f3 Mon Sep 17 00:00:00 2001 From: hjkim Date: Wed, 25 Sep 2024 14:41:39 +0900 Subject: [PATCH] Improve API description Change-Id: If80364724afb17c53ce44378c75570f1fd06c550 --- doc/metadata_extractor_doc.h | 4 ++-- include/metadata_extractor.h | 20 +++++++++++--------- packaging/capi-media-metadata-extractor.spec | 2 +- 3 files changed, 14 insertions(+), 12 deletions(-) diff --git a/doc/metadata_extractor_doc.h b/doc/metadata_extractor_doc.h index ad7bf29..aecf089 100644 --- a/doc/metadata_extractor_doc.h +++ b/doc/metadata_extractor_doc.h @@ -31,13 +31,13 @@ /** * @addtogroup CAPI_METADATA_EXTRACTOR_MODULE - * @brief The @ref CAPI_METADATA_EXTRACTOR_MODULE API provides functions for extracting the metadata from an input media file. + * @brief The @ref CAPI_METADATA_EXTRACTOR_MODULE API provides functions for extracting the metadata from an input media. * @ingroup CAPI_MEDIA_FRAMEWORK * @section CAPI_METADATA_EXTRACTOR_MODULE_HEADER Required Header * \#include * * @section CAPI_METADATA_EXTRACTOR_OVERVIEW Overview - * The @ref CAPI_METADATA_EXTRACTOR_MODULE API allows you to extract the metadata from a media file. To extract a particular type of metadata(#metadata_extractor_attr_e), create/destroy the handle(#metadata_extractor_create()/#metadata_extractor_destroy). To set the path for extracting, and call metadata_extractor_get_metadata(). + * The @ref CAPI_METADATA_EXTRACTOR_MODULE API allows you to extract the metadata from a media. To extract a particular type of metadata(#metadata_extractor_attr_e), create/destroy the handle(#metadata_extractor_create()/#metadata_extractor_destroy). To set the path for extracting, and call metadata_extractor_get_metadata(). */ #endif /* __TIZEN_MEDIA_METADATA_EXTRACTOR_DOC_H__ */ diff --git a/include/metadata_extractor.h b/include/metadata_extractor.h index 548b140..2862fd9 100644 --- a/include/metadata_extractor.h +++ b/include/metadata_extractor.h @@ -69,6 +69,7 @@ int metadata_extractor_create(metadata_extractor_h *metadata); * @pre Create a metadata handle by calling metadata_extractor_create(). * @see metadata_extractor_create() * @see metadata_extractor_destroy() + * @see metadata_extractor_set_buffer() */ int metadata_extractor_set_path(metadata_extractor_h metadata, const char *path); @@ -88,6 +89,7 @@ int metadata_extractor_set_path(metadata_extractor_h metadata, const char *path) * @pre Create a metadata handle by calling metadata_extractor_create(). * @see metadata_extractor_create() * @see metadata_extractor_destroy() + * @see metadata_extractor_set_path() */ int metadata_extractor_set_buffer(metadata_extractor_h metadata, const void *buffer, int size); @@ -108,7 +110,7 @@ int metadata_extractor_set_buffer(metadata_extractor_h metadata, const void *buf int metadata_extractor_destroy(metadata_extractor_h metadata); /** - * @brief Gets metadata. + * @brief Gets metadata of a media. * @since_tizen 2.3 * * @remarks The @a value should be released using free(). \n @@ -126,14 +128,14 @@ int metadata_extractor_destroy(metadata_extractor_h metadata); * @retval #METADATA_EXTRACTOR_ERROR_OPERATION_FAILED Internal operation failed * @retval #METADATA_EXTRACTOR_ERROR_PERMISSION_DENIED Permission denied * - * @pre Set the path to extract by calling metadata_extractor_set_path(). + * @pre Set the path or buffer to extract by calling metadata_extractor_set_path() or metadata_extractor_set_buffer(). * @see metadata_extractor_create() * @see metadata_extractor_destroy() */ int metadata_extractor_get_metadata(metadata_extractor_h metadata, metadata_extractor_attr_e attribute, char **value); /** - * @brief Gets the artwork image in a media file. + * @brief Gets the artwork image of a media. * @since_tizen 2.3 * * @remarks The @a artwork and @a mime_type should be released using free(). \n @@ -152,14 +154,14 @@ int metadata_extractor_get_metadata(metadata_extractor_h metadata, metadata_extr * @retval #METADATA_EXTRACTOR_ERROR_OPERATION_FAILED Internal operation failed * @retval #METADATA_EXTRACTOR_ERROR_PERMISSION_DENIED Permission denied * - * @pre Set the path to extract by calling metadata_extractor_set_path(). + * @pre Set the path or buffer to extract by calling metadata_extractor_set_path() or metadata_extractor_set_buffer(). * @see metadata_extractor_create() * @see metadata_extractor_destroy() */ int metadata_extractor_get_artwork(metadata_extractor_h metadata, void **artwork, int *size, char **mime_type); /** - * @brief Gets the frame of a video media file. + * @brief Gets the frame of a video media. * @since_tizen 2.3 * * @remarks The @a frame should be released using free(). @@ -177,14 +179,14 @@ int metadata_extractor_get_artwork(metadata_extractor_h metadata, void **artwork * @retval #METADATA_EXTRACTOR_ERROR_OPERATION_FAILED Internal operation failed * @retval #METADATA_EXTRACTOR_ERROR_PERMISSION_DENIED Permission denied * - * @pre Set the path to extract by calling metadata_extractor_set_path(). + * @pre Set the path or buffer to extract by calling metadata_extractor_set_path() or metadata_extractor_set_buffer(). * @see metadata_extractor_create() * @see metadata_extractor_destroy() */ int metadata_extractor_get_frame(metadata_extractor_h metadata, void **frame, int *size); /** - * @brief Gets the synclyrics of a media file. + * @brief Gets the synclyrics of a media. * @since_tizen 2.3 * * @remarks The @a lyrics should be released using free(). @@ -202,7 +204,7 @@ int metadata_extractor_get_frame(metadata_extractor_h metadata, void **frame, in * @retval #METADATA_EXTRACTOR_ERROR_OPERATION_FAILED Internal operation failed * @retval #METADATA_EXTRACTOR_ERROR_PERMISSION_DENIED Permission denied * - * @pre Set the path to extract by calling metadata_extractor_set_path(). + * @pre Set the path or buffer to extract by calling metadata_extractor_set_path() or metadata_extractor_set_buffer(). * @pre Get the time/lyrics set number by calling metadata_extractor_get_metadata(METADATA_SYNCLYRICS_NUM). * @see metadata_extractor_create() * @see metadata_extractor_destroy() @@ -231,7 +233,7 @@ int metadata_extractor_get_synclyrics(metadata_extractor_h metadata, int index, * @retval #METADATA_EXTRACTOR_ERROR_OPERATION_FAILED Internal operation failed * @retval #METADATA_EXTRACTOR_ERROR_PERMISSION_DENIED Permission denied * - * @pre Set the path to extract by calling metadata_extractor_set_path(). + * @pre Set the path or buffer to extract by calling metadata_extractor_set_path() or metadata_extractor_set_buffer(). * @see metadata_extractor_create() * @see metadata_extractor_destroy() */ diff --git a/packaging/capi-media-metadata-extractor.spec b/packaging/capi-media-metadata-extractor.spec index e7f2df7..009ec2f 100644 --- a/packaging/capi-media-metadata-extractor.spec +++ b/packaging/capi-media-metadata-extractor.spec @@ -1,6 +1,6 @@ Name: capi-media-metadata-extractor Summary: A media metadata extractor library in Tizen Native API -Version: 0.2.0 +Version: 0.2.1 Release: 0 Group: Multimedia/API License: Apache-2.0 -- 2.34.1