File VmbC.h

↰ Parent directory (include/VmbC)

Main header file for the VmbC API.

Definition (include/VmbC/VmbC.h)

• Program Listing for File VmbC.h

Detailed Description

This file describes all necessary definitions for using Allied Vision’s VmbC API. These type definitions are designed to be portable from other languages and other operating systems.

General conventions:

• Method names are composed in the following manner:

  • Vmb”Action” example: Function VmbStartup

  • Vmb”Entity””Action” or Vmb”ActionTarget””Action” example: Function VmbCameraOpen

  • Vmb”Entity””SubEntity/ActionTarget””Action” example: Function VmbFeatureCommandRun

• Strings (generally declared as “const char *”) are assumed to have a trailing 0 character

• All pointer parameters should of course be valid, except if stated otherwise.

• To ensure compatibility with older programs linked against a former version of the API, all struct* parameters have an accompanying sizeofstruct parameter.

• Functions returning lists are usually called twice: once with a zero buffer to get the length of the list, and then again with a buffer of the correct length.

Includes

• VmbC/VmbCTypeDefinitions.h (File VmbCTypeDefinitions.h)

• VmbC/VmbCommonTypes.h (File VmbCommonTypes.h)

• stddef.h

• stdint.h

Functions

• Function VmbCameraClose

• Function VmbCameraInfoQuery

• Function VmbCameraInfoQueryByHandle

• Function VmbCameraOpen

• Function VmbCamerasList

• Function VmbCaptureEnd

• Function VmbCaptureFrameQueue

• Function VmbCaptureFrameWait

• Function VmbCaptureQueueFlush

• Function VmbCaptureStart

• Function VmbChunkDataAccess

• Function VmbFeatureAccessQuery

• Function VmbFeatureBoolGet

• Function VmbFeatureBoolSet

• Function VmbFeatureCommandIsDone

• Function VmbFeatureCommandRun

• Function VmbFeatureEnumAsInt

• Function VmbFeatureEnumAsString

• Function VmbFeatureEnumEntryGet

• Function VmbFeatureEnumGet

• Function VmbFeatureEnumIsAvailable

• Function VmbFeatureEnumRangeQuery

• Function VmbFeatureEnumSet

• Function VmbFeatureFloatGet

• Function VmbFeatureFloatIncrementQuery

• Function VmbFeatureFloatRangeQuery

• Function VmbFeatureFloatSet

• Function VmbFeatureInfoQuery

• Function VmbFeatureIntGet

• Function VmbFeatureIntIncrementQuery

• Function VmbFeatureIntRangeQuery

• Function VmbFeatureIntSet

• Function VmbFeatureIntValidValueSetQuery

• Function VmbFeatureInvalidationRegister

• Function VmbFeatureInvalidationUnregister

• Function VmbFeatureListSelected

• Function VmbFeatureRawGet

• Function VmbFeatureRawLengthQuery

• Function VmbFeatureRawSet

• Function VmbFeaturesList

• Function VmbFeatureStringGet

• Function VmbFeatureStringMaxlengthQuery

• Function VmbFeatureStringSet

• Function VmbFrameAnnounce

• Function VmbFrameRevoke

• Function VmbFrameRevokeAll

• Function VmbInterfacesList

• Function VmbMemoryRead

• Function VmbMemoryWrite

• Function VmbPayloadSizeGet

• Function VmbSettingsLoad

• Function VmbSettingsSave

• Function VmbShutdown

• Function VmbStartup

• Function VmbTransportLayersList

• Function VmbVersionQuery

Defines

• Define VMB_API_HANDLE

• Define VMBINFINITE

Variables

• Variable gVmbHandle