summaryrefslogtreecommitdiff
path: root/src/lib/ethumb
diff options
context:
space:
mode:
authorPhilippe Caseiro <pcaseiro@cadoles.com>2014-10-20 12:05:29 +0200
committerCedric BAIL <cedric@osg.samsung.com>2014-10-20 18:30:12 +0200
commitcf1db89a62b3e814e379187e2d8b4fd453efdf3d (patch)
treef8794fd1a3686d8517bc86402dba9f2087f95322 /src/lib/ethumb
parent513d9efc78cb47f9fe564602c446c53787f95950 (diff)
etumb: updating API documentation.
- ethumb_thumb_compress_set - ethumb_thumb_compress_get - ethumb_video_start_set - ethumb_video_start_get - ethumb_video_time_set - ethumb_video_time_get - ethumb_video_interval_set - ethumb_video_interval_get - ethumb_document_page_set - ethumb_document_page_get
Diffstat (limited to 'src/lib/ethumb')
-rw-r--r--src/lib/ethumb/Ethumb.h80
1 files changed, 79 insertions, 1 deletions
diff --git a/src/lib/ethumb/Ethumb.h b/src/lib/ethumb/Ethumb.h
index eaf1bc3dcd..65e2a66ce5 100644
--- a/src/lib/ethumb/Ethumb.h
+++ b/src/lib/ethumb/Ethumb.h
@@ -366,14 +366,80 @@ EAPI void ethumb_thumb_quality_set(Ethumb *e, int quality) EINA_ARG_NONN
366 */ 366 */
367EAPI int ethumb_thumb_quality_get(const Ethumb *e) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT EINA_PURE; 367EAPI int ethumb_thumb_quality_get(const Ethumb *e) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT EINA_PURE;
368 368
369/**
370 * @brief Set the compression rate
371 *
372 * @param e handle of the current thumbnailer.
373 * @param compress the compression rate (in percentage)
374 *
375 */
369EAPI void ethumb_thumb_compress_set(Ethumb *e, int compress) EINA_ARG_NONNULL(1); 376EAPI void ethumb_thumb_compress_set(Ethumb *e, int compress) EINA_ARG_NONNULL(1);
377
378/**
379 * @brief Get the compression rate
380 *
381 * @param e handle of the current thumbnailer.
382 *
383 * @return the compression rate (in percentage)
384 */
370EAPI int ethumb_thumb_compress_get(const Ethumb *e) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT EINA_PURE; 385EAPI int ethumb_thumb_compress_get(const Ethumb *e) EINA_ARG_NONNULL(1) EINA_WARN_UNUSED_RESULT EINA_PURE;
371 386
387/**
388 * @brief set the video play start point
389 *
390 * Set the start point of video thumbnail
391 *
392 * @param e handle of the current thumbnailer.
393 * @param start the start point (float from 0.0 to 1.0)
394 */
372EAPI void ethumb_video_start_set(Ethumb *e, float start) EINA_ARG_NONNULL(1); 395EAPI void ethumb_video_start_set(Ethumb *e, float start) EINA_ARG_NONNULL(1);
396
397/**
398 * @brief get the video play start point
399 *
400 * Get the start point of video thumbnail
401 *
402 * @param e handle of the current thumbnailer.
403 *
404 * @return the start point (float from 0.0 to 1.0)
405 */
373EAPI float ethumb_video_start_get(const Ethumb *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; 406EAPI float ethumb_video_start_get(const Ethumb *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE;
407
408/**
409 * @brief Set the video time (duration) in seconds.
410 *
411 * @param e handle of the current thumbnailer.
412 * @param time the video duration in seconds
413 */
374EAPI void ethumb_video_time_set(Ethumb *e, float time) EINA_ARG_NONNULL(1); 414EAPI void ethumb_video_time_set(Ethumb *e, float time) EINA_ARG_NONNULL(1);
415
416/**
417 * @brief Get the video time (duration) in seconds.
418 *
419 * @param e handle of the current thumbnailer.
420 * @return the video duration in seconds
421 */
375EAPI float ethumb_video_time_get(const Ethumb *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; 422EAPI float ethumb_video_time_get(const Ethumb *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE;
423
424/**
425 * @brief Set the video frame interval, in seconds
426 *
427 * This is useful for animated thumbnail and will define skip time
428 * before going to the next frame. Note that video backends might not
429 * be able to precisely skip that amount as it will depend on various
430 * factors, including video encoding.
431 *
432 * @param e handle of the current thumbnailer.
433 * @param interval the frame display interval in seconds
434 */
376EAPI void ethumb_video_interval_set(Ethumb *e, float interval) EINA_ARG_NONNULL(1); 435EAPI void ethumb_video_interval_set(Ethumb *e, float interval) EINA_ARG_NONNULL(1);
436
437/**
438 * @brief Get the video frame interval, in seconds
439 *
440 * @param e handle of the current thumbnailer.
441 * @return the frame display interval in seconds
442 */
377EAPI float ethumb_video_interval_get(const Ethumb *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; 443EAPI float ethumb_video_interval_get(const Ethumb *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE;
378 444
379/** 445/**
@@ -406,8 +472,20 @@ EAPI void ethumb_video_fps_set(Ethumb *e, unsigned int fps) EINA_ARG_NON
406 */ 472 */
407EAPI unsigned int ethumb_video_fps_get(const Ethumb *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; 473EAPI unsigned int ethumb_video_fps_get(const Ethumb *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE;
408 474
409 475/**
476 * @brief Set the page number to thumbnail in paged documents
477 *
478 * @param e handle of the current thumbnailer.
479 * @param page the page number.
480 */
410EAPI void ethumb_document_page_set(Ethumb *e, unsigned int page) EINA_ARG_NONNULL(1); 481EAPI void ethumb_document_page_set(Ethumb *e, unsigned int page) EINA_ARG_NONNULL(1);
482
483/**
484 * @brief Get the page number thumbnailed in paged documents
485 *
486 * @param e handle of the current thumbnailer.
487 * @return the page number.
488 */
411EAPI unsigned int ethumb_document_page_get(const Ethumb *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; 489EAPI unsigned int ethumb_document_page_get(const Ethumb *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE;
412/** 490/**
413 * @} 491 * @}