summaryrefslogtreecommitdiff
path: root/include/media-thumbnail.h
diff options
context:
space:
mode:
authorMinje Ahn <minje.ahn@samsung.com>2015-06-05 16:01:28 +0900
committerMinje Ahn <minje.ahn@samsung.com>2015-06-05 16:25:21 +0900
commitbe3906afcd5d61009fa339b320305b04b5e89c64 (patch)
treed47c653ee0849bde15c4aa152a18dc925291d620 /include/media-thumbnail.h
parent147bd126e27935c2f61283e0b9b247b713744127 (diff)
downloadlibmedia-thumbnail-be3906afcd5d61009fa339b320305b04b5e89c64.tar.gz
libmedia-thumbnail-be3906afcd5d61009fa339b320305b04b5e89c64.tar.bz2
libmedia-thumbnail-be3906afcd5d61009fa339b320305b04b5e89c64.zip
Modify error type(annotation)
Change-Id: I0145b68cc08a327048b3f8c945dcc5af0bef0f8a Signed-off-by: Minje Ahn <minje.ahn@samsung.com>
Diffstat (limited to 'include/media-thumbnail.h')
-rwxr-xr-xinclude/media-thumbnail.h172
1 files changed, 0 insertions, 172 deletions
diff --git a/include/media-thumbnail.h b/include/media-thumbnail.h
index f3b6148..8983e76 100755
--- a/include/media-thumbnail.h
+++ b/include/media-thumbnail.h
@@ -32,185 +32,19 @@ extern "C" {
#endif
-/**
- @defgroup THUMB_GENERATE Thumbnail generator
- @{
- * @file media-thumbnail.h
- * @brief This file defines API's for thumbnail generator.
- * @version 1.0
- */
-
-/**
- @defgroup THUMB_API Thumbnail generator API
- @{
-
- @par
- generates thumbnail data and return the path of the generated thumbnail file.
- */
-
-/**
- * Callback function, which is used to call thumbnail_request_from_db_async
- */
typedef int (*ThumbFunc) (int error_code, char* path, void* data);
-
-/**
- * thumbnail_request_from_db:
- * This function connects to the media database and find thumbnail path of the passed original image.
- * If found, the thumbnail path will be returned, or starts to generate thumbnail
- *
- * @return This function returns zero(MEDIA_THUMB_ERROR_NONE) on success, or negative value with error code.
- * Please refer 'media-thumb-error.h' to know the exact meaning of the error.
- * @param[in] origin_path The path of the original image
- * @param[out] thumb_path The path of generated thumbnail image.
- * @param[in] max_length The max length of the returned thumbnail path.
- * @see None.
- * @pre None.
- * @post None.
- * @remark The database name is "/opt/usr/dbspace/.media.db".
- * @par example
- * @code
-
-#include <media-thumbnail.h>
-
-void gen_thumbs()
-{
- int ret = MEDIA_THUMB_ERROR_NONE;
- const char *origin_path = "/opt/usr/media/test.jpg";
- char thumb_path[255];
-
- ret = thumbnail_request_from_db(origin_path, thumb_path, 255);
-
- if (ret < 0)
- {
- printf( "thumbnail_request_from_db fails. error code->%d", ret);
- }
-
- return;
-}
-
- * @endcode
- */
int thumbnail_request_from_db(const char *origin_path, char *thumb_path, int max_length, uid_t uid);
-/**
- * thumbnail_request_from_db_async:
- * This function connects to the media database and find thumbnail path of the passed original image.
- * If found, the thumbnail path will be returned through callback, which is registered by user.
- *
- * @return This function returns zero(MEDIA_THUMB_ERROR_NONE) on success, or negative value with error code.
- * Please refer 'media-thumb-error.h' to know the exact meaning of the error.
- * @param[in] origin_path The path of the original image
- * @param[in] func The callback, which is registered by user
- * @param[in] user_data User data, which is used by user in callback
- * @see None.
- * @pre None.
- * @post None.
- * @remark The database name is "/opt/usr/dbspace/.media.db".
- * @par example
- * @code
-
-#include <media-thumbnail.h>
-
-int _thumb_cb(int error_code, char *path, void *user_data)
-{
- printf("Error code : %d\n", error_code);
- printf("Thumb path : %s\n", path);
-}
-
-void gen_thumbs()
-{
- int ret = MEDIA_THUMB_ERROR_NONE;
- const char *origin_path = "/opt/usr/media/test.jpg";
- char thumb_path[255];
-
- ret = thumbnail_request_from_db_async(origin_path, _thumb_cb, NULL);
-
- if (ret < 0)
- {
- printf( "thumbnail_request_from_db_async fails. error code->%d", ret);
- }
-
- return;
-}
-
- * @endcode
- */
int thumbnail_request_from_db_async(const char *origin_path, ThumbFunc func, void *user_data, uid_t uid);
-/**
- * thumbnail_request_save_to_file:
- * This function generates thumbnail of the original path and save it to the file system as jpeg format with the passed thumbnail path.
- * This function doesn't care about media DB.
- *
- * @return This function returns zero(MEDIA_THUMB_ERROR_NONE) on success, or negative value with error code.
- * Please refer 'media-thumb-error.h' to know the exact meaning of the error.
- * @param[in] origin_path The path of the original image
- * @param[in] thumb_type The type of the returned thumbnail data.
- * @param[in] thumb_path The path of generated thumbnail image.
- * @see None.
- * @pre None.
- * @post None.
- * @par example
- * @code
-
-#include <media-thumbnail.h>
-
-void save_thumbs()
-{
- int ret = MEDIA_THUMB_ERROR_NONE;
- const char *origin_path = "/opt/usr/media/test.jpg";
- const char *thumb_path = "/my_dir/thumb.jpg";
-
- ret = thumbnail_request_save_to_file(origin_path, thumb_path);
-
- if (ret < 0) {
- printf( "thumbnail_request_save_to_file fails. error code->%d", ret);
- }
-
- return;
-}
-
- * @endcode
- */
int thumbnail_request_save_to_file(const char *origin_path,
media_thumb_type thumb_type,
const char *thumb_path, uid_t uid);
-/**
- * thumbnail_request_extract_all_thumbs:
- * This function generates thumbnail of all media, which don't have thumbnail yet and save it to the file system as jpeg format.
- * Once thumbnail generated, the thumbnail path and original image's width and height will be updated to media database.
- *
- * @return This function returns zero(MEDIA_THUMB_ERROR_NONE) on success, or negative value with error code.
- * Please refer 'media-thumb-error.h' to know the exact meaning of the error.
- * @see None.
- * @pre None.
- * @post None.
- * @par example
- * @code
-
-#include <media-thumbnail.h>
-
-void extract_all_thumbs()
-{
- int ret = MEDIA_THUMB_ERROR_NONE;
-
- ret = thumbnail_request_extract_all_thumbs();
-
- if (ret < 0) {
- printf( "thumbnail_request_extract_all_thumbs fails. error code->%d", ret);
- }
-
- return;
-}
-
- * @endcode
- */
-
int thumbnail_request_extract_all_thumbs(uid_t uid);
int thumbnail_request_from_db_with_size(const char *origin_path, char *thumb_path, int max_length, int *origin_width, int *origin_height, uid_t uid);
@@ -221,12 +55,6 @@ int thumbnail_request_cancel_media(const char *origin_path, uid_t uid);
/* Cancel APIs that all requests to extract thumbnail of a process */
int thumbnail_request_cancel_all();
-/** @} */
-
-/**
- @}
- */
-
#ifdef __cplusplus
}
#endif