img_encode_set

Synopsis:

#include <img/img.h>

int img_encode_set_value( img_codec_t codec,
                          uintptr_t *encode_data,
                          unsigned type,
                          uintptr_t value );

Since:

BlackBerry 10.3.0

Arguments:

codec

The codec to use. To figure out a codec to use, see img_codec_list(), img_codec_list_byext(), and img_codec_list_bymime().

encode_data

An address of a uintptr_t which the encoder uses to store data it needs across the encode process. Pass a valid address of a uintptr_t initialized to 0, not NULL.

type

The type of property to set the value for. You can set the value for the following types:

IMG_VALUE_TYPE_ANIM_FRAME_DELAY: The minimum time for which the current frame must be displayed.
IMG_VALUE_TYPE_ANIM_PLAY_COUNT: The number of times that the animation should be played; a value of 0 means that the animation should play forever.

value

The value to set for the property.

Library:

libimg

Use the -l img option to qcc to link against this library.

Description:

This function sets the value of an encoding property for animated images, such as animated GIFs.

Returns:

IMG_ERR_OK: Success.
IMG_ERR_NOTIMPL: The codec doesn't provide an implementation for this function.

Classification:

Image library

Safety:
Interrupt handler	No
Signal handler	No
Thread	No