VLDMPOOLREGISTER(3dm)VLDMPOOLREGISTER(3dm)NAME
vlDMPoolGetParams, vlDMPoolRegister, vlDMPoolDeregister - set up a
DMbufferpool for video transfer
SYNOPSIS
#include <dmedia/vl.h>
int vlDMPoolGetParams(VLServer svr, VLPath path, VLNode node, DMparams * plist);
int vlDMPoolRegister(VLServer svr, VLPath path, VLNode node, DMbufferpool pool);
int vlDMPoolDeregister(VLServer svr, VLPath path, VLNode node, DMbufferpool pool);
DESCRIPTION
vlDMPoolGetParams queries the video library for the parameters required
to create a DMbufferpool which can be used for video transfers on the
specified path and memory node. This routine should be called after
dmBufferSetPoolDefaults(3dm) and before dmBufferCreatePool(3dm).
vlDMPoolRegister associates the DMbufferpool with the given path and
node. This is only necessary for paths where video is the source and
memory is the drain. This call should be made before any transfer has
begun on the specified path.
vlDMPoolDeregister removes a registered DMbufferpool from the specified
node and path. A buffer must not be de-registered while a transfer using
it is in progress, as this will terminate the transfer and may have
undesirable side effects.
DIAGNOSTICS
All routines return 0 if successful, otherwise -1 is returned and vlErrno
is set to indicate the error.
CAVEATS
On platforms other than the O2, vlDMPoolGetParams returns -1 with vlErrno
set to VLAPIConflict. For those platforms, use vlDMGetParams(3dm)
instead. See vlintro(3dm) for a complete listing of compatible and
incompatible routines.
SEE ALSOdmBufferSetPoolDefaults(3dm), dmBufferCreatePool(3dm),
vlBeginTransfer(3dm), vlDMGetParams(3dm), vlintro(3dm)
Page 1
