dmIC(3dm)dmIC(3dm)NAME
dmICReceive, - transfer output from the image converter
SYNOPSIS
#include <dmedia/dm_imageconvert.h>
DMstatus dmICReceive(DMimageconverter converter, DMbuffer *dstBuffer);
DESCRIPTION
dmICReceive receives the next available output buffer from the image
converter.
If it succeeds, dstBuffer will point to an output buffer that contains
the output bytes, allocated by the image converter. After dmICReceive
returns, the caller is automatically attached to the buffer (see
dmBuffer(3dm). When dstBuffer is no longer referenced, dmBufferFree must
be called to free up the buffer resource.
The contents of dstBuffer should not be modified.
After dmICReceive returns, dmICGetSrcParams, dmICGetDstParams, and
ICGetConvParams can be called to retrieve the parameters that were used
to perform the conversion. To determine whether a buffer contains an
INTRA, INTER or BETWEEN frame, use dmBufferGetImageType.
DIAGNOSTICS
If dmICReceive fails, and return DM_FAILURE, dstBuffer is invalid and the
caller is not automatically attached to any buffer.
dmICReceive can fail under 2 situations:
1. there was no buffer to receive (error code: DM_IC_Q_EMPTY)
2. an error occured during the conversion process.
Details of errors can be retrieved by calling dmGetError(3dm).
SEE ALSOdmBufferFree(3dm), dmICGetSrcParams(3dm), dmICGetDstParams(3dm),
dmICGetConvParams(3dm), dmBufferGetImageType(3dm), dmICSend(3dm),
dmICWork(3dm).
Page 1
