API samples

Last modified by Lev Andronov on 2025/07/31 10:24

Before deciding which API to use, please read VP II API migration and take a look at Grabber features and parameters article.


Vision Point II

If you would like to use Vision Point legacy API samples with the Vision Point II API, link 'KYFGLibA' instead of 'KYFGLib'. More information is available in the knowledge base article Migration to VP II.

The new Vision Point II API has a modular structure:

  • KYVPLibTL — GenTL-inspired transport layer (API sample "KYVP_LibTL_Example"). Refer to the "KYVPTL library" section of the Vision Point II API Data Book.
  • KYVP ParametersHandler — a high-level library for handling GeniCam commands (API sample "KYVP_ParametersHandle_Example"). ParametersHandler is described in the same document under the section "KYVP ParametersHandler library".
  • KYVPLibExtension — a low-level extension library to enhance functionality of KYVPLibTL, e.g. firmware updates and hardware register access.

The comprehensive API sample 'KYVP_QueuedBuffers_Example' demonstrates the usage of both transport layer and and device parameters.

API samples locations

Windows
C:\Users\Public\Documents\KAYA Instruments\Vision Point II\API Samples
Linux
/opt/KAYA_Instruments/VisionPointII/Examples

Directory structure:

NameLangDescription
KYFGLib_Adapter_ExamplePlain CExample of using Adapter to run Vision Point legacy code under Vision Point II API with Queued Buffers approach.
KYFGLib_ExamplePlain CExample of using Adapter to run Vision Point legacy code under Vision Point II API with Cyclic Buffers approach.
KYFGLibA.NET.NETExample of using Adapter to run Vision Point legacy code under Vision Point II API with Cyclic Buffers approach.
KYFGLibA.NET_Example_QueuedBuffers.NETExample of using Adapter to run Vision Point legacy code under Vision Point II API with Queued Buffers approach.
KYVP_FirmwareUpdate_ExamplePlain CExample demonstrating KAYA PCIe device firmware update procedure.
KYVP_ParametersHandle_ExamplePlain CExample shows how to handle cameras parameters using KYVP ParametersHandler library.
KYVP_QueuedBuffers_ExamplePlain CExample for Queued Buffers image acquisition using KYVPLibTL and KYVP ParametersHandler library. Best API sample for acquitance with VP II API.
KYVPLibTL_ExamplePlain CExample demonstrating transport layer operations. Requires camera registers to be specified.
SerialPort_ExamplesPlain CExample of Serial Port API implementation. Refer to KYFGLibA_SerialPort_Example.cpp for full description.
IMPORTANT NOTE ABOUT .NET

We are using .NET version 4 because it is included in the standard Windows distribution. We build and test our .NET module with this version.
Since it is just a wrapper around KAYA C library, you can download the source code of the KAYA .NET module and rebuild it with changes that meet your requirements.


Vision Point

API samples locations

Windows
C:\Users\Public\Documents\KAYA Instruments\Vision Point\API Samples
Linux
/opt/KAYA_Instruments/Examples
NameLangSample nameDescription
Vision Point .NET API KYFGLib.NET.NET wrapper for the KAYA API library
Vision Point .NET API KYFGLib.NET_Example.NET image acquisition: open grabber, scan camera, camera parameters management, start stream; cyclic buffer type
Vision Point .NET API KYFGLib.NET_Example_QueuedBuffers.NET image acquisition: open grabber, scan camera, camera parameters management, start stream; queued buffer type
Vision Point API GenICam_fw_updatePlain C sample of GenICam firmware update for the Iron CoaXPress cameras
Vision Point API GenTL_ExamplePlain C sample of GenTL producer usage: open grabber, scan camera, camera parameters management, start stream; queued buffer type
Vision Point API Image_StitchingC++ image stitching: composing an image from chunks assigned to multiple cameras (configured to run in freerun mode with the same frame rate)
Vision Point API KAYA_SystemStartupPlain C sample for the system startup and perform various initializations of KAYA Instrument devices
Vision Point API KY_Chameleon_ExamplePlain C sample forChameleon operation flow: open grabber, scan camera, camera parameters management, start stream; queued buffer type
Vision Point API KYFGLib_ExamplePlain C sample for image acquisition: open grabber, scan camera, camera parameters management, start stream; cyclic buffer type
Vision Point API KYFGLib_Example_QueuedBuffersPlain C sample for image acquisition: open grabber, scan camera, camera parameters management, start stream; queued buffer type
Vision Point Python API KYFGLib_API_SamplePython image acquisition: open grabber, scan camera, camera parameters management, start stream; cyclic buffer type
Vision Point Python API KYFGLib_API_Sample_mutiple_camerasPython image acquisition: open grabber, scan camera, camera parameters management, start stream; cyclic buffer type for 2 cameras and more
Vision Point Python API KYFGLib_Chameleon_ExamplePython Chameleon operation flow: open grabber, scan camera, camera parameters management, start stream; queued buffer type
Vision Point Python API KYFGLib_Example_QueuedBuffersPython image acquisition: open grabber, scan camera, camera parameters management, start stream; queued buffer type for 1 camera
Vision Point Python API KYFGLib_Example_QueuedBuffers_mutiple_camerasPython image acquisition: open grabber, scan camera, camera parameters management, start stream; queued buffer type for 2 cameras and more

More API samples and test cases can be found in our GitHub repository.

KAYA Vision © 2025. All Rights Reserved.