org.bytedeco.flycapture.FlyCapture2

Class CameraBase

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.flycapture.FlyCapture2.CameraBase

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

Camera, GigECamera

@Namespace(value="FlyCapture2")
 @NoOffset
 @Properties(inherit=FlyCapture2.class)
public class CameraBase
extends Pointer

The CameraBase class is an abstract base class that defines a general interface to a camera. \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
CameraBase(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Error	Connect()
Error	Connect(PGRGuid pGuid) Connects the camera object to the camera specified by the GUID.
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	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.
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.
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.
boolean	IsConnected() Checks if the camera object is connected to a physical camera specified by a GUID.
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	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	StartCapture()
Error	StartCapture(ImageEventCallback callbackFn, Pointer pCallbackData) Starts isochronous image capture.
Error	StopCapture() Stops isochronous image transfer and cleans up all associated resources.
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, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, offsetof, parseBytes, physicalBytes, position, 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

CameraBase

public CameraBase(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

Connect

@ByVal
public Error Connect(PGRGuid pGuid)

Connects the camera object to the camera specified by the GUID. If the guid is omitted or set to NULL, the connection will be made to the first camera detected on the PC (i.e. index = 0).

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()

Disconnect

@ByVal
public Error Disconnect()

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

Returns:

An Error indicating the success or failure of the function.

See Also:

Connect()

IsConnected

@Cast(value="bool")
public boolean IsConnected()

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

Returns:

Whether Connect() was called on the camera object.

See Also:

Connect(), Disconnect()

SetCallback

@ByVal
public Error SetCallback(ImageEventCallback callbackFn,
                                @Const
                                Pointer pCallbackData)

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.

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:

StartCapture()

SetCallback

@ByVal
public Error SetCallback(ImageEventCallback callbackFn)

StartCapture

@ByVal
public Error StartCapture(ImageEventCallback callbackFn,
                                 @Const
                                 Pointer pCallbackData)

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.

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(), StopCapture()

StartCapture

@ByVal
public Error StartCapture()

RetrieveBuffer

@ByVal
public Error RetrieveBuffer(Image pImage)

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.

Parameters:

pImage - Pointer to Image object to store image data.

Returns:

An Error indicating the success or failure of the function.

See Also:

StartCapture(), StopCapture()

StopCapture

@ByVal
public Error StopCapture()

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.

Returns:

An Error indicating the success or failure of the function.

See Also:

StartCapture(), RetrieveBuffer()

WaitForBufferEvent

@ByVal
public Error WaitForBufferEvent(Image pImage,
                                       @Cast(value="unsigned int")
                                       int eventNumber)

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

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:

StartCapture(), RetrieveBuffer(), StopCapture()

SetUserBuffers

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

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

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:

StartCapture(), RetrieveBuffer(), StopCapture()

SetUserBuffers

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

SetUserBuffers

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

GetConfiguration

@ByVal
public Error GetConfiguration(FC2Config pConfig)

Get the configuration associated with the camera object.

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)

Set the configuration associated with the camera object.

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)

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

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)

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.

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)

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.

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)

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.

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)

GetGPIOPinDirection

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

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.

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)

GetGPIOPinDirection

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

SetGPIOPinDirection

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

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.

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)

GetTriggerModeInfo

@ByVal
public Error GetTriggerModeInfo(TriggerModeInfo pTriggerModeInfo)

Retrieve trigger information from the camera.

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)

Retrieve current trigger settings from the camera.

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)

Set the specified trigger settings to the camera.

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)

FireSoftwareTrigger

@ByVal
public Error FireSoftwareTrigger(@Cast(value="bool")
                                        boolean broadcast)

Fire the software trigger according to the DCAM specifications.

Parameters:

broadcast - Whether the action should be broadcast.

Returns:

An Error indicating the success or failure of the function.

FireSoftwareTrigger

@ByVal
public Error FireSoftwareTrigger()

GetTriggerDelayInfo

@ByVal
public Error GetTriggerDelayInfo(@Cast(value="FlyCapture2::TriggerDelayInfo*")
                                        PropertyInfo pTriggerDelayInfo)

Retrieve trigger delay information from the camera.

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)

Retrieve current trigger delay settings from the camera.

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)

Set the specified trigger delay settings to the camera.

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)

GetStrobeInfo

@ByVal
public Error GetStrobeInfo(StrobeInfo pStrobeInfo)

Retrieve strobe information from the camera.

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)

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

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)

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

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)

GetLUTInfo

@ByVal
public Error GetLUTInfo(LUTData pData)

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.

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)

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

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)

GetActiveLUTBank

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

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

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)

GetActiveLUTBank

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

SetActiveLUTBank

@ByVal
public Error SetActiveLUTBank(@Cast(value="unsigned int")
                                     int activeBank)

Set the LUT bank that will be used.

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)

Enable or disable LUT functionality on the camera.

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)

Get the LUT channel settings from the camera.

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)

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)

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)

Set the LUT channel settings to the camera.

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)

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)

GetMemoryChannel

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

Retrieve the current memory channel from the camera.

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)

GetMemoryChannel

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

SaveToMemoryChannel

@ByVal
public Error SaveToMemoryChannel(@Cast(value="unsigned int")
                                        int channel)

Save the current settings to the specfied current memory channel.

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)

Restore the specfied current memory channel.

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)

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

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)

GetMemoryChannelInfo

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

GetEmbeddedImageInfo

@ByVal
public Error GetEmbeddedImageInfo(EmbeddedImageInfo pInfo)

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

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)

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

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)

Write to the specified register on the camera.

Parameters:

address - DCAM address to be written to.

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)

ReadRegister

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

Read the specified register from the camera.

Parameters:

address - DCAM address to be read from.

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)

ReadRegister

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

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)

Write to the specified register block on the camera.

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)

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)

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)

Read from the specified register block on the camera.

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)

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)

GetCycleTime

@ByVal
public Error GetCycleTime(TimeStamp timeStamp)

Returns a Timestamp struct containing 1394 CYCLE_TIME information

Parameters:

registerVal - The register value to query.

Returns:

An Error indicating the success or failure of the function.

GetStats

@ByVal
public Error GetStats(CameraStats pStats)

ResetStats

@ByVal
public Error ResetStats()

RegisterEvent

@ByVal
public Error RegisterEvent(EventOptions pOpts)

DeregisterEvent

@ByVal
public Error DeregisterEvent(EventOptions pOpts)

RegisterAllEvents

@ByVal
public Error RegisterAllEvents(EventOptions pOpts)

DeregisterAllEvents

@ByVal
public Error DeregisterAllEvents()