Digital

NAME

XieSetStream − This routine sets the server transport parameters for stream mode transport of an image plane in a specified source image. 

C Format

XieSetStream(pho_id, plane, mode, cmpres, cmpprm, cmporg, pxlstr, scnstr)

C Argument Information

XiePhoto     pho_id;
unsigned char  plane;
unsigned char  mode;
unsigned char  cmpres;
unsigned long  cmpprm;
unsigned char  cmporg;
unsigned long  pxlstr;
unsigned long  scnstr;

RETURN VALUES

None. 

PARAMETERS

pho_idThe pho_id argument specifies the identifier of the source image for which you want to set transport parameters.  The source image can be an unbound photomap, a photoflo, a phototap, or a photomap bound to the photoflo. The photoflo is specified explicitly if the source image is a photoflo, or implicitly if the source image is phototap or a photomap bound to the photoflo. 

planeThe plane argument specifies the source image data plane with which you want to associate the transport parameters. 

modeThe mode argument specifies the transport direction. You can specify the symbol XieK_GetStream to set up transport from the server to the client, or XieK_PutStream to set up transport from the client to the server. 

cmpresThe cmpres argument specifies the compression scheme used for the data plane as it exists if you specify the XieK_PutStream symbol, or as desired if you specify the XieK_GetStream symbol. 

cmpprmThe cmpprm argument specifies a compression parameter required only if the transport direction is from the server to the client and the compression scheme is DCT. 

cmporgThe cmporg argument specifies the image data component organization as it exists if you specify the XieK_PutStream symbol, or as desired if you specify XieK_GetStream symbol. 

pxlstrThe pxlstr argument specifies the image data pixel stride as it exists if you specify the XieK_PutStream symbol, or as desired if you specify the XieK_GetStream symbol. 

scnstrThe scnstr argument specifies the image data scanline stride as it exists if you specify the XieK_PutStream symbol, or as desired if you specify the XieK_GetStream symbol. 

DESCRIPTION

This routine sets the server transport parameters for stream mode transport of an image plane in a specified source image.  If you are transporting multiple data planes, you must call this routine prior to calling either the XieGetStream or the XiePutStream routine. In addition, you must call this routine once for each data plane you want to transport. You can abort stream mode transport prior to completion using the XieAbortStream routine. 

You can specify the XieK_PutStream symbol for the mode argument only if you explicitly created the server photoflo, photomap, or phototap into which you will transport image data.  To explicitly create these destination images, use the XieClonePhoto, XieCreatePhoto, and XiePutImage routines. If you attempt to set transport context for other photomaps such as those resulting from a processing function, the routine returns a BadAccess error. 

If you specify a source image that is associated with a photoflo, you can use the XieSetStream routine only if the photoflo is not running. You must set transport context for phototaps prior to executing the associated photoflo if the image data is to be available. 

XIE Events and Error Messages

Protocol Messages: X_ieSetTransport

XIE event returned: None

XieLib errors: None

XieServer errors: BadAccess -- Photoflo is running

BadIDChoice -- Invalid identifier

BadMatch -- Compression scheme not compatible with the image, data plane and component organization not compatible

BadValue -- Invalid compression scheme