Back to Aurora Vision Library website

You are here: Start » Function Reference » Hardware Support » XSight » XSight_GetEncoderCaptureCount

XSight_GetEncoderCaptureCount


Header: ThirdPartySdk.h
Namespace: avl
Module: ThirdParty

Gets encoder capture count.

Syntax

void avl::XSight_GetEncoderCaptureCount
(
	XSight_State& ioState,
	atl::Optional<int> inDeviceIndex,
	int inChannel,
	atl::int64& outCount
)

Parameters

Name Type Range Default Description
Input will be modified ioState XSight_State& Object used to maintain state of the function.
Input value inDeviceIndex Optional<int> 0 - NIL Device identifying number
Input value inChannel int 1 - 16 1 Encoder channel
Output value outCount int64&

Remarks

Device identification

inDeviceIndex can be used to pick one of multiple devices connected to the computer. inDeviceIndex can be set to:

  • Device Index - X-Sight I/O device identifying internal index.

I/O device driver software

This filter is intended to cooperate with a device using its vendor SDK. To be able to connect to a device, it is required to install X-Sight SDK.

Add DLL path to system environment variable is required.

Recommended Runtime version for Aurora Vision Studio usage is 1.0.0.

Invoking I/O port filters who force specifics behaviour (for example, set output level) may also change I/O mode to fitted.