Sensoray 812 Windows - Manual (Page 6)

SDK Reference
Release Notes
V.1.0.0 (November 9, 2012):
 Initial release
A common API flow is described below. Please refer to the Functions Reference and Function
summary sections in the manual for more the details on the functions below.
General SDK Usage
1. Enumeration. If using multiple boards, they can be identified with the
S812_GetNumDevices. If using a single board, it may be opened without enumeration
using the index 0.
2. Initialization. This is performed by a call to S812_Open() function with the board index
parameter. Initial default capture settings are loaded.
3. A call to S812_Open() may be followed by calls to the functions controlling various
settings. At a minimum, the correct video system should be set:
 video system: S812_SetVidSys(), S812_SetVidSize();
 video parameters (brightness, contrast, saturation, hue): S812_SetLevel();
4. A call to S812_StartPreview() starts the 812 and previews the data to the monitor.
S812_StopStream() stops preview from the 812. The demo application also shows how to
capture the data for other purposes using the callback feature.
5. During preview or recording, snapshots or frames may be grabbed using the
S812_SnapshotToFile or S812_GetFrame functions. If frames need to be grabbed without
recording or previewing, the callback functionality (S812_StartCallback,
S812_RegisterCallback) may be used.
6. Audio preview may be started or stopped using S812_StartAudioPreview and
S812_StopAudioPreview.
7. Streams (callback, recording or preview) may be stopped with the S812_StopStream
function.
8. S812_Close() must be called before the application terminates to properly clean up and
close the board handle to the driver.
Demo applications
The SDK includes a demo application provided with the source code to illustrate the use of SDK’s
functions. Right click on the channel in question to preview, record, or view the raw data (callback) from
6