Camera (JavaCPP Presets for FlyCapture 2.13.3.31-1.5.5 API)

java.lang.Object
- org.bytedeco.javacpp.Pointer
- - org.bytedeco.flycapture.FlyCapture2.CameraBase
  - - org.bytedeco.flycapture.FlyCapture2.Camera

All Implemented Interfaces:

AutoCloseable
```
@Namespace(value="FlyCapture2")
 @Properties(inherit=FlyCapture2.class)
public class Camera
extends CameraBase
```
The Camera object represents a physical camera that uses the IIDC register set. The object must first be connected to using Connect() before any other operations can proceed. It is possible for more than 1 Camera object to connect to a single physical camera. However, isochronous transmission to more than 1 Camera object is not supported. \nosubgrouping

Nested Class Summary
- Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer
  Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary
- Fields inherited from class org.bytedeco.javacpp.Pointer
  address, capacity, limit, position

Constructor Summary

Constructors
Constructor and Description

Camera()
Default constructor.

Camera(long size)
Native array allocator.

Camera(Pointer p)
Pointer cast constructor.

Constructors
Constructor and Description
`Camera()` Default constructor.
`Camera(long size)` Native array allocator.
`Camera(Pointer p)` Pointer cast constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Error`	`Connect()`
`Error`	`Connect(PGRGuid pGuid)` The following functions are inherited from CameraBase.
`Error`	`DeregisterAllEvents()`
`Error`	`DeregisterEvent(EventOptions pOpts)`
`Error`	`Disconnect()` Disconnects the camera object from the camera.
`Error`	`EnableLUT(boolean on)` Enable or disable LUT functionality on the camera.
`Error`	`FireSoftwareTrigger()`
`Error`	`FireSoftwareTrigger(boolean broadcast)` Fire the software trigger according to the DCAM specifications.
`Error`	`GetActiveLUTBank(int[] pActiveBank)`
`Error`	`GetActiveLUTBank(IntBuffer pActiveBank)`
`Error`	`GetActiveLUTBank(IntPointer pActiveBank)` Get the LUT bank that is currently being used.
`Error`	`GetCameraInfo(CameraInfo pCameraInfo)` Retrieves information from the camera such as serial number, model name and other camera information.
`Error`	`GetConfiguration(FC2Config pConfig)` Get the configuration associated with the camera object.
`Error`	`GetCycleTime(TimeStamp timeStamp)` Returns a Timestamp struct containing 1394 CYCLE_TIME information
`Error`	`GetEmbeddedImageInfo(EmbeddedImageInfo pInfo)` Get the current status of the embedded image information register, as well as the availability of each embedded property.
`Error`	`GetFormat7Configuration(Format7ImageSettings pImageSettings, int[] pPacketSize, float[] pPercentage)`
`Error`	`GetFormat7Configuration(Format7ImageSettings pImageSettings, IntBuffer pPacketSize, FloatBuffer pPercentage)`
`Error`	`GetFormat7Configuration(Format7ImageSettings pImageSettings, IntPointer pPacketSize, FloatPointer pPercentage)` Get the current Format7 configuration from the camera.
`Error`	`GetFormat7Info(Format7Info pInfo, boolean[] pSupported)`
`Error`	`GetFormat7Info(Format7Info pInfo, BoolPointer pSupported)` Retrieve the availability of Format7 custom image mode and the camera capabilities for the specified Format7 mode.
`Error`	`GetGPIOPinDirection(int pin, int[] pDirection)`
`Error`	`GetGPIOPinDirection(int pin, IntBuffer pDirection)`
`Error`	`GetGPIOPinDirection(int pin, IntPointer pDirection)` Get the GPIO pin direction for the specified pin.
`Error`	`GetLUTBankInfo(int bank, boolean[] pReadSupported, boolean[] pWriteSupported)`
`Error`	`GetLUTBankInfo(int bank, BoolPointer pReadSupported, BoolPointer pWriteSupported)` Query the read/write status of a single LUT bank.
`Error`	`GetLUTChannel(int bank, int channel, int sizeEntries, int[] pEntries)`
`Error`	`GetLUTChannel(int bank, int channel, int sizeEntries, IntBuffer pEntries)`
`Error`	`GetLUTChannel(int bank, int channel, int sizeEntries, IntPointer pEntries)` Get the LUT channel settings from the camera.
`Error`	`GetLUTInfo(LUTData pData)` Query if LUT support is available on the camera.
`Error`	`GetMemoryChannel(int[] pCurrentChannel)`
`Error`	`GetMemoryChannel(IntBuffer pCurrentChannel)`
`Error`	`GetMemoryChannel(IntPointer pCurrentChannel)` Retrieve the current memory channel from the camera.
`Error`	`GetMemoryChannelInfo(int[] pNumChannels)`
`Error`	`GetMemoryChannelInfo(IntBuffer pNumChannels)`
`Error`	`GetMemoryChannelInfo(IntPointer pNumChannels)` Query the camera for memory channel support.
`Camera`	`getPointer(long i)`
`Error`	`GetProperty(Property pProp)` Reads the settings for the specified property from the camera.
`Error`	`GetPropertyInfo(PropertyInfo pPropInfo)` Retrieves information about the specified camera property.
`static BytePointer`	`GetRegisterString(int registerVal)`
`Error`	`GetStats(CameraStats pStats)`
`Error`	`GetStrobe(StrobeControl pStrobeControl)` Retrieve current strobe settings from the camera.
`Error`	`GetStrobeInfo(StrobeInfo pStrobeInfo)` Retrieve strobe information from the camera.
`Error`	`GetTriggerDelay(Property pTriggerDelay)` Retrieve current trigger delay settings from the camera.
`Error`	`GetTriggerDelayInfo(PropertyInfo pTriggerDelayInfo)` Retrieve trigger delay information from the camera.
`Error`	`GetTriggerMode(TriggerMode pTriggerMode)` Retrieve current trigger settings from the camera.
`Error`	`GetTriggerModeInfo(TriggerModeInfo pTriggerModeInfo)` Retrieve trigger information from the camera.
`Error`	`GetVideoModeAndFrameRate(int[] pVideoMode, int[] pFrameRate)`
`Error`	`GetVideoModeAndFrameRate(IntBuffer pVideoMode, IntBuffer pFrameRate)`
`Error`	`GetVideoModeAndFrameRate(IntPointer pVideoMode, IntPointer pFrameRate)` Get the current video mode and frame rate from the camera.
`Error`	`GetVideoModeAndFrameRateInfo(int videoMode, int frameRate, boolean[] pSupported)`
`Error`	`GetVideoModeAndFrameRateInfo(int videoMode, int frameRate, BoolPointer pSupported)` Query the camera to determine if the specified video mode and frame rate is supported.
`boolean`	`IsConnected()` Checks if the camera object is connected to a physical camera specified by a GUID.
`Camera`	`position(long position)`
`Error`	`ReadRegister(int _address, int[] pValue)`
`Error`	`ReadRegister(int _address, IntBuffer pValue)`
`Error`	`ReadRegister(int _address, IntPointer pValue)` Read the specified register from the camera.
`Error`	`ReadRegisterBlock(short addressHigh, int addressLow, int[] pBuffer, int length)`
`Error`	`ReadRegisterBlock(short addressHigh, int addressLow, IntBuffer pBuffer, int length)`
`Error`	`ReadRegisterBlock(short addressHigh, int addressLow, IntPointer pBuffer, int length)` Read from the specified register block on the camera.
`Error`	`RegisterAllEvents(EventOptions pOpts)`
`Error`	`RegisterEvent(EventOptions pOpts)`
`Error`	`ResetStats()`
`Error`	`RestoreFromMemoryChannel(int channel)` Restore the specfied current memory channel.
`Error`	`RetrieveBuffer(Image pImage)` Retrieves the the next image object containing the next image.
`Error`	`SaveToMemoryChannel(int channel)` Save the current settings to the specfied current memory channel.
`Error`	`SetActiveLUTBank(int activeBank)` Set the LUT bank that will be used.
`Error`	`SetCallback(ImageEventCallback callbackFn)`
`Error`	`SetCallback(ImageEventCallback callbackFn, Pointer pCallbackData)` Sets the callback data to be used on completion of image transfer.
`Error`	`SetConfiguration(FC2Config pConfig)` Set the configuration associated with the camera object.
`Error`	`SetEmbeddedImageInfo(EmbeddedImageInfo pInfo)` Sets the on/off values of the embedded image information structure to the camera.
`Error`	`SetFormat7Configuration(Format7ImageSettings pImageSettings, float percentSpeed)` Set the current Format7 configuration to the camera.
`Error`	`SetFormat7Configuration(Format7ImageSettings pImageSettings, int packetSize)` Set the current Format7 configuration to the camera.
`Error`	`SetGPIOPinDirection(int pin, int direction)`
`Error`	`SetGPIOPinDirection(int pin, int direction, boolean broadcast)` Set the GPIO pin direction for the specified pin.
`Error`	`SetLUTChannel(int bank, int channel, int sizeEntries, int[] pEntries)`
`Error`	`SetLUTChannel(int bank, int channel, int sizeEntries, IntBuffer pEntries)`
`Error`	`SetLUTChannel(int bank, int channel, int sizeEntries, IntPointer pEntries)` Set the LUT channel settings to the camera.
`Error`	`SetProperty(Property pProp)`
`Error`	`SetProperty(Property pProp, boolean broadcast)` Writes the settings for the specified property to the camera.
`Error`	`SetStrobe(StrobeControl pStrobeControl)`
`Error`	`SetStrobe(StrobeControl pStrobeControl, boolean broadcast)` Set current strobe settings to the camera.
`Error`	`SetTriggerDelay(Property pTriggerDelay)`
`Error`	`SetTriggerDelay(Property pTriggerDelay, boolean broadcast)` Set the specified trigger delay settings to the camera.
`Error`	`SetTriggerMode(TriggerMode pTriggerMode)`
`Error`	`SetTriggerMode(TriggerMode pTriggerMode, boolean broadcast)` Set the specified trigger settings to the camera.
`Error`	`SetUserBuffers(byte[] pMemBuffers, int size, int numBuffers)`
`Error`	`SetUserBuffers(ByteBuffer pMemBuffers, int size, int numBuffers)`
`Error`	`SetUserBuffers(BytePointer pMemBuffers, int size, int numBuffers)` Specify user allocated buffers to use as image data buffers.
`Error`	`SetVideoModeAndFrameRate(int videoMode, int frameRate)` Set the specified video mode and frame rate to the camera.
`Error`	`StartCapture()`
`Error`	`StartCapture(ImageEventCallback callbackFn, Pointer pCallbackData)` Starts isochronous image capture.
`static Error`	`StartSyncCapture(int numCameras, Camera ppCameras)`
`static Error`	`StartSyncCapture(int numCameras, Camera ppCameras, ImageEventCallback pCallbackFns, Pointer pCallbackDataArray)`
`static Error`	`StartSyncCapture(int numCameras, PointerPointer ppCameras, ImageEventCallback pCallbackFns, PointerPointer pCallbackDataArray)`
`Error`	`StopCapture()` Stops isochronous image transfer and cleans up all associated resources.
`Error`	`ValidateFormat7Settings(Format7ImageSettings pImageSettings, boolean[] pSettingsAreValid, Format7PacketInfo pPacketInfo)`
`Error`	`ValidateFormat7Settings(Format7ImageSettings pImageSettings, BoolPointer pSettingsAreValid, Format7PacketInfo pPacketInfo)` Validates Format7ImageSettings structure and returns valid packet size information if the image settings are valid.
`Error`	`WaitForBufferEvent(Image pImage, int eventNumber)` Retrieves the next image event containing the next part of the image.
`Error`	`WriteRegister(int _address, int value)`
`Error`	`WriteRegister(int _address, int value, boolean broadcast)` Write to the specified register on the camera.
`Error`	`WriteRegisterBlock(short addressHigh, int addressLow, int[] pBuffer, int length)`
`Error`	`WriteRegisterBlock(short addressHigh, int addressLow, IntBuffer pBuffer, int length)`
`Error`	`WriteRegisterBlock(short addressHigh, int addressLow, IntPointer pBuffer, int length)` Write to the specified register block on the camera.

Methods inherited from class org.bytedeco.javacpp.Pointer
address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, offsetof, parseBytes, physicalBytes, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail
- Camera
```
public Camera(Pointer p)
```
  Pointer cast constructor. Invokes Pointer(Pointer).
- Camera
```
public Camera(long size)
```
  Native array allocator. Access with Pointer.position(long).
- Camera
```
public Camera()
```
  Default constructor.

Method Detail

position

public Camera position(long position)

Overrides:: position in class Pointer

getPointer
```
public Camera getPointer(long i)
```
Overrides:

getPointer in class Pointer

GetVideoModeAndFrameRateInfo

@ByVal
public Error GetVideoModeAndFrameRateInfo(@Cast(value="FlyCapture2::VideoMode")
                                                 int videoMode,
                                                 @Cast(value="FlyCapture2::FrameRate")
                                                 int frameRate,
                                                 @Cast(value="bool*")
                                                 BoolPointer pSupported)

Query the camera to determine if the specified video mode and frame rate is supported.

Parameters:: videoMode - Video mode to check.; frameRate - Frame rate to check.; pSupported - Whether the video mode and frame rate is supported.
Returns:: An Error indicating the success or failure of the function.
See Also:: GetVideoModeAndFrameRate(), SetVideoModeAndFrameRate()

GetVideoModeAndFrameRateInfo

@ByVal
public Error GetVideoModeAndFrameRateInfo(@Cast(value="FlyCapture2::VideoMode")
                                                 int videoMode,
                                                 @Cast(value="FlyCapture2::FrameRate")
                                                 int frameRate,
                                                 @Cast(value="bool*")
                                                 boolean[] pSupported)

GetVideoModeAndFrameRate

@ByVal
public Error GetVideoModeAndFrameRate(@Cast(value="FlyCapture2::VideoMode*")
                                             IntPointer pVideoMode,
                                             @Cast(value="FlyCapture2::FrameRate*")
                                             IntPointer pFrameRate)

Get the current video mode and frame rate from the camera. If the camera is in Format7, the video mode will be VIDEOMODE_FORMAT7 and the frame rate will be FRAMERATE_FORMAT7.

Parameters:: pVideoMode - Current video mode.; pFrameRate - Current frame rate.
Returns:: An Error indicating the success or failure of the function.
See Also:: GetVideoModeAndFrameRateInfo(), SetVideoModeAndFrameRate()

GetVideoModeAndFrameRate

@ByVal
public Error GetVideoModeAndFrameRate(@Cast(value="FlyCapture2::VideoMode*")
                                             IntBuffer pVideoMode,
                                             @Cast(value="FlyCapture2::FrameRate*")
                                             IntBuffer pFrameRate)

GetVideoModeAndFrameRate

@ByVal
public Error GetVideoModeAndFrameRate(@Cast(value="FlyCapture2::VideoMode*")
                                             int[] pVideoMode,
                                             @Cast(value="FlyCapture2::FrameRate*")
                                             int[] pFrameRate)

SetVideoModeAndFrameRate
```
@ByVal
public Error SetVideoModeAndFrameRate(@Cast(value="FlyCapture2::VideoMode")
                                             int videoMode,
                                             @Cast(value="FlyCapture2::FrameRate")
                                             int frameRate)
```
Set the specified video mode and frame rate to the camera. It is not possible to set the camera to VIDEOMODE_FORMAT7 or FRAMERATE_FORMAT7. Use the Format7 functions to set the camera into Format7.

Parameters:

videoMode - Video mode to set to camera.

frameRate - Frame rate to set to camera.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetVideoModeAndFrameRateInfo(), GetVideoModeAndFrameRate()

GetFormat7Info
```
@ByVal
public Error GetFormat7Info(Format7Info pInfo,
                                   @Cast(value="bool*")
                                   BoolPointer pSupported)
```
Retrieve the availability of Format7 custom image mode and the camera capabilities for the specified Format7 mode. The mode must be specified in the Format7Info structure in order for the function to succeed.

Parameters:

pInfo - Structure to be filled with the capabilities of the specified mode and the current state in the specified mode.

pSupported - Whether the specified mode is supported.

Returns:

An Error indicating the success or failure of the function.

See Also:

ValidateFormat7Settings(), GetFormat7Configuration(), SetFormat7Configuration()

GetFormat7Info

@ByVal
public Error GetFormat7Info(Format7Info pInfo,
                                   @Cast(value="bool*")
                                   boolean[] pSupported)

ValidateFormat7Settings
```
@ByVal
public Error ValidateFormat7Settings(@Const
                                            Format7ImageSettings pImageSettings,
                                            @Cast(value="bool*")
                                            BoolPointer pSettingsAreValid,
                                            Format7PacketInfo pPacketInfo)
```
Validates Format7ImageSettings structure and returns valid packet size information if the image settings are valid. The current image settings are cached while validation is taking place. The cached settings are restored when validation is complete.

Parameters:

pImageSettings - Structure containing the image settings.

pSettingsAreValid - Whether the settings are valid.

pPacketInfo - Packet size information that can be used to determine a valid packet size.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetFormat7Info(), GetFormat7Configuration(), SetFormat7Configuration()

ValidateFormat7Settings

@ByVal
public Error ValidateFormat7Settings(@Const
                                            Format7ImageSettings pImageSettings,
                                            @Cast(value="bool*")
                                            boolean[] pSettingsAreValid,
                                            Format7PacketInfo pPacketInfo)

GetFormat7Configuration
```
@ByVal
public Error GetFormat7Configuration(Format7ImageSettings pImageSettings,
                                            @Cast(value="unsigned int*")
                                            IntPointer pPacketSize,
                                            FloatPointer pPercentage)
```
Get the current Format7 configuration from the camera. This call will only succeed if the camera is already in Format7.

Parameters:

pImageSettings - Current image settings.

pPacketSize - Current packet size.

pPercentage - Current packet size as a percentage.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetFormat7Info(), ValidateFormat7Settings(), SetFormat7Configuration(), GetVideoModeAndFrameRate()

GetFormat7Configuration

@ByVal
public Error GetFormat7Configuration(Format7ImageSettings pImageSettings,
                                            @Cast(value="unsigned int*")
                                            IntBuffer pPacketSize,
                                            FloatBuffer pPercentage)

GetFormat7Configuration

@ByVal
public Error GetFormat7Configuration(Format7ImageSettings pImageSettings,
                                            @Cast(value="unsigned int*")
                                            int[] pPacketSize,
                                            float[] pPercentage)

SetFormat7Configuration

@ByVal
public Error SetFormat7Configuration(@Const
                                            Format7ImageSettings pImageSettings,
                                            @Cast(value="unsigned int")
                                            int packetSize)

Set the current Format7 configuration to the camera.

Parameters:: pImageSettings - Image settings to be written to the camera.; packetSize - Packet size to be written to the camera.
Returns:: An Error indicating the success or failure of the function.
See Also:: GetFormat7Info(), ValidateFormat7Settings(), GetFormat7Configuration()

SetFormat7Configuration
```
@ByVal
public Error SetFormat7Configuration(@Const
                                            Format7ImageSettings pImageSettings,
                                            float percentSpeed)
```
Set the current Format7 configuration to the camera.

Parameters:

pImageSettings - Image settings to be written to the camera.

percentSpeed - Percentage of packet size to be written to the camera.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetFormat7Info(), ValidateFormat7Settings(), GetFormat7Configuration()

Connect
```
@ByVal
public Error Connect(PGRGuid pGuid)
```
The following functions are inherited from CameraBase. See CameraBase.h for further information.

Overrides:

Connect in class CameraBase

Parameters:

pGuid - The unique identifier for a specific camera on the PC.

Returns:

An Error indicating the success or failure of the function.

See Also:

BusManager::GetCameraFromIndex(), BusManager::GetCameraFromSerialNumber()

Connect
```
@ByVal
public Error Connect()
```
Overrides:

Connect in class CameraBase

Disconnect
```
@ByVal
public Error Disconnect()
```
Description copied from class: CameraBase

Disconnects the camera object from the camera. This allows another physical camera specified by a GUID to be connected to the camera object.

Overrides:

Disconnect in class CameraBase

Returns:

An Error indicating the success or failure of the function.

See Also:

CameraBase.Connect()

IsConnected
```
@Cast(value="bool")
public boolean IsConnected()
```
Description copied from class: CameraBase

Checks if the camera object is connected to a physical camera specified by a GUID.

Overrides:

IsConnected in class CameraBase

Returns:

Whether Connect() was called on the camera object.

See Also:

CameraBase.Connect(), CameraBase.Disconnect()

SetCallback
```
@ByVal
public Error SetCallback(ImageEventCallback callbackFn,
                                @Const
                                Pointer pCallbackData)
```
Description copied from class: CameraBase

Sets the callback data to be used on completion of image transfer. To clear the current stored callback data, pass in NULL for both arguments.

Overrides:

SetCallback in class CameraBase

Parameters:

callbackFn - A function to be called when a new image is received.

pCallbackData - A pointer to data that can be passed to the callback function.

Returns:

An Error indicating the success or failure of the function.

See Also:

CameraBase.StartCapture()

SetCallback

@ByVal
public Error SetCallback(ImageEventCallback callbackFn)

Overrides:: SetCallback in class CameraBase

StartCapture
```
@ByVal
public Error StartCapture(ImageEventCallback callbackFn,
                                 @Const
                                 Pointer pCallbackData)
```
Description copied from class: CameraBase

Starts isochronous image capture. It will use either the current video mode or the most recently set video mode of the camera. The optional callback function parameter is called on completion of image transfer. When a callback function is specified, the grab mode will determine how images are delivered. If the grab mode has not been set, or has been set to DROP_FRAMES the default behavior is to requeue images for DMA if they have not been delivered by the time the next image transfer completes. If BUFFER_FRAMES is specified, the next image in the sequence will be delivered. Note that for the BUFFER_FRAMES case, if delivery does not keep up with the DMA process, images will be lost. The default behavior is to perform DROP_FRAMES image delivery Alternatively, the callback parameter can be set to NULL and RetrieveBuffer() can be called as a blocking call to get the image data.

Overrides:

StartCapture in class CameraBase

Parameters:

callbackFn - A function to be called when a new image is received.

pCallbackData - A pointer to data that can be passed to the callback function.

Returns:

An Error indicating the success or failure of the function.

See Also:

RetrieveBuffer(), StartSyncCapture(), CameraBase.StopCapture()

StartCapture
```
@ByVal
public Error StartCapture()
```
Overrides:

StartCapture in class CameraBase

StartSyncCapture

@ByVal
public static Error StartSyncCapture(@Cast(value="unsigned int")
                                            int numCameras,
                                            @Cast(value="const FlyCapture2::Camera**")
                                            PointerPointer ppCameras,
                                            @Cast(value="FlyCapture2::ImageEventCallback*") @ByPtrPtr
                                            ImageEventCallback pCallbackFns,
                                            @Cast(value="const void**")
                                            PointerPointer pCallbackDataArray)

StartSyncCapture

@ByVal
public static Error StartSyncCapture(@Cast(value="unsigned int")
                                            int numCameras,
                                            @Const @ByPtrPtr
                                            Camera ppCameras)

StartSyncCapture

@ByVal
public static Error StartSyncCapture(@Cast(value="unsigned int")
                                            int numCameras,
                                            @Const @ByPtrPtr
                                            Camera ppCameras,
                                            @Cast(value="FlyCapture2::ImageEventCallback*") @ByPtrPtr
                                            ImageEventCallback pCallbackFns,
                                            @Cast(value="const void**") @ByPtrPtr
                                            Pointer pCallbackDataArray)

RetrieveBuffer
```
@ByVal
public Error RetrieveBuffer(Image pImage)
```
Description copied from class: CameraBase

Retrieves the the next image object containing the next image. If the grab mode has not been set, or has been set to DROP_FRAMES the default behavior is to requeue images for DMA if they have not been retrieved by the time the next image transfer completes. If BUFFER_FRAMES is specified, the next image in the sequence will be retrieved. Note that for the BUFFER_FRAMES case, if retrieval does not keep up with the DMA process, images will be lost. The default behavior is to perform DROP_FRAMES image retrieval.

Overrides:

RetrieveBuffer in class CameraBase

Parameters:

pImage - Pointer to Image object to store image data.

Returns:

An Error indicating the success or failure of the function.

See Also:

CameraBase.StartCapture(), CameraBase.StopCapture()

StopCapture
```
@ByVal
public Error StopCapture()
```
Description copied from class: CameraBase

Stops isochronous image transfer and cleans up all associated resources. If an image callback function (specified in the StartCapture() call) is currently executing, StopCapture() will not return until after the callback has completed.

Overrides:

StopCapture in class CameraBase

Returns:

An Error indicating the success or failure of the function.

See Also:

CameraBase.StartCapture(), RetrieveBuffer()

WaitForBufferEvent
```
@ByVal
public Error WaitForBufferEvent(Image pImage,
                                       @Cast(value="unsigned int")
                                       int eventNumber)
```
Description copied from class: CameraBase

Retrieves the next image event containing the next part of the image.

Overrides:

WaitForBufferEvent in class CameraBase

Parameters:

pImage - Pointer to Image object to store image data.

eventNumber - The event number to wait for.

Returns:

An Error indicating the success or failure of the function.

See Also:

CameraBase.StartCapture(), RetrieveBuffer(), CameraBase.StopCapture()

SetUserBuffers
```
@ByVal
public Error SetUserBuffers(@Cast(value="unsigned char*const")
                                   BytePointer pMemBuffers,
                                   int size,
                                   int numBuffers)
```
Description copied from class: CameraBase

Specify user allocated buffers to use as image data buffers. To prevent image tearing, the size of each buffer should be equal to ((unsigned int)(bufferSize + packetSize - 1)/packetSize) * packetSize. The total size should be (size * numBuffers) or larger. The packet Size that should be used differs between interfaces: Firewire: Use the Format7 packet size. Usb2: First round to Format7 packet size then round to 512 bytes. Usb3: Use a packet size of 1024 bytes. GigE: No need to do any rounding on GigE

Overrides:

SetUserBuffers in class CameraBase

Parameters:

pMemBuffers - Pointer to memory buffers to be written to.

size - The size of each buffer (in bytes).

numBuffers - Number of buffers in the array.

Returns:

An Error indicating the success or failure of the function.

See Also:

CameraBase.StartCapture(), RetrieveBuffer(), CameraBase.StopCapture()

SetUserBuffers

@ByVal
public Error SetUserBuffers(@Cast(value="unsigned char*const")
                                   ByteBuffer pMemBuffers,
                                   int size,
                                   int numBuffers)

Overrides:: SetUserBuffers in class CameraBase

SetUserBuffers

@ByVal
public Error SetUserBuffers(@Cast(value="unsigned char*const")
                                   byte[] pMemBuffers,
                                   int size,
                                   int numBuffers)

Overrides:: SetUserBuffers in class CameraBase

GetConfiguration
```
@ByVal
public Error GetConfiguration(FC2Config pConfig)
```
Description copied from class: CameraBase

Get the configuration associated with the camera object.

Overrides:

GetConfiguration in class CameraBase

Parameters:

pConfig - Pointer to the configuration structure to be filled.

Returns:

An Error indicating the success or failure of the function.

See Also:

SetConfiguration()

SetConfiguration
```
@ByVal
public Error SetConfiguration(@Const
                                     FC2Config pConfig)
```
Description copied from class: CameraBase

Set the configuration associated with the camera object.

Overrides:

SetConfiguration in class CameraBase

Parameters:

pConfig - Pointer to the configuration structure to be used.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetConfiguration()

GetCameraInfo
```
@ByVal
public Error GetCameraInfo(CameraInfo pCameraInfo)
```
Description copied from class: CameraBase

Retrieves information from the camera such as serial number, model name and other camera information.

Overrides:

GetCameraInfo in class CameraBase

Parameters:

pCameraInfo - Pointer to the camera information structure to be filled.

Returns:

An Error indicating the success or failure of the function.

GetPropertyInfo
```
@ByVal
public Error GetPropertyInfo(PropertyInfo pPropInfo)
```
Description copied from class: CameraBase

Retrieves information about the specified camera property. The property type must be specified in the PropertyInfo structure passed into the function in order for the function to succeed.

Overrides:

GetPropertyInfo in class CameraBase

Parameters:

pPropInfo - Pointer to the PropertyInfo structure to be filled.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetProperty(), SetProperty()

GetProperty
```
@ByVal
public Error GetProperty(Property pProp)
```
Description copied from class: CameraBase

Reads the settings for the specified property from the camera. The property type must be specified in the Property structure passed into the function in order for the function to succeed. If auto is on, the integer and abs values returned may not be consistent with each other.

Overrides:

GetProperty in class CameraBase

Parameters:

pProp - Pointer to the Property structure to be filled.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetPropertyInfo(), SetProperty()

SetProperty
```
@ByVal
public Error SetProperty(@Const
                                Property pProp,
                                @Cast(value="bool")
                                boolean broadcast)
```
Description copied from class: CameraBase

Writes the settings for the specified property to the camera. The property type must be specified in the Property structure passed into the function in order for the function to succeed. The absControl flag controls whether the absolute or integer value is written to the camera. Use GetPropertyInfo() to query which options are available for a specific property.

Overrides:

SetProperty in class CameraBase

Parameters:

pProp - Pointer to the Property structure to be used.

broadcast - Whether the action should be broadcast.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetPropertyInfo(), GetProperty()

SetProperty

@ByVal
public Error SetProperty(@Const
                                Property pProp)

Overrides:: SetProperty in class CameraBase

GetGPIOPinDirection
```
@ByVal
public Error GetGPIOPinDirection(@Cast(value="unsigned int")
                                        int pin,
                                        @Cast(value="unsigned int*")
                                        IntPointer pDirection)
```
Description copied from class: CameraBase

Get the GPIO pin direction for the specified pin. This is not a required call when using the trigger or strobe functions as the pin direction is set automatically internally.

Overrides:

GetGPIOPinDirection in class CameraBase

Parameters:

pin - Pin to get the direction for.

pDirection - Direction of the pin. 0 for input, 1 for output.

Returns:

An Error indicating the success or failure of the function.

See Also:

SetGPIOPinDirection()

GetGPIOPinDirection

@ByVal
public Error GetGPIOPinDirection(@Cast(value="unsigned int")
                                        int pin,
                                        @Cast(value="unsigned int*")
                                        IntBuffer pDirection)

Overrides:: GetGPIOPinDirection in class CameraBase

GetGPIOPinDirection

@ByVal
public Error GetGPIOPinDirection(@Cast(value="unsigned int")
                                        int pin,
                                        @Cast(value="unsigned int*")
                                        int[] pDirection)

Overrides:: GetGPIOPinDirection in class CameraBase

SetGPIOPinDirection
```
@ByVal
public Error SetGPIOPinDirection(@Cast(value="unsigned int")
                                        int pin,
                                        @Cast(value="unsigned int")
                                        int direction,
                                        @Cast(value="bool")
                                        boolean broadcast)
```
Description copied from class: CameraBase

Set the GPIO pin direction for the specified pin. This is useful if there is a need to set the pin into an input pin (i.e. to read the voltage) off the pin without setting it as a trigger source. This is not a required call when using the trigger or strobe functions as the pin direction is set automatically internally.

Overrides:

SetGPIOPinDirection in class CameraBase

Parameters:

pin - Pin to get the direction for.

direction - Direction of the pin. 0 for input, 1 for output.

broadcast - Whether the action should be broadcast.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetGPIOPinDirection()

SetGPIOPinDirection

@ByVal
public Error SetGPIOPinDirection(@Cast(value="unsigned int")
                                        int pin,
                                        @Cast(value="unsigned int")
                                        int direction)

Overrides:: SetGPIOPinDirection in class CameraBase

GetTriggerModeInfo
```
@ByVal
public Error GetTriggerModeInfo(TriggerModeInfo pTriggerModeInfo)
```
Description copied from class: CameraBase

Retrieve trigger information from the camera.

Overrides:

GetTriggerModeInfo in class CameraBase

Parameters:

pTriggerModeInfo - Structure to receive trigger information.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetTriggerMode(), SetTriggerMode(), GetTriggerDelayInfo(), GetTriggerDelay(), SetTriggerDelay()

GetTriggerMode
```
@ByVal
public Error GetTriggerMode(TriggerMode pTriggerMode)
```
Description copied from class: CameraBase

Retrieve current trigger settings from the camera.

Overrides:

GetTriggerMode in class CameraBase

Parameters:

pTriggerMode - Structure to receive trigger mode settings.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetTriggerModeInfo(), SetTriggerMode(), GetTriggerDelayInfo(), GetTriggerDelay(), SetTriggerDelay()

SetTriggerMode
```
@ByVal
public Error SetTriggerMode(@Const
                                   TriggerMode pTriggerMode,
                                   @Cast(value="bool")
                                   boolean broadcast)
```
Description copied from class: CameraBase

Set the specified trigger settings to the camera.

Overrides:

SetTriggerMode in class CameraBase

Parameters:

pTriggerMode - Structure providing trigger mode settings.

broadcast - Whether the action should be broadcast.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetTriggerModeInfo(), GetTriggerMode(), GetTriggerDelayInfo(), GetTriggerDelay(), SetTriggerDelay()

SetTriggerMode

@ByVal
public Error SetTriggerMode(@Const
                                   TriggerMode pTriggerMode)

Overrides:: SetTriggerMode in class CameraBase

FireSoftwareTrigger
```
@ByVal
public Error FireSoftwareTrigger(@Cast(value="bool")
                                        boolean broadcast)
```
Description copied from class: CameraBase

Fire the software trigger according to the DCAM specifications.

Overrides:

FireSoftwareTrigger in class CameraBase

Parameters:

broadcast - Whether the action should be broadcast.

Returns:

An Error indicating the success or failure of the function.

FireSoftwareTrigger
```
@ByVal
public Error FireSoftwareTrigger()
```
Overrides:

FireSoftwareTrigger in class CameraBase

GetTriggerDelayInfo
```
@ByVal
public Error GetTriggerDelayInfo(@Cast(value="FlyCapture2::TriggerDelayInfo*")
                                        PropertyInfo pTriggerDelayInfo)
```
Description copied from class: CameraBase

Retrieve trigger delay information from the camera.

Overrides:

GetTriggerDelayInfo in class CameraBase

Parameters:

pTriggerDelayInfo - Structure to receive trigger delay information.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetTriggerModeInfo(), GetTriggerMode(), SetTriggerMode(), GetTriggerDelay(), SetTriggerDelay()

GetTriggerDelay
```
@ByVal
public Error GetTriggerDelay(@Cast(value="FlyCapture2::TriggerDelay*")
                                    Property pTriggerDelay)
```
Description copied from class: CameraBase

Retrieve current trigger delay settings from the camera.

Overrides:

GetTriggerDelay in class CameraBase

Parameters:

pTriggerDelay - Structure to receive trigger delay settings.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetTriggerModeInfo(), GetTriggerMode(), SetTriggerMode(), GetTriggerDelayInfo(), SetTriggerDelay()

SetTriggerDelay
```
@ByVal
public Error SetTriggerDelay(@Cast(value="const FlyCapture2::TriggerDelay*")
                                    Property pTriggerDelay,
                                    @Cast(value="bool")
                                    boolean broadcast)
```
Description copied from class: CameraBase

Set the specified trigger delay settings to the camera.

Overrides:

SetTriggerDelay in class CameraBase

Parameters:

pTriggerDelay - Structure providing trigger delay settings.

broadcast - Whether the action should be broadcast.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetTriggerModeInfo(), GetTriggerMode(), SetTriggerMode(), GetTriggerDelayInfo(), GetTriggerDelay()

SetTriggerDelay

@ByVal
public Error SetTriggerDelay(@Cast(value="const FlyCapture2::TriggerDelay*")
                                    Property pTriggerDelay)

Overrides:: SetTriggerDelay in class CameraBase

GetStrobeInfo
```
@ByVal
public Error GetStrobeInfo(StrobeInfo pStrobeInfo)
```
Description copied from class: CameraBase

Retrieve strobe information from the camera.

Overrides:

GetStrobeInfo in class CameraBase

Parameters:

pStrobeInfo - Structure to receive strobe information.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetStrobe(), SetStrobe()

GetStrobe
```
@ByVal
public Error GetStrobe(StrobeControl pStrobeControl)
```
Description copied from class: CameraBase

Retrieve current strobe settings from the camera. The strobe pin must be specified in the structure before being passed in to the function.

Overrides:

GetStrobe in class CameraBase

Parameters:

pStrobeControl - Structure to receive strobe settings.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetStrobeInfo(), SetStrobe()

SetStrobe
```
@ByVal
public Error SetStrobe(@Const
                              StrobeControl pStrobeControl,
                              @Cast(value="bool")
                              boolean broadcast)
```
Description copied from class: CameraBase

Set current strobe settings to the camera. The strobe pin must be specified in the structure before being passed in to the function.

Overrides:

SetStrobe in class CameraBase

Parameters:

pStrobeControl - Structure providing strobe settings.

broadcast - Whether the action should be broadcast.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetStrobeInfo(), GetStrobe()

SetStrobe

@ByVal
public Error SetStrobe(@Const
                              StrobeControl pStrobeControl)

Overrides:: SetStrobe in class CameraBase

GetLUTInfo
```
@ByVal
public Error GetLUTInfo(LUTData pData)
```
Description copied from class: CameraBase

Query if LUT support is available on the camera. Note that some cameras may report support for the LUT and return an inputBitDepth of 0. In these cases use log2(numEntries) for the inputBitDepth.

Overrides:

GetLUTInfo in class CameraBase

Parameters:

pData - The LUT structure to be filled.

Returns:

An Error indicating the success or failure of the function.

See Also:

EnableLUT(), GetLUTChannel(), SetLUTChannel()

GetLUTBankInfo

@ByVal
public Error GetLUTBankInfo(@Cast(value="unsigned int")
                                   int bank,
                                   @Cast(value="bool*")
                                   BoolPointer pReadSupported,
                                   @Cast(value="bool*")
                                   BoolPointer pWriteSupported)

Description copied from class: CameraBase

Query the read/write status of a single LUT bank.

Overrides:: GetLUTBankInfo in class CameraBase
Parameters:: bank - The bank to query.; pReadSupported - Whether reading from the bank is supported.; pWriteSupported - Whether writing to the bank is supported.
Returns:: An Error indicating the success or failure of the function.

GetLUTBankInfo

@ByVal
public Error GetLUTBankInfo(@Cast(value="unsigned int")
                                   int bank,
                                   @Cast(value="bool*")
                                   boolean[] pReadSupported,
                                   @Cast(value="bool*")
                                   boolean[] pWriteSupported)

Overrides:: GetLUTBankInfo in class CameraBase

GetActiveLUTBank
```
@ByVal
public Error GetActiveLUTBank(@Cast(value="unsigned int*")
                                     IntPointer pActiveBank)
```
Description copied from class: CameraBase

Get the LUT bank that is currently being used. For cameras with PGR LUT, the active bank is always 0.

Overrides:

GetActiveLUTBank in class CameraBase

Parameters:

pActiveBank - The currently active bank.

Returns:

An Error indicating the success or failure of the function.

GetActiveLUTBank

@ByVal
public Error GetActiveLUTBank(@Cast(value="unsigned int*")
                                     IntBuffer pActiveBank)

Overrides:: GetActiveLUTBank in class CameraBase

GetActiveLUTBank

@ByVal
public Error GetActiveLUTBank(@Cast(value="unsigned int*")
                                     int[] pActiveBank)

Overrides:: GetActiveLUTBank in class CameraBase

SetActiveLUTBank
```
@ByVal
public Error SetActiveLUTBank(@Cast(value="unsigned int")
                                     int activeBank)
```
Description copied from class: CameraBase

Set the LUT bank that will be used.

Overrides:

SetActiveLUTBank in class CameraBase

Parameters:

activeBank - The bank to be set as active.

Returns:

An Error indicating the success or failure of the function.

EnableLUT
```
@ByVal
public Error EnableLUT(@Cast(value="bool")
                              boolean on)
```
Description copied from class: CameraBase

Enable or disable LUT functionality on the camera.

Overrides:

EnableLUT in class CameraBase

Parameters:

on - Whether to enable or disable LUT.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetLUTInfo(), GetLUTChannel(), SetLUTChannel()

GetLUTChannel

@ByVal
public Error GetLUTChannel(@Cast(value="unsigned int")
                                  int bank,
                                  @Cast(value="unsigned int")
                                  int channel,
                                  @Cast(value="unsigned int")
                                  int sizeEntries,
                                  @Cast(value="unsigned int*")
                                  IntPointer pEntries)

Description copied from class: CameraBase

Get the LUT channel settings from the camera.

Overrides:: GetLUTChannel in class CameraBase
Parameters:: bank - Bank to retrieve.; channel - Channel to retrieve.; sizeEntries - Number of entries in LUT table to read.; pEntries - Array to store LUT entries.
Returns:: An Error indicating the success or failure of the function.
See Also:: GetLUTInfo(), EnableLUT(), SetLUTChannel()

GetLUTChannel

@ByVal
public Error GetLUTChannel(@Cast(value="unsigned int")
                                  int bank,
                                  @Cast(value="unsigned int")
                                  int channel,
                                  @Cast(value="unsigned int")
                                  int sizeEntries,
                                  @Cast(value="unsigned int*")
                                  IntBuffer pEntries)

Overrides:: GetLUTChannel in class CameraBase

GetLUTChannel

@ByVal
public Error GetLUTChannel(@Cast(value="unsigned int")
                                  int bank,
                                  @Cast(value="unsigned int")
                                  int channel,
                                  @Cast(value="unsigned int")
                                  int sizeEntries,
                                  @Cast(value="unsigned int*")
                                  int[] pEntries)

Overrides:: GetLUTChannel in class CameraBase

SetLUTChannel

@ByVal
public Error SetLUTChannel(@Cast(value="unsigned int")
                                  int bank,
                                  @Cast(value="unsigned int")
                                  int channel,
                                  @Cast(value="unsigned int")
                                  int sizeEntries,
                                  @Cast(value="const unsigned int*")
                                  IntPointer pEntries)

Description copied from class: CameraBase

Set the LUT channel settings to the camera.

Overrides:: SetLUTChannel in class CameraBase
Parameters:: bank - Bank to set.; channel - Channel to set.; sizeEntries - Number of entries in LUT table to write. This must be the same size as numEntries returned by GetLutInfo().; pEntries - Array containing LUT entries to write.
Returns:: An Error indicating the success or failure of the function.
See Also:: GetLUTInfo(), EnableLUT(), GetLUTChannel()

SetLUTChannel

@ByVal
public Error SetLUTChannel(@Cast(value="unsigned int")
                                  int bank,
                                  @Cast(value="unsigned int")
                                  int channel,
                                  @Cast(value="unsigned int")
                                  int sizeEntries,
                                  @Cast(value="const unsigned int*")
                                  IntBuffer pEntries)

Overrides:: SetLUTChannel in class CameraBase

SetLUTChannel

@ByVal
public Error SetLUTChannel(@Cast(value="unsigned int")
                                  int bank,
                                  @Cast(value="unsigned int")
                                  int channel,
                                  @Cast(value="unsigned int")
                                  int sizeEntries,
                                  @Cast(value="const unsigned int*")
                                  int[] pEntries)

Overrides:: SetLUTChannel in class CameraBase

GetMemoryChannel
```
@ByVal
public Error GetMemoryChannel(@Cast(value="unsigned int*")
                                     IntPointer pCurrentChannel)
```
Description copied from class: CameraBase

Retrieve the current memory channel from the camera.

Overrides:

GetMemoryChannel in class CameraBase

Parameters:

pCurrentChannel - Current memory channel.

Returns:

An Error indicating the success or failure of the function.

See Also:

SaveToMemoryChannel(), RestoreFromMemoryChannel(), GetMemoryChannelInfo()

GetMemoryChannel

@ByVal
public Error GetMemoryChannel(@Cast(value="unsigned int*")
                                     IntBuffer pCurrentChannel)

Overrides:: GetMemoryChannel in class CameraBase

GetMemoryChannel

@ByVal
public Error GetMemoryChannel(@Cast(value="unsigned int*")
                                     int[] pCurrentChannel)

Overrides:: GetMemoryChannel in class CameraBase

SaveToMemoryChannel
```
@ByVal
public Error SaveToMemoryChannel(@Cast(value="unsigned int")
                                        int channel)
```
Description copied from class: CameraBase

Save the current settings to the specfied current memory channel.

Overrides:

SaveToMemoryChannel in class CameraBase

Parameters:

channel - Memory channel to save to.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetMemoryChannel(), RestoreFromMemoryChannel(), GetMemoryChannelInfo()

RestoreFromMemoryChannel
```
@ByVal
public Error RestoreFromMemoryChannel(@Cast(value="unsigned int")
                                             int channel)
```
Description copied from class: CameraBase

Restore the specfied current memory channel.

Overrides:

RestoreFromMemoryChannel in class CameraBase

Parameters:

channel - Memory channel to restore from.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetMemoryChannel(), SaveToMemoryChannel(), GetMemoryChannelInfo()

GetMemoryChannelInfo
```
@ByVal
public Error GetMemoryChannelInfo(@Cast(value="unsigned int*")
                                         IntPointer pNumChannels)
```
Description copied from class: CameraBase

Query the camera for memory channel support. If the number of channels is 0, then memory channel support is not available.

Overrides:

GetMemoryChannelInfo in class CameraBase

Parameters:

pNumChannels - Number of memory channels supported.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetMemoryChannel(), SaveToMemoryChannel(), RestoreFromMemoryChannel()

GetMemoryChannelInfo

@ByVal
public Error GetMemoryChannelInfo(@Cast(value="unsigned int*")
                                         IntBuffer pNumChannels)

Overrides:: GetMemoryChannelInfo in class CameraBase

GetMemoryChannelInfo

@ByVal
public Error GetMemoryChannelInfo(@Cast(value="unsigned int*")
                                         int[] pNumChannels)

Overrides:: GetMemoryChannelInfo in class CameraBase

GetEmbeddedImageInfo
```
@ByVal
public Error GetEmbeddedImageInfo(EmbeddedImageInfo pInfo)
```
Description copied from class: CameraBase

Get the current status of the embedded image information register, as well as the availability of each embedded property.

Overrides:

GetEmbeddedImageInfo in class CameraBase

Parameters:

pInfo - Structure to be filled.

Returns:

An Error indicating the success or failure of the function.

See Also:

SetEmbeddedImageInfo()

SetEmbeddedImageInfo
```
@ByVal
public Error SetEmbeddedImageInfo(EmbeddedImageInfo pInfo)
```
Description copied from class: CameraBase

Sets the on/off values of the embedded image information structure to the camera.

Overrides:

SetEmbeddedImageInfo in class CameraBase

Parameters:

pInfo - Structure to be used.

Returns:

An Error indicating the success or failure of the function.

See Also:

GetEmbeddedImageInfo()

WriteRegister

@ByVal
public Error WriteRegister(@Cast(value="unsigned int")
                                  int _address,
                                  @Cast(value="unsigned int")
                                  int value,
                                  @Cast(value="bool")
                                  boolean broadcast)

Description copied from class: CameraBase

Write to the specified register on the camera.

Overrides:: WriteRegister in class CameraBase; value - The value to be written.; broadcast - Whether the action should be broadcast.
Returns:: An Error indicating the success or failure of the function.
See Also:: ReadRegister()

WriteRegister

@ByVal
public Error WriteRegister(@Cast(value="unsigned int")
                                  int _address,
                                  @Cast(value="unsigned int")
                                  int value)

Overrides:: WriteRegister in class CameraBase

ReadRegister

@ByVal
public Error ReadRegister(@Cast(value="unsigned int")
                                 int _address,
                                 @Cast(value="unsigned int*")
                                 IntPointer pValue)

Description copied from class: CameraBase

Read the specified register from the camera.

Overrides:: ReadRegister in class CameraBase; pValue - The value that is read.
Returns:: An Error indicating the success or failure of the function.
See Also:: WriteRegister()

ReadRegister

@ByVal
public Error ReadRegister(@Cast(value="unsigned int")
                                 int _address,
                                 @Cast(value="unsigned int*")
                                 IntBuffer pValue)

Overrides:: ReadRegister in class CameraBase

ReadRegister

@ByVal
public Error ReadRegister(@Cast(value="unsigned int")
                                 int _address,
                                 @Cast(value="unsigned int*")
                                 int[] pValue)

Overrides:: ReadRegister in class CameraBase

WriteRegisterBlock

@ByVal
public Error WriteRegisterBlock(@Cast(value="unsigned short")
                                       short addressHigh,
                                       @Cast(value="unsigned int")
                                       int addressLow,
                                       @Cast(value="const unsigned int*")
                                       IntPointer pBuffer,
                                       @Cast(value="unsigned int")
                                       int length)

Description copied from class: CameraBase

Write to the specified register block on the camera.

Overrides:: WriteRegisterBlock in class CameraBase
Parameters:: addressHigh - Top 16 bits of the 48 bit absolute address to write to.; addressLow - Bottom 32 bits of the 48 bits absolute address to write to.; pBuffer - Array containing data to be written.; length - Size of array, in quadlets.
Returns:: An Error indicating the success or failure of the function.
See Also:: ReadRegisterBlock()

WriteRegisterBlock

@ByVal
public Error WriteRegisterBlock(@Cast(value="unsigned short")
                                       short addressHigh,
                                       @Cast(value="unsigned int")
                                       int addressLow,
                                       @Cast(value="const unsigned int*")
                                       IntBuffer pBuffer,
                                       @Cast(value="unsigned int")
                                       int length)

Overrides:: WriteRegisterBlock in class CameraBase

WriteRegisterBlock

@ByVal
public Error WriteRegisterBlock(@Cast(value="unsigned short")
                                       short addressHigh,
                                       @Cast(value="unsigned int")
                                       int addressLow,
                                       @Cast(value="const unsigned int*")
                                       int[] pBuffer,
                                       @Cast(value="unsigned int")
                                       int length)

Overrides:: WriteRegisterBlock in class CameraBase

ReadRegisterBlock

@ByVal
public Error ReadRegisterBlock(@Cast(value="unsigned short")
                                      short addressHigh,
                                      @Cast(value="unsigned int")
                                      int addressLow,
                                      @Cast(value="unsigned int*")
                                      IntPointer pBuffer,
                                      @Cast(value="unsigned int")
                                      int length)

Description copied from class: CameraBase

Read from the specified register block on the camera.

Overrides:: ReadRegisterBlock in class CameraBase
Parameters:: addressHigh - Top 16 bits of the 48 bit absolute address to read from.; addressLow - Bottom 32 bits of the 48 bits absolute address to read from.; pBuffer - Array to store read data.; length - Size of array, in quadlets.
Returns:: An Error indicating the success or failure of the function.
See Also:: WriteRegisterBlock()

ReadRegisterBlock

@ByVal
public Error ReadRegisterBlock(@Cast(value="unsigned short")
                                      short addressHigh,
                                      @Cast(value="unsigned int")
                                      int addressLow,
                                      @Cast(value="unsigned int*")
                                      IntBuffer pBuffer,
                                      @Cast(value="unsigned int")
                                      int length)

Overrides:: ReadRegisterBlock in class CameraBase

ReadRegisterBlock

@ByVal
public Error ReadRegisterBlock(@Cast(value="unsigned short")
                                      short addressHigh,
                                      @Cast(value="unsigned int")
                                      int addressLow,
                                      @Cast(value="unsigned int*")
                                      int[] pBuffer,
                                      @Cast(value="unsigned int")
                                      int length)

Overrides:: ReadRegisterBlock in class CameraBase

GetRegisterString

@Cast(value="const char*")
public static BytePointer GetRegisterString(@Cast(value="unsigned int")
                                                                       int registerVal)

GetCycleTime
```
@ByVal
public Error GetCycleTime(TimeStamp timeStamp)
```
Description copied from class: CameraBase

Returns a Timestamp struct containing 1394 CYCLE_TIME information

Overrides:

GetCycleTime in class CameraBase

Returns:

An Error indicating the success or failure of the function.

GetStats

@ByVal
public Error GetStats(CameraStats pStats)

Overrides:: GetStats in class CameraBase

ResetStats
```
@ByVal
public Error ResetStats()
```
Overrides:

ResetStats in class CameraBase

RegisterEvent

@ByVal
public Error RegisterEvent(EventOptions pOpts)

Overrides:: RegisterEvent in class CameraBase

DeregisterEvent

@ByVal
public Error DeregisterEvent(EventOptions pOpts)

Overrides:: DeregisterEvent in class CameraBase

RegisterAllEvents

@ByVal
public Error RegisterAllEvents(EventOptions pOpts)

Overrides:: RegisterAllEvents in class CameraBase

DeregisterAllEvents
```
@ByVal
public Error DeregisterAllEvents()
```
Overrides:

DeregisterAllEvents in class CameraBase

Class Camera

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.bytedeco.javacpp.Pointer

Methods inherited from class java.lang.Object

Constructor Detail

Camera

Camera

Camera

Method Detail

position

getPointer

GetVideoModeAndFrameRateInfo

GetVideoModeAndFrameRateInfo

GetVideoModeAndFrameRate

GetVideoModeAndFrameRate

GetVideoModeAndFrameRate

SetVideoModeAndFrameRate

GetFormat7Info

GetFormat7Info

ValidateFormat7Settings

ValidateFormat7Settings

GetFormat7Configuration

GetFormat7Configuration

GetFormat7Configuration

SetFormat7Configuration

SetFormat7Configuration

Connect

Connect

Disconnect

IsConnected

SetCallback

SetCallback

StartCapture

StartCapture

StartSyncCapture

StartSyncCapture

StartSyncCapture

RetrieveBuffer

StopCapture

WaitForBufferEvent

SetUserBuffers

SetUserBuffers

SetUserBuffers

GetConfiguration

SetConfiguration

GetCameraInfo

GetPropertyInfo

GetProperty

SetProperty

SetProperty

GetGPIOPinDirection

GetGPIOPinDirection

GetGPIOPinDirection

SetGPIOPinDirection

SetGPIOPinDirection

GetTriggerModeInfo

GetTriggerMode

SetTriggerMode

SetTriggerMode

FireSoftwareTrigger

FireSoftwareTrigger

GetTriggerDelayInfo

GetTriggerDelay

SetTriggerDelay

SetTriggerDelay

GetStrobeInfo

GetStrobe

SetStrobe

SetStrobe

GetLUTInfo

GetLUTBankInfo

GetLUTBankInfo

GetActiveLUTBank

GetActiveLUTBank

GetActiveLUTBank