efl.ethumb_client.EthumbClient
Class¶efl.ethumb_client.
EthumbClient
(func, *args, **kargs)¶Bases: object
New in version 1.17.
This client is the recommended way to generate thumbnails with Ethumb. All you have to do is create a client instance, wait it to be connected to server, configure thumbnail parameters and then start feed it with file_set(), exists() generate(). Basic steps are:
c.file_set(file)
if not c.exists(): c.generate(generated_cb)
It is recommended explicit call to disconnect()
function when
you don’t need the thumbnailer anymore.
Parameters: |
|
---|
Expected func signature:
func(client, status, *args, **kargs)
with status being True for successful connection or False on error.
Raises: |
|
---|
aspect
¶The aspect ratio policy.
If aspect is kept (ETHUMB_THUMB_KEEP_ASPECT), then image will
be rescaled so the largest dimension is not bigger than it’s
specified size (see size_get()
) and the other dimension is
resized in the same proportion. Example: size is 256x256,
image is 1000x500, resulting thumbnail is 256x128.
If aspect is ignored (ETHUMB_THUMB_IGNORE_ASPECT), then image will be distorted to match required thumbnail size. Example: size is 256x256, image is 1000x500, resulting thumbnail is 256x256.
If crop is required (ETHUMB_THUMB_CROP), then image will be
cropped so the smallest dimension is not bigger than its
specified size (see size_get()
) and the other dimension
will overflow, not being visible in the final image. How it
will overflow is speficied by crop_set()
alignment. Example: size is 256x256, image is 1000x500, crop
alignment is 0.5, 0.5, resulting thumbnail is 256x256 with 250
pixels from left and 250 pixels from right being lost, that is
just the 500x500 central pixels of image will be considered
for scaling.
Type: | Ethumb_Thumb_Aspect |
---|
category
¶Category directory to store thumbnails.
Category sub directory to store thumbnail. Default is either “normal”
or “large” for FDO compliant thumbnails or
WIDTHxHEIGHT-ASPECT[-FRAMED]-FORMAT
. It can be a string or None to
use auto generated names.
Type: | str |
---|
compress
¶The thumbnail compression rate.
Value from 0 to 9, default is 9. The effect depends on the format being used, JPEG will not use it.
Type: | int |
---|
crop_align
¶Crop alignment in use.
Parameters: |
|
---|---|
Type: | (float x, float y) |
dir_path
¶Configure where to store thumbnails in future requests.
This is the base folder, a category folder is added to this path
as a sub directory. Default is ~/.thumbnails
Type: | str |
---|
disconnect
()¶Explicitly request server disconnection.
After this call object becomes shallow, that is operations will be void.
document_page
¶The page number to thumbnail in paged documents.
Type: | int |
---|
fdo
¶Configure future requests to use FreeDesktop.Org preset.
This is a preset to provide freedesktop.org (fdo) standard compliant thumbnails. That is, files are stored as JPEG under ~/.thumbnails/SIZE, with size being either normal (128x128) or large (256x256).
Type: | Ethumb_Thumb_FDO_Size writeonly |
---|
file
¶The file to thumbnail.
This is a tuple of 2 strings: path
and key
.
For convenience you can also assign a single string value (path
),
ignoring the key.
Type: | str or (str, str) |
---|---|
Parameters: |
|
Raises: | RuntimeError – on failure setting the property |
Note
setting this property will reset other thumbnail specifications. This is done to avoid one using the last thumb path for new images.
file_free
()¶Zero/Reset file parameters.
This call will reset file and thumb specifications.
See also
file_set()
and thumb_set()
format
¶The fileformat for the thumbnails.
Thumbnails are compressed; possible formats are PNG, JPEG and EET.
Type: | Ethumb_Thumb_Format |
---|
frame
¶The optional edje file used to generate a frame around the thumbnail
This will create an edje object that will have image swallowed in. This can be used to simulate Polaroid or wood frames in the generated image. Remember it is bad to modify the original contents of thumbnails, but sometimes it’s useful to have it composited and avoid runtime overhead.
Type: | (str, str, str) writeonly |
---|---|
Parameters: |
|
Raises: | RuntimeError – on failure setting the property |
generate
(func, *args, **kargs)¶Ask EThumb server to generate the specified thumbnail.
Thumbnail generation is asynchronous and depend on ecore main loop running. Given function will be called back with generation status if True is returned by this call. If False is returned, given function will not be called.
Existing thumbnails will be overwritten with this call. Check
if they already exist with exists()
before calling.
Parameters: | func – function to call on generation completion, even if failed or succeeded. Signature is: func(self, id, file, key, thumb_path, thumb_key, status, *args, **kargs)
with status being True for successful generation or False on failure. |
---|---|
Returns: | request identifier. Request can be canceled calling
|
Raises: |
|
See also
cancel()
, clear()
, exists()
generate_cancel
(id)¶Cancel thumbnail request given its id.
Calling this function aborts thumbnail generation and func
given to generate()
will not be called!
Parameters: | id – identifier returned by generate() |
---|
generate_cancel_all
()¶Clear request queue, canceling all generation requests.
This will abort all existing requests, no func given to
generate()
will be called.
Same as calling cancel()
in all exising requests.
on_server_die_callback_set
(func, *args, **kargs)¶Function to call when server dies.
When server is dead there is nothing to do with this client anymore, just create a new one and start over, hope that server could be started and you could generate more thumbnails.
Parameters: | func – function to call when server dies. Signature: func(client, *args, **kargs)
|
---|---|
Raises: | TypeError – if func is not callable or None. |
orientation
¶The thumbnail rotation or flip.
Type: | Ethumb_Thumb_Orientation |
---|
quality
¶The thumbnail compression quality.
Value from 0 to 100, default is 80. The effect depends on the format being used, PNG will not use it.
Type: | int |
---|
size
¶The (custom) size of thumbnails.
Type: | (int w, int w) |
---|---|
Parameters: |
|
thumb_exists
(callback=None, *args, **kwargs)¶Checks if thumbnail already exists.
If you want to avoid regenerating thumbnails, check if they already exist with this function.
thumb_path
¶The complete path of the generated thumbnail.
This is a tuple of 2 strings: path
and key
.
For convenience you can also assign a single string value (path
),
ignoring the key.
Type: | str or (str, str) |
---|---|
Parameters: |
|
video_fps
¶The thumbnail framerate.
Default to 10.
Type: | int (readonly) |
---|
video_interval
¶The video frame interval, in seconds.
This is useful for animated thumbnail and will define skip time before going to the next frame.
Note
that video backends might not be able to precisely skip that amount as it will depend on various factors, including video encoding.
Type: | float (readonly) |
---|
video_ntimes
¶The number of times the video loops (if applicable).
Type: | int (readonly) |
---|
video_start
¶The start point for video thumbnails.
Type: | float (from 0.0 to 1.0) (readonly) |
---|
video_time
¶The video time (duration) in seconds.
Type: | float (readonly) |
---|