summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMinje Ahn <minje.ahn@samsung.com>2017-05-26 16:19:53 +0900
committerMinje Ahn <minje.ahn@samsung.com>2017-05-26 16:19:53 +0900
commit16f4296c48be787603408f65d62c71d0d6164870 (patch)
tree9b390e68e66fca7b71c5e231bbcc086f687ed3de
parentfebf1df331d29d5c4e09dfccd5854eea529204af (diff)
downloadmetadata-extractor-16f4296c48be787603408f65d62c71d0d6164870.tar.gz
metadata-extractor-16f4296c48be787603408f65d62c71d0d6164870.tar.bz2
metadata-extractor-16f4296c48be787603408f65d62c71d0d6164870.zip
Change-Id: I49c7059cd1e5577f8f4cbe81a7ef2bcd0d1883a0 Signed-off-by: Minje Ahn <minje.ahn@samsung.com>
-rwxr-xr-xinclude/metadata_extractor.h48
1 files changed, 30 insertions, 18 deletions
diff --git a/include/metadata_extractor.h b/include/metadata_extractor.h
index da63d8f..efcfd1d 100755
--- a/include/metadata_extractor.h
+++ b/include/metadata_extractor.h
@@ -43,12 +43,13 @@ extern "C" {
* @remarks You must release @a metadata using metadata_extractor_destroy().
*
* @param[in] metadata The handle to metadata
- * @return @c 0 on success,
- * otherwise a negative error value
+ *
+ * @return @c 0 on success, otherwise a negative error value
* @retval #METADATA_EXTRACTOR_ERROR_NONE Successful
* @retval #METADATA_EXTRACTOR_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #METADATA_EXTRACTOR_ERROR_OUT_OF_MEMORY Not enough memory is available
* @retval #METADATA_EXTRACTOR_ERROR_PERMISSION_DENIED Permission denied
+ *
* @see metadata_extractor_destroy()
*/
int metadata_extractor_create(metadata_extractor_h *metadata);
@@ -56,15 +57,17 @@ int metadata_extractor_create(metadata_extractor_h *metadata);
/**
* @brief Sets the file path to extract.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ *
* @param [in] metadata The handle to metadata
* @param [in] path The path to extract metadata
- * @return @c 0 on success,
- * otherwise a negative error value
+ *
+ * @return @c 0 on success, otherwise a negative error value
* @retval #METADATA_EXTRACTOR_ERROR_NONE Successful
* @retval #METADATA_EXTRACTOR_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #METADATA_EXTRACTOR_ERROR_FILE_EXISTS File does not exist
* @retval #METADATA_EXTRACTOR_ERROR_OPERATION_FAILED Internal operation failed
* @retval #METADATA_EXTRACTOR_ERROR_PERMISSION_DENIED Permission denied
+ *
* @pre Create a metadata handle by calling metadata_extractor_create().
* @see metadata_extractor_create()
* @see metadata_extractor_destroy()
@@ -74,15 +77,17 @@ int metadata_extractor_set_path(metadata_extractor_h metadata, const char *path)
/**
* @brief Sets the buffer to extract.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ *
* @param [in] metadata The handle to metadata
* @param [in] buffer The buffer to extract metadata
* @param [in] size The buffer size
- * @return @c 0 on success,
- * otherwise a negative error value
+ *
+ * @return @c 0 on success, otherwise a negative error value
* @retval #METADATA_EXTRACTOR_ERROR_NONE Successful
* @retval #METADATA_EXTRACTOR_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #METADATA_EXTRACTOR_ERROR_OPERATION_FAILED Internal operation failed
* @retval #METADATA_EXTRACTOR_ERROR_PERMISSION_DENIED Permission denied
+ *
* @pre Create a metadata handle by calling metadata_extractor_create().
* @see metadata_extractor_create()
* @see metadata_extractor_destroy()
@@ -92,13 +97,15 @@ int metadata_extractor_set_buffer(metadata_extractor_h metadata, const void *buf
/**
* @brief Destroys metadata.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ *
* @param [in] metadata The handle to metadata
- * @return @c 0 on success,
- * otherwise a negative error value
+ *
+ * @return @c 0 on success, otherwise a negative error value
* @retval #METADATA_EXTRACTOR_ERROR_NONE Successful
* @retval #METADATA_EXTRACTOR_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #METADATA_EXTRACTOR_ERROR_OPERATION_FAILED Internal operation failed
* @retval #METADATA_EXTRACTOR_ERROR_PERMISSION_DENIED Permission denied
+ *
* @pre Create a metadata handle by calling metadata_extractor_create().
* @see metadata_extractor_create()
*/
@@ -115,13 +122,14 @@ int metadata_extractor_destroy(metadata_extractor_h metadata);
* @param[in] metadata The handle to metadata
* @param[in] attribute The key attribute name to get
* @param[out] value The value of the attribute
- * @return @c 0 on success,
- * otherwise a negative error value
+ *
+ * @return @c 0 on success, otherwise a negative error value
* @retval #METADATA_EXTRACTOR_ERROR_NONE Successful
* @retval #METADATA_EXTRACTOR_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #METADATA_EXTRACTOR_ERROR_OUT_OF_MEMORY Not enough memory is available
* @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().
* @see metadata_extractor_create()
* @see metadata_extractor_destroy()
@@ -140,13 +148,14 @@ int metadata_extractor_get_metadata(metadata_extractor_h metadata, metadata_extr
* @param[out] artwork The encoded artwork image
* @param[out] size The encoded artwork size
* @param[out] mime_type The mime type of artwork
- * @return @c 0 on success,
- * otherwise a negative error value
+ * @return @c 0 on success, otherwise a negative error value
+ *
* @retval #METADATA_EXTRACTOR_ERROR_NONE Successful
* @retval #METADATA_EXTRACTOR_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #METADATA_EXTRACTOR_ERROR_OUT_OF_MEMORY Not enough memory is available
* @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().
* @see metadata_extractor_create()
* @see metadata_extractor_destroy()
@@ -164,13 +173,14 @@ int metadata_extractor_get_artwork(metadata_extractor_h metadata, void **artwork
* @param[in] metadata The handle to metadata
* @param[out] frame The raw frame data in RGB888
* @param[out] size The frame data size
- * @return @c 0 on success,
- * otherwise a negative error value
+ *
+ * @return @c 0 on success, otherwise a negative error value
* @retval #METADATA_EXTRACTOR_ERROR_NONE Successful
* @retval #METADATA_EXTRACTOR_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #METADATA_EXTRACTOR_ERROR_OUT_OF_MEMORY Not enough memory is available
* @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().
* @see metadata_extractor_create()
* @see metadata_extractor_destroy()
@@ -189,12 +199,13 @@ int metadata_extractor_get_frame(metadata_extractor_h metadata, void **frame, in
* @param[in] index The index of time/lyrics to set
* @param[out] time_stamp The time information of the index
* @param[out] lyrics The lyrics of the index
- * @return @c 0 on success,
- * otherwise a negative error value
+ *
+ * @return @c 0 on success, otherwise a negative error value
* @retval #METADATA_EXTRACTOR_ERROR_NONE Successful
* @retval #METADATA_EXTRACTOR_ERROR_INVALID_PARAMETER Invalid parameter
* @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 Get the time/lyrics set number by calling metadata_extractor_get_metadata(METADATA_SYNCLYRICS_NUM).
* @see metadata_extractor_create()
@@ -216,13 +227,14 @@ int metadata_extractor_get_synclyrics(metadata_extractor_h metadata, int index,
* otherwise @c false if the user can only get the nearest i-frame of the video rapidly
* @param[out] frame The raw frame data in RGB888
* @param[out] size The frame data size
- * @return @c 0 on success,
- * otherwise a negative error value
+ *
+ * @return @c 0 on success, otherwise a negative error value
* @retval #METADATA_EXTRACTOR_ERROR_NONE Successful
* @retval #METADATA_EXTRACTOR_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #METADATA_EXTRACTOR_ERROR_OUT_OF_MEMORY Not enough memory is available
* @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().
* @see metadata_extractor_create()
* @see metadata_extractor_destroy()