CameraSettingsV4L2Device Class Reference

mvV4L2 related camera settings(Device specific interface layout only). More...

Inheritance diagram for CameraSettingsV4L2Device:

Public Member Functions
	CameraSettingsV4L2Device (Device pDev)
	Constructs a new mvIMPACT.acquire.CameraSettingsV4L2Device object.
	CameraSettingsV4L2Device (Device pDev, String settingName)
	Constructs a new mvIMPACT.acquire.CameraSettingsV4L2Device object.
synchronized void	delete ()
PropertyI	getAoiHeight ()
	An integer property defining the number of lines to capture.
PropertyI	getAoiStartX ()
	An integer property defining the X-offset for each capture line.
PropertyI	getAoiStartY ()
	An integer property defining the Y-offset.
PropertyI	getAoiWidth ()
	An integer property defining the number of pixels to capture per line.
PropertyI	getAutoGain ()
	An enumerated integer property to switch on/off the auto gain.
PropertyI	getAutoWhiteBalance ()
	An enumerated integer property to switch on/off the auto white balance function of the V4L2-device.
PropertyI	getBacklightCompensation ()
	An integer property to adjust the backlight compensation.
PropertyS	getBasedOn ()
	A string property (read-only) containing the name of the setting this setting is based on.
PropertyI	getBlackLevel ()
	An integer property to adjust the black level.
PropertyI	getBlueBalance ()
	An integer property to adjust the blue balance.
PropertyI	getBrightness ()
	An integer property to adjust the brightness.
PropertyI	getContrast ()
	An integer property to adjust the contrast.
Component	getCustomFeatureIterator ()
	Returns an iterator to for iterating inside a device specific feature list.
PropertyI	getExposure ()
	An integer property to adjust the exposure.
PropertyI	getGain ()
	An integer property to adjust the gain.
PropertyI	getGamma ()
	An integer property to adjust the gamma.
PropertyI	getHFlip ()
	An enumerated integer property to mirror the frames horizontally.
PropertyI	getHue ()
	An integer property to adjust the hue.
PropertyI	getHueAuto ()
	An enumerated integer property to switch on/off auto hue.
PropertyI	getImageHeight ()
	An integer property defining the height of the image supplied by the V4L2 device.
PropertyI	getImageRequestTimeout_ms ()
	An integer property defining the maximum time to wait for an image in ms.
PropertyI	getImageWidth ()
	An integer property defining the width of the image supplied by the V4L2 device.
PropertyI	getPixelFormat ()
	An integer property defining the pixel format of captured frames.
PropertyI	getPowerLineFrequency ()
	An enumerated integer property to enable power line frequency filter.
PropertyI	getRedBalance ()
	An integer property to adjust the red balance.
PropertyI	getSaturation ()
	An integer property to adjust the saturation.
PropertyI	getSharpness ()
	An integer property to adjust the sharpness.
PropertyI	getVFlip ()
	An integer property to mirror the frames vertically.
PropertyI	getVideoStandard ()
	An integer property defining the video standard.
PropertyI	getWhiteBalanceTemperature ()
	An integer property to adjust white balance temperature.
int	hObj ()
	Returns a unique identifier for the component collection referenced by this object.
ComponentCollection	restoreDefault ()
	Restores the default for every component of this collection.

Protected Member Functions
	CameraSettingsV4L2Device (long cPtr, boolean cMemoryOwn)
void	finalize ()

Static Protected Member Functions
static long	swigRelease (BasicDeviceSettings obj)
static long	swigRelease (BasicDeviceSettingsWithAOI obj)
static long	swigRelease (CameraSettingsV4L2Device obj)
static long	swigRelease (ComponentCollection obj)

Protected Attributes
transient boolean	swigCMemOwn

Detailed Description

mvV4L2 related camera settings(Device specific interface layout only).

Note

UNDER CONSTRUCTION! Subject to change.

This class will only be available if mvIMPACT.acquire.Device.getInterfaceLayout() is set to mvIMPACT.acquire.TDeviceInterfaceLayout.dilDeviceSpecific before the device is opened.

Constructor & Destructor Documentation

CameraSettingsV4L2Device() [1/3]

CameraSettingsV4L2Device ( long cPtr, boolean cMemoryOwn )

protected

CameraSettingsV4L2Device() [2/3]

CameraSettingsV4L2Device	(	Device	pDev,
		String	settingName )

Constructs a new mvIMPACT.acquire.CameraSettingsV4L2Device object.

Parameters

pDev	[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object.
settingName	[in] The name of the driver internal setting to access with this instance. A list of valid setting names can be obtained by a call to mvIMPACT.acquire.FunctionInterface.getAvailableSettings, new settings can be created with the function mvIMPACT.acquire.FunctionInterface.createSetting

CameraSettingsV4L2Device() [3/3]

CameraSettingsV4L2Device

(

Device

pDev

)

Constructs a new mvIMPACT.acquire.CameraSettingsV4L2Device object.

Parameters

pDev

[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object. A list of valid setting names can be obtained by a call to mvIMPACT.acquire.FunctionInterface.getAvailableSettings, new settings can be created with the function mvIMPACT.acquire.FunctionInterface.createSetting

Member Function Documentation

delete()

synchronized void delete

(

)

Reimplemented from BasicDeviceSettingsWithAOI.

finalize()

void finalize ( )

protected

Reimplemented from BasicDeviceSettingsWithAOI.

getAoiHeight()

PropertyI getAoiHeight ( )

inherited

An integer property defining the number of lines to capture.

getAoiStartX()

PropertyI getAoiStartX ( )

inherited

An integer property defining the X-offset for each capture line.

Example: When setting this property to 5 the first pixel in each line of the resulting image will be pixel number 5 of each line transmitted by the camera.

getAoiStartY()

PropertyI getAoiStartY ( )

inherited

An integer property defining the Y-offset.

Example: When setting this property to 5 the first line of the resulting image will be line number 5 of the image transmitted by the camera.

getAoiWidth()

PropertyI getAoiWidth ( )

inherited

An integer property defining the number of pixels to capture per line.

getAutoGain()

PropertyI getAutoGain

(

)

An enumerated integer property to switch on/off the auto gain.

This property represents a boolean-valued V4L2-control ID. Valid values for this property are defined by the enumeration mvIMPACT.acquire.TBoolean.

Note

This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not.

getAutoWhiteBalance()

PropertyI getAutoWhiteBalance

(

)

An enumerated integer property to switch on/off the auto white balance function of the V4L2-device.

This property represents a boolean-valued V4L2-control ID. Valid values for this property are defined by the enumeration mvIMPACT.acquire.TBoolean.

Note

This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not.

getBacklightCompensation()

PropertyI getBacklightCompensation

(

)

An integer property to adjust the backlight compensation.

This property represents a V4L2-control ID.

Note

This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. If supported, a min-value, a max-value and step-width are defined. Thus, invalid values may be tuned after writing to fit within the limits.

getBasedOn()

PropertyS getBasedOn ( )

inherited

A string property (read-only) containing the name of the setting this setting is based on.

Since

1.12.67

getBlackLevel()

PropertyI getBlackLevel

(

)

An integer property to adjust the black level.

This property represents a V4L2-control ID.

Note

This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. If supported, a minimum value, a maximum value and step width will be defined. Thus, invalid values may be tuned after writing to fit within the step size, values too large or too small will raise an exception.

getBlueBalance()

PropertyI getBlueBalance

(

)

An integer property to adjust the blue balance.

This property represents a V4L2-control ID.

Note

This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. If supported, a minimum value, a maximum value and step width will be defined. Thus, invalid values may be tuned after writing to fit within the step size, values too large or too small will raise an exception.

getBrightness()

PropertyI getBrightness

(

)

An integer property to adjust the brightness.

This property represents a V4L2-control ID.

Note

This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. If supported, a minimum value, a maximum value and step width will be defined. Thus, invalid values may be tuned after writing to fit within the step size, values too large or too small will raise an exception.

getContrast()

PropertyI getContrast

(

)

An integer property to adjust the contrast.

This property represents a V4L2-control ID.

Note

This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. If supported, a minimum value, a maximum value and step width will be defined. Thus, invalid values may be tuned after writing to fit within the step size, values too large or too small will raise an exception.

getCustomFeatureIterator()

Component getCustomFeatureIterator

(

)

Returns an iterator to for iterating inside a device specific feature list.

This can be useful a device offers custom features that are not defined in the V4L2 standard and thus can't be known at compile time.

It allows to write code like this:

import java.util.Hashtable;
 
// ...
 
CameraSettingsV4L2Device cs = new CameraSettingsV4L2Device( getDevicePointerFromSomewhere() );
Component it = cs.getCustomFeatureIterator();
Hashtable<String, String> m = new Hashtable<String, String>();
while( it.isValid() )
{
  // collect all entries that are properties and store their current name and value in a hash table
  if( it.isProp() && it.isVisible() )
  {
     Property prop = new Property( it.hObj() );
     m.put( prop.name(), prop.readS() );
  }
  it = it.nextSibling();
}

getExposure()

PropertyI getExposure

(

)

An integer property to adjust the exposure.

This property represents a V4L2-control ID.

Note

This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. If supported, a minimum value, a maximum value and step width will be defined. Thus, invalid values may be tuned after writing to fit within the step size, values too large or too small will raise an exception.

getGain()

PropertyI getGain

(

)

An integer property to adjust the gain.

This property represents a V4L2-control ID.

Note

This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. If supported, a minimum value, a maximum value and step width will be defined. Thus, invalid values may be tuned after writing to fit within the step size, values too large or too small will raise an exception.

getGamma()

PropertyI getGamma

(

)

An integer property to adjust the gamma.

This property represents a V4L2-control ID

Note

This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. If supported, a min-value, a max-value and step-width are defined. Thus, invalid values may be tuned after writing to fit within the limits.

getHFlip()

PropertyI getHFlip

(

)

An enumerated integer property to mirror the frames horizontally.

This property represents a boolean-valued V4L2-control ID. Valid values for this property are defined by the enumeration mvIMPACT.acquire.TBoolean.

Note

This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not.

getHue()

PropertyI getHue

(

)

An integer property to adjust the hue.

This property represents a V4L2-control ID.

Note

This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. If supported, a minimum value, a maximum value and step width will be defined. Thus, invalid values may be tuned after writing to fit within the step size, values too large or too small will raise an exception.

getHueAuto()

PropertyI getHueAuto

(

)

An enumerated integer property to switch on/off auto hue.

This property represents a boolean-valued V4L2-control ID. Valid values for this property are defined by the enumeration mvIMPACT.acquire.TBoolean.

Note

This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not.

getImageHeight()

PropertyI getImageHeight

(

)

An integer property defining the height of the image supplied by the V4L2 device.

See also

V4L2 API at http://v4l2spec.bytesex.org/spec-single/v4l2.html

getImageRequestTimeout_ms()

PropertyI getImageRequestTimeout_ms ( )

inherited

An integer property defining the maximum time to wait for an image in ms.

Attention

Since Impact Acquire 2.32.0 the default value for this property has been changed! See Calling 'imageRequestWaitFor' Never Returns / An Application No Longer Terminates After Upgrading To Impact Acquire 2.32.0 Or Greater for details.

When this property is set to 0 the timeout never elapses. If the timeout this property defines elapses the currently processed request will be returned to the user even if no data has been captured so far. The result structure of the request object should be examined in that case. Also this should be considered as an error from the users point of view in which case he should clean up the acquisition queue by calling mvIMPACT.acquire.FunctionInterface.imageRequestReset. Afterwards the capture loop can be restarted.

Note

It is crucial to understand that this is a timeout PER REQUEST! The timespan taken into account for the measurement starts when the driver begins to capture data into this particular buffer! So when queuing 4 buffers with a timeout of 3000 ms each and no data being transmitted by the device for any reason will cause the last buffer to time out 3000*4 = 12000 ms AFTER the buffer has been queued and the acquisition has been started as the driver will wait for up to 3 seconds for each buffer that is being processed. When the device sends data this timeout does not affect the runtime behaviour at all. No additional delay is introduced by it when everything runs as planned.

getImageWidth()

PropertyI getImageWidth

(

)

An integer property defining the width of the image supplied by the V4L2 device.

See also

V4L2 API at http://v4l2spec.bytesex.org/spec-single/v4l2.html

getPixelFormat()

PropertyI getPixelFormat

(

)

An integer property defining the pixel format of captured frames.

Use this property to set the pixel format within the image buffer supplied by the V4L2-device. Available pixel formats depend on the V4L2-device and conform to v4l2_fourcc()

See also

V4L2 API at http://v4l2spec.bytesex.org/spec-single/v4l2.html

getPowerLineFrequency()

PropertyI getPowerLineFrequency

(

)

An enumerated integer property to enable power line frequency filter.

This property represents a V4L2-control ID.

Note

This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not.

If supported, possible values conform to V4L2 API:

string representation	numerical representation
V4L2_CID_POWER_LINE_FREQUENCY_DISABLED	0
V4L2_CID_POWER_LINE_FREQUENCY_50HZ	1
V4L2_CID_POWER_LINE_FREQUENCY_60HZ	2

getRedBalance()

PropertyI getRedBalance

(

)

An integer property to adjust the red balance.

This property represents a V4L2-control ID.

Note

This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. If supported, a minimum value, a maximum value and step width will be defined. Thus, invalid values may be tuned after writing to fit within the step size, values too large or too small will raise an exception.

getSaturation()

PropertyI getSaturation

(

)

An integer property to adjust the saturation.

This property represents a V4L2-control ID.

Note

This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. If supported, a minimum value, a maximum value and step width will be defined. Thus, invalid values may be tuned after writing to fit within the step size, values too large or too small will raise an exception.

getSharpness()

PropertyI getSharpness

(

)

An integer property to adjust the sharpness.

This property represents a V4L2-control ID.

Note

This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. If supported, a minimum value, a maximum value and step width will be defined. Thus, invalid values may be tuned after writing to fit within the step size, values too large or too small will raise an exception.

getVFlip()

PropertyI getVFlip

(

)

An integer property to mirror the frames vertically.

This property represents a boolean-valued V4L2-control ID. Valid values for this property are defined by the enumeration mvIMPACT.acquire.TBoolean.

Note

This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not.

getVideoStandard()

PropertyI getVideoStandard

(

)

An integer property defining the video standard.

Use this property to configure the V4L2-device corresponding to the connected video source. Available video standards depend on the V4L2-device and conform to v4l2_std_id

See also

V4L2 API at http://v4l2spec.bytesex.org/spec-single/v4l2.html

getWhiteBalanceTemperature()

PropertyI getWhiteBalanceTemperature

(

)

An integer property to adjust white balance temperature.

This property represents a V4L2-control ID.

Note

This property is not supported by every device. Therefore always call the function mvIMPACT.acquire.Component.isValid to check if this property is available or not. If supported, a minimum value, a maximum value and step width will be defined. Thus, invalid values may be tuned after writing to fit within the step size, values too large or too small will raise an exception.

hObj()

int hObj ( )

inherited

Returns a unique identifier for the component collection referenced by this object.

This handle will always reference an object of type mvIMPACT.acquire.ComponentList.

Returns

A unique identifier for the component referenced by this object.

restoreDefault()

ComponentCollection restoreDefault ( )

inherited

Restores the default for every component of this collection.

Calling this function will restore the default value for every component belonging to this collection.

Note

The caller must have the right to modify the component. Otherwise an exception will be thrown.

Returns

A const reference to the component.

swigRelease() [1/4]

static long swigRelease ( BasicDeviceSettings obj )

staticprotectedinherited

swigRelease() [2/4]

static long swigRelease ( BasicDeviceSettingsWithAOI obj )

staticprotectedinherited

swigRelease() [3/4]

static long swigRelease ( CameraSettingsV4L2Device obj )

staticprotected

swigRelease() [4/4]

static long swigRelease ( ComponentCollection obj )

staticprotectedinherited

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protectedinherited