SystemV4L2 Class Reference

A class containing mvV4L2 specific settings to control the overall behaviour of the driver(Device specific interface layout only). More...

Inheritance diagram for SystemV4L2:

Public Member Functions
synchronized void	delete ()
PropertyI	getAcquisitionIdleTimeMax_ms ()
	An integer property defining the maximum time in ms the driver waits for new requests being queued until streaming by the device will automatically be stopped.
PropertyI	getAcquisitionMode ()
	An enumerated integer property defining the acquisition mode of the device.
PropertyI	getBalance ()
	If V4L2 device supports audio, this integer property adjusts the audio balance.
PropertyI	getBass ()
	If V4L2 device supports audio, this integer property adjusts the audio bass.
PropertyI	getFeaturePollingEnable ()
	An enumerated integer property defining whether features defining a polling time shall be updated automatically or not.
PropertyI	getFeaturePollingInterval_ms ()
	An integer property defining the polling interval in ms the driver waits for each iteration before running through update loop again.
PropertyI	getGenDCParserEnable ()
	An enumerated integer property which can be used to enable/disable automatic GenICam™ GenDC Container parsing.
PropertyI	getImageProcessingMaximumThreadCount ()
	An integer property influencing the number of parallel threads used by the internal image processing pipeline.
PropertyI	getImageProcessingMode ()
	An enumerated integer property influencing the behaviour of the internal image processing pipeline.
PropertyI	getImageProcessingOptimization ()
	An enumerated integer property influencing the behaviour of the internal image processing algorithms.
PropertyI	getLoudness ()
	If V4L2 device supports audio, this enumerated integer property sets audio loudness on/off.
PropertyI	getMethodPollingInterval_ms ()
	An integer property defining the polling interval in ms the driver waits during each iteration before checking a methods execution state again.
PropertyI	getMethodPollingMaxRetryCount ()
	An integer property defining the polling interval in ms the driver waits during each iteration before checking a methods execution state again.
PropertyI	getMute ()
	If V4L2 device supports audio, this enumerated integer property sets audio mute on/off.
PropertyI	getRequestCount ()
	An integer property defining the number of requests allocated by the driver.
PropertyI	getTreble ()
	If V4L2 device supports audio, this integer property adjusts the audio treble.
PropertyI	getVolume ()
	If V4L2 device supports audio, this integer property adjusts the audio volume.
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.
	SystemV4L2 (Device pDev)
	Constructs a new mvIMPACT.acquire.SystemV4L2 object.

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

Static Protected Member Functions
static long	swigRelease (ComponentCollection obj)
static long	swigRelease (SystemSettings obj)
static long	swigRelease (SystemV4L2 obj)

Protected Attributes
transient boolean	swigCMemOwn

Detailed Description

A class containing mvV4L2 specific settings to control the overall behaviour of the driver(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

SystemV4L2() [1/2]

SystemV4L2 ( long cPtr, boolean cMemoryOwn )

protected

SystemV4L2() [2/2]

SystemV4L2

(

Device

pDev

)

Constructs a new mvIMPACT.acquire.SystemV4L2 object.

Parameters

pDev	[in] A pointer to a mvIMPACT.acquire.Device object obtained from a mvIMPACT.acquire.DeviceManager object.

Member Function Documentation

delete()

synchronized void delete

(

)

Reimplemented from SystemSettings.

finalize()

void finalize ( )

protected

Reimplemented from SystemSettings.

getAcquisitionIdleTimeMax_ms()

PropertyI getAcquisitionIdleTimeMax_ms ( )

inherited

An integer property defining the maximum time in ms the driver waits for new requests being queued until streaming by the device will automatically be stopped.

This property defines the maximum time in milliseconds the driver waits for new mvIMPACT.acquire.Request objects being queued by calling mvIMPACT.acquire.FunctionInterface.imageRequestSingle once the driver will automatically send an acquisition stop command to a streaming device (such as a GigE Vision or USB3 Vision device) when the driver's request queue has run empty (thus the driver has no more buffers to capture data into).

This property will only be taken into account when mvIMPACT.acquire.Device.getAcquisitionStartStopBehaviour() has been set to mvIMPACT.acquire.TAcquisitionStartStopBehaviour.assbDefault.

Note

This property will not be available for every device. Right now only devices operated through the GenTL driver package will support this feature.

Since

2.4.1

getAcquisitionMode()

PropertyI getAcquisitionMode ( )

inherited

An enumerated integer property defining the acquisition mode of the device.

Valid values for this property are defined by the enumeration mvIMPACT.acquire.TAcquisitionMode.

getBalance()

PropertyI getBalance

(

)

If V4L2 device supports audio, this integer property adjusts the audio balance.

This property represents a V4L2-audio-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.

getBass()

PropertyI getBass

(

)

If V4L2 device supports audio, this integer property adjusts the audio bass.

This property represents a V4L2-audio-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.

getFeaturePollingEnable()

PropertyI getFeaturePollingEnable ( )

inherited

An enumerated integer property defining whether features defining a polling time shall be updated automatically or not.

Valid values for this property are defined by the enumeration mvIMPACT.acquire.TBoolean.

See also

mvIMPACT.acquire.SystemSettings.getFeaturePollingInterval_ms()

getFeaturePollingInterval_ms()

PropertyI getFeaturePollingInterval_ms ( )

inherited

An integer property defining the polling interval in ms the driver waits for each iteration before running through update loop again.

Some features define a so called polling time. This is a recommendation by the device/driver stating that this property might change its value without user interaction act a certain rate (e.g. the device temperature could be one example for a feature with such a behaviour). When mvIMPACT.acquire.SystemSettings.getFeaturePollingEnable() is set to mvIMPACT.acquire.TBoolean.bTrue a thread will check every featurePollingInterval_ms if features need to be updated. This will only cause communication with a device for each feature whose polling time has elapsed.

Note

This property will not be available for every device. Right now only devices operated through the GenTL driver package will support this feature.

Since

2.18.3

getGenDCParserEnable()

PropertyI getGenDCParserEnable ( )

inherited

An enumerated integer property which can be used to enable/disable automatic GenICam™ GenDC Container parsing.

When working with a GenICam™ compliant device, that transmits data using the GenDC format this property can be used to switch on/off the automatic parsing of the received containers. The default value of this property will be mvIMPACT.acquire.TBoolean.bTrue, so a GenDC container will be parsed upon reception and will be reported as the individual components like described here. This results in slightly more CPU time being consumed which sometimes might not be desirable since the GenDC Containers shall be processed later by another entity of the application or shall just be written to some storage location for off-line processing at a later moment in time. When this property is set to mvIMPACT.acquire.TBoolean.bFalse the data buffer will reported as a raw GenDC Container. mvIMPACT.acquire.Request.getPayloadType() will return mvIMPACT.acquire.TPayloadType.ptGenDC then and mvIMPACT.acquire.Request.getImagePixelFormat() will be mvIMPACT.acquire.TImageBufferPixelFormat.ibpfRaw then. mvIMPACT.acquire.Request.getImageData() and mvIMPACT.acquire.Request.getImageSize() however can directly be fed into any GenDC capable algorithm.

Note

This property will not be available for every device. Only GenICam™ compliant devices will support this feature. More Information about the GenICam™ GenDC format can be found here: https://www.emva.org/standards-technology/genicam/genicam-downloads/.

Valid values for this property are defined by the enumeration mvIMPACT.acquire.TBoolean.

Since

3.2.0

getImageProcessingMaximumThreadCount()

PropertyI getImageProcessingMaximumThreadCount ( )

inherited

An integer property influencing the number of parallel threads used by the internal image processing pipeline.

This property can be used to control the size of the internal thread pool used for image processing tasks. Using a value higher than the number of physical CPU cores usually has a negative impact on the performance. Use with care!

Note

This property will only be available on some platforms. Always check if this property is available before using it!

See also

mvIMPACT.acquire.SystemSettings.getImageProcessingOptimization()
mvIMPACT.acquire.SystemSettings.getImageProcessingMode()
Multithreading

Since

2.41.0

getImageProcessingMode()

PropertyI getImageProcessingMode ( )

inherited

An enumerated integer property influencing the behaviour of the internal image processing pipeline.

Valid values for this property are defined by the enumeration mvIMPACT.acquire.TImageProcessingMode.

Note

This property will only be available if mvIMPACT.acquire.Device.getUserControlledImageProcessingEnable() has been set to mvIMPACT.acquire.TBoolean.bTrue before the device is opened.

See also

mvIMPACT.acquire.Device.getUserControlledImageProcessingEnable()
mvIMPACT.acquire.Request.hasProcessingBeenSkipped

Since

2.14.0

getImageProcessingOptimization()

PropertyI getImageProcessingOptimization ( )

inherited

An enumerated integer property influencing the behaviour of the internal image processing algorithms.

Valid values for this property are defined by the enumeration mvIMPACT.acquire.TImageProcessingOptimization.

Since

2.12.2

getLoudness()

PropertyI getLoudness

(

)

If V4L2 device supports audio, this enumerated integer property sets audio loudness on/off.

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.

getMethodPollingInterval_ms()

PropertyI getMethodPollingInterval_ms ( )

inherited

An integer property defining the polling interval in ms the driver waits during each iteration before checking a methods execution state again.

When working with a GenICam™ compliant device, GenICam™ method objects need to be checked for their completion status every now and then. This parameter defines how often this shall be done.

Note

This property will not be available for every device. Right now only devices operated through the GenTL driver package will support this feature.

Since

2.18.3

getMethodPollingMaxRetryCount()

PropertyI getMethodPollingMaxRetryCount ( )

inherited

An integer property defining the polling interval in ms the driver waits during each iteration before checking a methods execution state again.

When working with a GenICam™ compliant device, GenICam™ method objects need to be checked for their completion status every now and then. This parameter defines how often this shall be done at all. A method is checked for completion methodPollingMaxRetryCount * methodPollingInterval_ms at max. Until then either the device starts to inform the driver that it needs more time OR the execution of the method has completed successfully or an error will be generated.

Note

This property will not be available for every device. Right now only devices operated through the GenTL driver package will support this feature.

Since

2.18.3

getMute()

PropertyI getMute

(

)

If V4L2 device supports audio, this enumerated integer property sets audio mute on/off.

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.

getRequestCount()

PropertyI getRequestCount ( )

inherited

An integer property defining the number of requests allocated by the driver.

Each request object can be used to capture data into. Multiple requests can be processed by a device driver as background tasks.

Setting this property to a value at least allowing a driver to capture data for up to 500ms without user interaction (thus 0.5 times the expected frame rate) is highly recommended. Increasing this value will NOT introduce additional latency to your application. The only drawback will be additional RAM consumption by the driver but applications that do not need to copy the request buffers can even benefit from that as the overall memory fragmentation is likely to go down then. Values smaller than 3 most likely result in undesired behaviour and should be avoided unless absolutely needed.

Note

For performance reasons this value can be increased at any time(only exception: Working with the interface layout mvIMPACT.acquire.TDeviceInterfaceLayout.dilGenICam while streaming is active) but can only be decreased when no request object is currently locked by the application and no requests has been queued for acquisition. So modifying this value might require the application to call mvIMPACT.acquire.FunctionInterface.imageRequestReset and several calls to mvIMPACT.acquire.Request.unlock before.

There are not too many reasons to modify the default request count suggested by the device driver. Good reasons include:

• a single image is huge compared to the overall system memory(e.g. a single image has 200MB while the system itself only has about 2GB of RAM. Here it might make sense to reduce the number of capture buffers to 1 or 2. Please note that in such a scenario double buffering or live display when one buffer is constantly blocked by the display engine can become a challenge!
• the frame rate is high(larger than 100 frames per second) and no frames shall be lost. Here it might make sense to set the number of capture buffers to something like frame rate divided by 2 to 5 as a rule of thumb.

See also

mvIMPACT.acquire.FunctionInterface.getRequestCount()

getTreble()

PropertyI getTreble

(

)

If V4L2 device supports audio, this integer property adjusts the audio treble.

This property represents a V4L2-audio-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.

getVolume()

PropertyI getVolume

(

)

If V4L2 device supports audio, this integer property adjusts the audio volume.

This property represents a V4L2-audio-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/3]

static long swigRelease ( ComponentCollection obj )

staticprotectedinherited

swigRelease() [2/3]

static long swigRelease ( SystemSettings obj )

staticprotectedinherited

swigRelease() [3/3]

static long swigRelease ( SystemV4L2 obj )

staticprotected

Member Data Documentation

swigCMemOwn

transient boolean swigCMemOwn

protectedinherited