beautypg.com

Functions – Sensoray 817 User Manual

Page 11

background image

11

Functions

Overview

Most of the functions return

ECODE

type which is defined as

typedef int ECODE.

A non-zero value is returned in case of an error. A brief description of error codes could
be found in

s817.h

. It is highly recommended to check the return value of all functions

that return error codes and report the error codes when contacting technical support.

S817_OpenChannel

ECODE S817_OpenChannel (int board, int aChan, MODE *pMode)

Opens a channel on a selected board, initializes operating mode. Required before any
access to a channel. Capture buffers are allocated in the host’s memory as a result of
this call.


board

Index of the board being addressed (1 ..

SYS_MAXBOARDS

). See

s817.h

for constants

definitions.

aChan

Index of the input video channel being addressed (1 .. 16).

pMode

Pointer to

MODE

structure defining required operating mode.

S817_CloseChannel

ECODE S817_CloseChannel (int board, int aChan)

Closes a previously opened channel on a selected board. Required to properly release
the resources (capture buffers) allocated by

S817_OpenChannel

.


board

Index of the board being addressed (1 ..

SYS_MAXBOARDS

).

aChan

Index of the input video channel being addressed (1 .. 16).


S817_SetVideoMode

ECODE S817_SetVideoMode(int board, int aChan, VIDEO_MODE *pVMode)

Sets video mode for a selected channel on a selected board. Changes in video mode
affecting

tvFormat

and/or

jpgSize

may cause capture delays of 1-2 frames.

Other changes do not cause any capture delays.