org.bytedeco.depthai

Class CameraControl

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.depthai.ADatatype

org.bytedeco.depthai.Buffer

org.bytedeco.depthai.CameraControl

All Implemented Interfaces:

AutoCloseable

@Namespace(value="dai")
 @NoOffset
 @Properties(inherit=depthai.class)
public class CameraControl
extends Buffer

CameraControl message. Specifies various camera control commands like: - Still capture - Auto/manual focus - Auto/manual white balance - Auto/manual exposure - Anti banding - ... By default the camera enables 3A, with auto-focus in CONTINUOUS_VIDEO mode, auto-white-balance in AUTO mode, and auto-exposure with anti-banding for 50Hz mains frequency.

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
CameraControl() Construct CameraControl message
CameraControl(long size) Native array allocator.
CameraControl(Pointer p) Pointer cast constructor.
CameraControl(RawCameraControl ptr)

Method Summary

Modifier and Type	Method and Description
boolean	getCaptureStill() Check whether command to capture a still is set
Pointer	getExposureTime() Retrieves exposure time
int	getLensPosition() Retrieves lens position, range 0..255.
CameraControl	getPointer(long i)
int	getSensitivity() Retrieves sensitivity, as an ISO value
CameraControl	position(long position)
CameraControl	setAntiBandingMode(byte mode)
CameraControl	setAntiBandingMode(RawCameraControl.AntiBandingMode mode) Set a command to specify anti-banding mode.
CameraControl	setAutoExposureCompensation(int compensation) Set a command to specify auto exposure compensation
CameraControl	setAutoExposureEnable() Set a command to enable auto exposure
CameraControl	setAutoExposureLock(boolean lock) Set a command to specify lock auto exposure
CameraControl	setAutoExposureRegion(short startX, short startY, short width, short height) Set a command to specify auto exposure region in pixels.
CameraControl	setAutoFocusLensRange(int infinityPosition, int macroPosition) Set autofocus lens range, infinityPosition < macroPosition, valid values 0..255.
CameraControl	setAutoFocusMode(byte mode)
CameraControl	setAutoFocusMode(RawCameraControl.AutoFocusMode mode) Set a command to specify autofocus mode.
CameraControl	setAutoFocusRegion(short startX, short startY, short width, short height) Set a command to specify focus region in pixels.
CameraControl	setAutoFocusTrigger() Set a command to trigger autofocus
CameraControl	setAutoWhiteBalanceLock(boolean lock) Set a command to specify auto white balance lock
CameraControl	setAutoWhiteBalanceMode(byte mode)
CameraControl	setAutoWhiteBalanceMode(RawCameraControl.AutoWhiteBalanceMode mode) Set a command to specify auto white balance mode
CameraControl	setBrightness(int value) Set a command to adjust image brightness
CameraControl	setCaptureStill(boolean capture) Set a command to capture a still image
CameraControl	setChromaDenoise(int value) Set a command to adjust chroma denoise amount
CameraControl	setContrast(int value) Set a command to adjust image contrast
CameraControl	setEffectMode(byte mode)
CameraControl	setEffectMode(RawCameraControl.EffectMode mode) Set a command to specify effect mode
CameraControl	setExternalTrigger(int numFramesBurst, int numFramesDiscard) Set a command to enable external trigger snapshot mode A rising edge on the sensor FSIN pin will make it capture a sequence of numFramesBurst frames.
CameraControl	setFrameSyncMode(byte mode)
CameraControl	setFrameSyncMode(RawCameraControl.FrameSyncMode mode) Set the frame sync mode for continuous streaming operation mode, translating to how the camera pin FSIN/FSYNC is used: input/output/disabled
CameraControl	setLumaDenoise(int value) Set a command to adjust luma denoise amount
CameraControl	setManualExposure(int exposureTimeUs, int sensitivityIso) Set a command to manually specify exposure
void	setManualExposure(Pointer exposureTime, int sensitivityIso) Set a command to manually specify exposure
CameraControl	setManualFocus(byte lensPosition) Set a command to specify manual focus position
CameraControl	setManualWhiteBalance(int colorTemperatureK) Set a command to manually specify white-balance color correction
CameraControl	setSaturation(int value) Set a command to adjust image saturation
CameraControl	setSceneMode(byte mode)
CameraControl	setSceneMode(RawCameraControl.SceneMode mode) Set a command to specify scene mode
CameraControl	setSharpness(int value) Set a command to adjust image sharpness
CameraControl	setStartStreaming() Set a command to start streaming
CameraControl	setStopStreaming() Set a command to stop streaming
CameraControl	setStrobeDisable() Disable STROBE output
CameraControl	setStrobeExternal(int gpioNumber)
CameraControl	setStrobeExternal(int gpioNumber, int activeLevel) Enable STROBE output driven by a MyriadX GPIO, optionally configuring the polarity This normally requires a FSIN/FSYNC/trigger input for MyriadX (usually GPIO 41), to generate timings
CameraControl	setStrobeSensor()
CameraControl	setStrobeSensor(int activeLevel) Enable STROBE output on sensor pin, optionally configuring the polarity.

Methods inherited from class org.bytedeco.depthai.Buffer

getData, setData, setData, setData

Methods inherited from class org.bytedeco.depthai.ADatatype

getRaw, serialize

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, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, 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

CameraControl

public CameraControl(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

CameraControl

public CameraControl(long size)

Native array allocator. Access with Pointer.position(long).

CameraControl

public CameraControl()

Construct CameraControl message

CameraControl

public CameraControl(@SharedPtr
                     RawCameraControl ptr)

Method Detail

position

public CameraControl position(long position)

Overrides:

position in class Buffer

getPointer

public CameraControl getPointer(long i)

Overrides:

getPointer in class Buffer

setCaptureStill

@ByRef
public CameraControl setCaptureStill(@Cast(value="bool")
                                            boolean capture)

Set a command to capture a still image

setStartStreaming

@ByRef
public CameraControl setStartStreaming()

Set a command to start streaming

setStopStreaming

@ByRef
public CameraControl setStopStreaming()

Set a command to stop streaming

setExternalTrigger

@ByRef
public CameraControl setExternalTrigger(int numFramesBurst,
                                               int numFramesDiscard)

Set a command to enable external trigger snapshot mode A rising edge on the sensor FSIN pin will make it capture a sequence of numFramesBurst frames. First numFramesDiscard will be skipped as configured (can be set to 0 as well), as they may have degraded quality

setFrameSyncMode

@ByRef
public CameraControl setFrameSyncMode(RawCameraControl.FrameSyncMode mode)

Set the frame sync mode for continuous streaming operation mode, translating to how the camera pin FSIN/FSYNC is used: input/output/disabled

setFrameSyncMode

@ByRef
public CameraControl setFrameSyncMode(@Cast(value="dai::RawCameraControl::FrameSyncMode")
                                             byte mode)

setStrobeSensor

@ByRef
public CameraControl setStrobeSensor(int activeLevel)

Enable STROBE output on sensor pin, optionally configuring the polarity. Note: for many sensors the polarity is high-active and not configurable

setStrobeSensor

@ByRef
public CameraControl setStrobeSensor()

setStrobeExternal

@ByRef
public CameraControl setStrobeExternal(int gpioNumber,
                                              int activeLevel)

Enable STROBE output driven by a MyriadX GPIO, optionally configuring the polarity This normally requires a FSIN/FSYNC/trigger input for MyriadX (usually GPIO 41), to generate timings

setStrobeExternal

@ByRef
public CameraControl setStrobeExternal(int gpioNumber)

setStrobeDisable

@ByRef
public CameraControl setStrobeDisable()

Disable STROBE output

setAutoFocusMode

@ByRef
public CameraControl setAutoFocusMode(RawCameraControl.AutoFocusMode mode)

Set a command to specify autofocus mode. Default CONTINUOUS_VIDEO

setAutoFocusMode

@ByRef
public CameraControl setAutoFocusMode(@Cast(value="dai::RawCameraControl::AutoFocusMode")
                                             byte mode)

setAutoFocusTrigger

@ByRef
public CameraControl setAutoFocusTrigger()

Set a command to trigger autofocus

setAutoFocusLensRange

@ByRef
public CameraControl setAutoFocusLensRange(int infinityPosition,
                                                  int macroPosition)

Set autofocus lens range, infinityPosition < macroPosition, valid values 0..255. May help to improve autofocus in case the lens adjustment is not typical/tuned

setAutoFocusRegion

@ByRef
public CameraControl setAutoFocusRegion(@Cast(value="uint16_t")
                                               short startX,
                                               @Cast(value="uint16_t")
                                               short startY,
                                               @Cast(value="uint16_t")
                                               short width,
                                               @Cast(value="uint16_t")
                                               short height)

Set a command to specify focus region in pixels. Note: the region should be mapped to the configured sensor resolution, before ISP scaling

Parameters:

startX - X coordinate of top left corner of region

startY - Y coordinate of top left corner of region

width - Region width

height - Region height

setManualFocus

@ByRef
public CameraControl setManualFocus(@Cast(value="uint8_t")
                                           byte lensPosition)

Set a command to specify manual focus position

Parameters:

lensPosition - specify lens position 0..255

setAutoExposureEnable

@ByRef
public CameraControl setAutoExposureEnable()

Set a command to enable auto exposure

setAutoExposureLock

@ByRef
public CameraControl setAutoExposureLock(@Cast(value="bool")
                                                boolean lock)

Set a command to specify lock auto exposure

Parameters:

lock - Auto exposure lock mode enabled or disabled

setAutoExposureRegion

@ByRef
public CameraControl setAutoExposureRegion(@Cast(value="uint16_t")
                                                  short startX,
                                                  @Cast(value="uint16_t")
                                                  short startY,
                                                  @Cast(value="uint16_t")
                                                  short width,
                                                  @Cast(value="uint16_t")
                                                  short height)

Set a command to specify auto exposure region in pixels. Note: the region should be mapped to the configured sensor resolution, before ISP scaling

Parameters:

startX - X coordinate of top left corner of region

startY - Y coordinate of top left corner of region

width - Region width

height - Region height

setAutoExposureCompensation

@ByRef
public CameraControl setAutoExposureCompensation(int compensation)

Set a command to specify auto exposure compensation

Parameters:

compensation - Compensation value between -9..9, default 0

setAntiBandingMode

@ByRef
public CameraControl setAntiBandingMode(RawCameraControl.AntiBandingMode mode)

Set a command to specify anti-banding mode. Anti-banding / anti-flicker works in auto-exposure mode, by controlling the exposure time to be applied in multiples of half the mains period, for example in multiple of 10ms for 50Hz (period 20ms) AC-powered illumination sources. If the scene would be too bright for the smallest exposure step (10ms in the example, with ISO at a minimum of 100), anti-banding is not effective.

Parameters:

mode - Anti-banding mode to use. Default: MAINS_50_HZ

setAntiBandingMode

@ByRef
public CameraControl setAntiBandingMode(@Cast(value="dai::RawCameraControl::AntiBandingMode")
                                               byte mode)

setManualExposure

@ByRef
public CameraControl setManualExposure(@Cast(value="uint32_t")
                                              int exposureTimeUs,
                                              @Cast(value="uint32_t")
                                              int sensitivityIso)

Set a command to manually specify exposure

Parameters:

exposureTimeUs - Exposure time in microseconds

sensitivityIso - Sensitivity as ISO value, usual range 100..1600

setManualExposure

public void setManualExposure(@ByVal @Cast(value="std::chrono::microseconds*")
                              Pointer exposureTime,
                              @Cast(value="uint32_t")
                              int sensitivityIso)

Set a command to manually specify exposure

Parameters:

exposureTime - Exposure time

sensitivityIso - Sensitivity as ISO value, usual range 100..1600

setAutoWhiteBalanceMode

@ByRef
public CameraControl setAutoWhiteBalanceMode(RawCameraControl.AutoWhiteBalanceMode mode)

Set a command to specify auto white balance mode

Parameters:

mode - Auto white balance mode to use. Default AUTO

setAutoWhiteBalanceMode

@ByRef
public CameraControl setAutoWhiteBalanceMode(@Cast(value="dai::RawCameraControl::AutoWhiteBalanceMode")
                                                    byte mode)

setAutoWhiteBalanceLock

@ByRef
public CameraControl setAutoWhiteBalanceLock(@Cast(value="bool")
                                                    boolean lock)

Set a command to specify auto white balance lock

Parameters:

lock - Auto white balance lock mode enabled or disabled

setManualWhiteBalance

@ByRef
public CameraControl setManualWhiteBalance(int colorTemperatureK)

Set a command to manually specify white-balance color correction

Parameters:

colorTemperatureK - Light source color temperature in kelvins, range 1000..12000

setBrightness

@ByRef
public CameraControl setBrightness(int value)

Set a command to adjust image brightness

Parameters:

value - Brightness, range -10..10, default 0

setContrast

@ByRef
public CameraControl setContrast(int value)

Set a command to adjust image contrast

Parameters:

value - Contrast, range -10..10, default 0

setSaturation

@ByRef
public CameraControl setSaturation(int value)

Set a command to adjust image saturation

Parameters:

value - Saturation, range -10..10, default 0

setSharpness

@ByRef
public CameraControl setSharpness(int value)

Set a command to adjust image sharpness

Parameters:

value - Sharpness, range 0..4, default 1

setLumaDenoise

@ByRef
public CameraControl setLumaDenoise(int value)

Set a command to adjust luma denoise amount

Parameters:

value - Luma denoise amount, range 0..4, default 1

setChromaDenoise

@ByRef
public CameraControl setChromaDenoise(int value)

Set a command to adjust chroma denoise amount

Parameters:

value - Chroma denoise amount, range 0..4, default 1

setSceneMode

@ByRef
public CameraControl setSceneMode(RawCameraControl.SceneMode mode)

Set a command to specify scene mode

Parameters:

mode - Scene mode

setSceneMode

@ByRef
public CameraControl setSceneMode(@Cast(value="dai::RawCameraControl::SceneMode")
                                         byte mode)

setEffectMode

@ByRef
public CameraControl setEffectMode(RawCameraControl.EffectMode mode)

Set a command to specify effect mode

Parameters:

mode - Effect mode

setEffectMode

@ByRef
public CameraControl setEffectMode(@Cast(value="dai::RawCameraControl::EffectMode")
                                          byte mode)

getCaptureStill

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

Check whether command to capture a still is set

Returns:

True if capture still command is set

getExposureTime

@ByVal
 @Cast(value="std::chrono::microseconds*")
public Pointer getExposureTime()

Retrieves exposure time

getSensitivity

public int getSensitivity()

Retrieves sensitivity, as an ISO value

getLensPosition

public int getLensPosition()

Retrieves lens position, range 0..255. Returns -1 if not available