img_encode_begin()

Prepare to encode a frame to a stream

Synopsis:

#include <img/img.h>

int img_encode_begin( img_codec_t codec,
                      io_stream_t *output,
                      uintptr_t *encode_data );

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().
output
The output destination.
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.

Library:

libimg

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

Description:

This function prepares to encode a frame (or series of frames) to a stream.

Returns:

IMG_ERR_OK
Success.
IMG_ERR_NOTIMPL
The codec doesn't support encoding.
Other
Any other code that a encoder's encode_begin() function may pass back to flag an error (see img_errno.h for a list of defined errors).

Classification:

Image library

Safety:
Interrupt handler No
Signal handler No
Thread No