Sensoray 2246 - Manual (Page 44)

MID2246_SNAP_ERR_CRITSEC -5 Aquisition's critical section already locked, and user doesn't
want to wait for it. MID2246_SNAP_ERR_PARTBUF -6 Didn't recieve a full frame of data.
MID2246_API int SN_FreezeFrame (int bFreeze, int board = 0)
Freezes and Unfreezes the output frame.
Parameters:
bFreeze = 0 unfreezes the frame, bFreeze = 1 freezes the frame
board ID if multiple boards installed.
Returns:
0 on success
Function Documentation - Overlay functions
MID2246_API int SN_OverlayText (int xpos, int ypos, overlay_text_t * pOvlText, int
regionmask, int board)
Adds overlay text. If overlay text already exists at that x,y position, deletes windows before
adding. Overlay active on regions defined by regionmask.
If text contains embedded newline characters (\n = 10 dec), then each line of text will be
created on in a new window, at index sub-window position, directly below the preceding line.
Each sub-window position only consumes enough overlay memory needed to hold the
individual line.
If text contains embedded character 30 dec (entered programmatically or by holding down
Alt- and typing "030" on the numeric keypad), then each line following a char(30) will be on
a new line. Multi-line text created this way will be created as one large graphic at one
AtIndex location.
Parameters:
xpos -- start X position
ypos -- start y position
pOvlText -- pointer to overlay text
regionmask -- region mask (MID2246_REGION_MONITOR, MID2246_REGION_MPEG,
MID2246_REGION_STILL)
board ID if multiple boards installed.
Returns:
0 on success, -1 on too many regions, other negative value failure
MID2246_API int SN_OverlayTextIdx (int AtIndex, int xpos, int ypos, overlay_text_t *
pOvlText, int regionmask, int board)
Adds/Update overlay text. If overlay already exists at index WinIndex, deletes window
before adding. Overlay active on regions defined by regionmask. Multi-lines created as
defined in SN_OverlayText().
Parameters:
AtIndex -- sub-window position to update/add text
xpos -- new X position
ypos -- new y position
pOvlText -- pointer to overlay text
44